Add codemod to transform literals to wildcards

docs/pages/repo/docs/reference/codemods.mdx

@@ -29,6 +29,7 @@ npx @turbo/codemod <transform> <path>
 3. [migrate-env-var-dependencies](#migrate-env-var-dependencies)
 4. [set-default-outputs](#set-default-outputs)
 5. [stabilize-env-mode](#stabilize-env-mode)
+6. [transform-env-literals-to-wildcards](#transform-env-literals-to-wildcards)
 
 ### `add-package-manager`
 
@@ -327,3 +328,57 @@ Run the codemod:
 ```sh
 npx @turbo/codemod stabilize-env-mode
 ```
+
+### `transform-env-literals-to-wildcards`
+
+<Callout type="info">
+  Introduced in v1.10.0
+</Callout>
+
+Updates any existing env var fields whose contents would be ambiguous to the new wildcard syntax.
+
+For example:
+
+```json
+// Before, turbo.json
+{
+  "$schema": "https://turbo.build/schema.json",
+  "globalEnv": ["THIS_*_IS_LITERAL"],
+  "globalPassThroughEnv": ["!LITERAL_LEADING_EXCLAMATION"],
+  "pipeline": {
+    "build": {
+      "env": ["50_PERCENT_OFF*_HAS_SMALL_PRINT"],
+      "passThroughEnv": ["**BOLDED**"],
+    }
+  }
+}
+```
+
+```diff
+// After, turbo.json
+{
+  "$schema": "https://turbo.build/schema.json",
+  "globalEnv": ["THIS_\\*_IS_LITERAL"],
+  "globalPassThroughEnv": ["\\!LITERAL_LEADING_EXCLAMATION"],
+  "pipeline": {
+    "build": {
+      "env": ["50_PERCENT_OFF\\*_HAS_SMALL_PRINT"],
+      "passThroughEnv": ["\\*\\*BOLDED\\*\\*"],
+    }
+  }
+}
+```
+
+#### Usage
+
+Go to your project:
+
+```sh
+cd path-to-your-turborepo/
+```
+
+Run the codemod:
+
+```sh
+npx @turbo/codemod transform-env-literals-to-wildcards
+```

packages/turbo-codemod/__tests__/__fixtures__/transform-env-literals-to-wildcards/has-empty/turbo.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "globalEnv": [],
+  "globalPassThroughEnv": [],
+  "pipeline": {
+    "build": {
+      "env": [],
+      "passThroughEnv": []
+    }
+  }
+}

packages/turbo-codemod/__tests__/__fixtures__/transform-env-literals-to-wildcards/has-nothing/turbo.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "pipeline": {
+    "build": {}
+  }
+}

packages/turbo-codemod/__tests__/__fixtures__/transform-env-literals-to-wildcards/needs-rewriting/turbo.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "globalEnv": ["NO!", "!!!", "!!!"],
+  "globalPassThroughEnv": ["DOES", "**BOLD**", "WORK"],
+  "pipeline": {
+    "build": {
+      "env": ["PLAIN", "SMALL_PRINT*"],
+      "passThroughEnv": ["PASSWORD", "*****"]
+    }
+  }
+}

packages/turbo-codemod/__tests__/__fixtures__/transform-env-literals-to-wildcards/no-turbo-json/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "transform-env-literals-to-wildcards-no-turbo-json",
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {},
+  "packageManager": "npm@1.2.3"
+}

packages/turbo-codemod/__tests__/__fixtures__/transform-env-literals-to-wildcards/old-config/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "transform-env-literals-to-wildcards-old-config",
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {},
+  "packageManager": "npm@1.2.3",
+  "turbo": {}
+}

packages/turbo-codemod/__tests__/__fixtures__/transform-env-literals-to-wildcards/workspace-configs/apps/docs/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "transform-env-literals-to-wildcards-docs"
+}

packages/turbo-codemod/__tests__/__fixtures__/transform-env-literals-to-wildcards/workspace-configs/apps/docs/turbo.json

@@ -0,0 +1,9 @@
+{
+  "extends": ["//"],
+  "pipeline": {
+    "build": {
+      "env": ["NO_DOCS_ENV", "!*!*DOCS"],
+      "passThroughEnv": ["NO_DOCS_PASSTHROUGH_ENV", "!*!*DOCS"]
+    }
+  }
+}

packages/turbo-codemod/__tests__/__fixtures__/transform-env-literals-to-wildcards/workspace-configs/apps/website/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "transform-env-literals-to-wildcards-website"
+}

packages/turbo-codemod/__tests__/__fixtures__/transform-env-literals-to-wildcards/workspace-configs/apps/website/turbo.json

@@ -0,0 +1,9 @@
+{
+  "extends": ["//"],
+  "pipeline": {
+    "build": {
+      "env": ["NO_WEBSITE_ENV", "!*!*WEBSITE"],
+      "passThroughEnv": ["NO_WEBSITE_PASSTHROUGH_ENV", "!*!*WEBSITE"]
+    }
+  }
+}

packages/turbo-codemod/__tests__/__fixtures__/transform-env-literals-to-wildcards/workspace-configs/package.json

@@ -0,0 +1,7 @@
+{
+  "private": true,
+  "workspaces": [
+    "apps/*"
+  ],
+  "packageManager": "yarn@1.22.19"
+}

packages/turbo-codemod/__tests__/__fixtures__/transform-env-literals-to-wildcards/workspace-configs/turbo.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "globalEnv": ["!*!*"],
+  "globalPassThroughEnv": ["!*!*"],
+  "pipeline": {
+    "build": {
+      "env": ["NO_ROOT_ENV", "!*!*ROOT"],
+      "passThroughEnv": ["NO_ROOT_PASSTHROUGH_ENV", "!*!*ROOT"]
+    }
+  }
+}

packages/turbo-codemod/__tests__/get-transforms-for-migration.test.ts

@@ -0,0 +1,19 @@
+import getCodemodsForMigration from "../src/commands/migrate/steps/getTransformsForMigration";
+
+describe("get-transforms-for-migration", () => {
+  test("ordering", () => {
+    let results = getCodemodsForMigration({
+      fromVersion: "1.0.0",
+      toVersion: "1.10.0",
+    });
+
+    expect(results.map((transform) => transform.value)).toEqual([
+      "add-package-manager",
+      "create-turbo-config",
+      "migrate-env-var-dependencies",
+      "set-default-outputs",
+      "stabilize-env-mode",
+      "transform-env-literals-to-wildcards",
+    ]);
+  });
+});

packages/turbo-codemod/__tests__/transform-env-literals-to-wildcards.test.ts

@@ -0,0 +1,217 @@
+import { transformer } from "../src/transforms/transform-env-literals-to-wildcards";
+import { setupTestFixtures } from "@turbo/test-utils";
+
+describe.only("transform-env-literals-to-wildcards", () => {
+  const { useFixture } = setupTestFixtures({
+    directory: __dirname,
+    test: "transform-env-literals-to-wildcards",
+  });
+
+  it("migrates wildcards has-empty", async () => {
+    // load the fixture for the test
+    const { root, read } = useFixture({
+      fixture: "has-empty",
+    });
+
+    // run the transformer
+    const result = transformer({
+      root,
+      options: { force: false, dry: false, print: false },
+    });
+
+    expect(JSON.parse(read("turbo.json") || "{}")).toStrictEqual({
+      $schema: "https://turbo.build/schema.json",
+      globalEnv: [],
+      globalPassThroughEnv: [],
+      pipeline: {
+        build: {
+          env: [],
+          passThroughEnv: [],
+        },
+      },
+    });
+
+    expect(result.fatalError).toBeUndefined();
+    expect(result.changes).toMatchInlineSnapshot(`
+      Object {
+        "turbo.json": Object {
+          "action": "unchanged",
+          "additions": 0,
+          "deletions": 0,
+        },
+      }
+    `);
+  });
+
+  it("migrates env-mode has-nothing", async () => {
+    // load the fixture for the test
+    const { root, read } = useFixture({
+      fixture: "has-nothing",
+    });
+
+    // run the transformer
+    const result = transformer({
+      root,
+      options: { force: false, dry: false, print: false },
+    });
+
+    expect(JSON.parse(read("turbo.json") || "{}")).toStrictEqual({
+      $schema: "https://turbo.build/schema.json",
+      pipeline: {
+        build: {},
+      },
+    });
+
+    expect(result.fatalError).toBeUndefined();
+    expect(result.changes).toMatchInlineSnapshot(`
+      Object {
+        "turbo.json": Object {
+          "action": "unchanged",
+          "additions": 0,
+          "deletions": 0,
+        },
+      }
+    `);
+  });
+
+  it("migrates env-mode needs-rewriting", async () => {
+    // load the fixture for the test
+    const { root, read } = useFixture({
+      fixture: "needs-rewriting",
+    });
+
+    // run the transformer
+    const result = transformer({
+      root,
+      options: { force: false, dry: false, print: false },
+    });
+
+    expect(JSON.parse(read("turbo.json") || "{}")).toStrictEqual({
+      $schema: "https://turbo.build/schema.json",
+      globalEnv: ["NO!", "\\!!!", "\\!!!"],
+      globalPassThroughEnv: ["DOES", "\\*\\*BOLD\\*\\*", "WORK"],
+      pipeline: {
+        build: {
+          env: ["PLAIN", "SMALL_PRINT\\*"],
+          passThroughEnv: ["PASSWORD", "\\*\\*\\*\\*\\*"],
+        },
+      },
+    });
+
+    expect(result.fatalError).toBeUndefined();
+    expect(result.changes).toMatchInlineSnapshot(`
+      Object {
+        "turbo.json": Object {
+          "action": "modified",
+          "additions": 4,
+          "deletions": 4,
+        },
+      }
+    `);
+  });
+
+  it("migrates env-mode workspace-configs", async () => {
+    // load the fixture for the test
+    const { root, read } = useFixture({
+      fixture: "workspace-configs",
+    });
+
+    // run the transformer
+    const result = transformer({
+      root,
+      options: { force: false, dry: false, print: false },
+    });
+
+    expect(JSON.parse(read("turbo.json") || "{}")).toStrictEqual({
+      $schema: "https://turbo.build/schema.json",
+      globalEnv: ["\\!\\*!\\*"],
+      globalPassThroughEnv: ["\\!\\*!\\*"],
+      pipeline: {
+        build: {
+          env: ["NO_ROOT_ENV", "\\!\\*!\\*ROOT"],
+          passThroughEnv: ["NO_ROOT_PASSTHROUGH_ENV", "\\!\\*!\\*ROOT"],
+        },
+      },
+    });
+
+    expect(JSON.parse(read("apps/docs/turbo.json") || "{}")).toStrictEqual({
+      extends: ["//"],
+      pipeline: {
+        build: {
+          env: ["NO_DOCS_ENV", "\\!\\*!\\*DOCS"],
+          passThroughEnv: ["NO_DOCS_PASSTHROUGH_ENV", "\\!\\*!\\*DOCS"],
+        },
+      },
+    });
+
+    expect(JSON.parse(read("apps/website/turbo.json") || "{}")).toStrictEqual({
+      extends: ["//"],
+      pipeline: {
+        build: {
+          env: ["NO_WEBSITE_ENV", "\\!\\*!\\*WEBSITE"],
+          passThroughEnv: ["NO_WEBSITE_PASSTHROUGH_ENV", "\\!\\*!\\*WEBSITE"],
+        },
+      },
+    });
+
+    expect(result.fatalError).toBeUndefined();
+    expect(result.changes).toMatchInlineSnapshot(`
+      Object {
+        "apps/docs/turbo.json": Object {
+          "action": "modified",
+          "additions": 2,
+          "deletions": 2,
+        },
+        "apps/website/turbo.json": Object {
+          "action": "modified",
+          "additions": 2,
+          "deletions": 2,
+        },
+        "turbo.json": Object {
+          "action": "modified",
+          "additions": 4,
+          "deletions": 4,
+        },
+      }
+    `);
+  });
+
+  it("errors if no turbo.json can be found", async () => {
+    // load the fixture for the test
+    const { root, read } = useFixture({
+      fixture: "no-turbo-json",
+    });
+
+    expect(read("turbo.json")).toBeUndefined();
+
+    // run the transformer
+    const result = transformer({
+      root,
+      options: { force: false, dry: false, print: false },
+    });
+
+    expect(read("turbo.json")).toBeUndefined();
+    expect(result.fatalError).toBeDefined();
+    expect(result.fatalError?.message).toMatch(
+      /No turbo\.json found at .*?\. Is the path correct\?/
+    );
+  });
+
+  it("errors if package.json config exists and has not been migrated", async () => {
+    // load the fixture for the test
+    const { root } = useFixture({
+      fixture: "old-config",
+    });
+
+    // run the transformer
+    const result = transformer({
+      root,
+      options: { force: false, dry: false, print: false },
+    });
+
+    expect(result.fatalError).toBeDefined();
+    expect(result.fatalError?.message).toMatch(
+      'turbo" key detected in package.json. Run `npx @turbo/codemod transform create-turbo-config` first'
+    );
+  });
+});