feat(codemod): add missing package names (#8186)

### Description

Codemod to add missing name (or fix duplicates)

packages/turbo-codemod/__tests__/__fixtures__/add-package-names/correct-names/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "root",
+  "workspaces": [
+    "packages/*"
+  ],
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {},
+  "packageManager": "npm@1.2.3"
+}

packages/turbo-codemod/__tests__/__fixtures__/add-package-names/correct-names/packages/ui/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "ui",
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {}
+}

packages/turbo-codemod/__tests__/__fixtures__/add-package-names/correct-names/packages/utils/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "utils",
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {}
+}

packages/turbo-codemod/__tests__/__fixtures__/add-package-names/duplicate-names/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "root",
+  "workspaces": [
+    "packages/*"
+  ],
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {},
+  "packageManager": "npm@1.2.3"
+}

packages/turbo-codemod/__tests__/__fixtures__/add-package-names/duplicate-names/packages/apps/docs/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@acme/docs",
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {}
+}

packages/turbo-codemod/__tests__/__fixtures__/add-package-names/duplicate-names/packages/apps/web/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@acme/docs",
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {}
+}

packages/turbo-codemod/__tests__/__fixtures__/add-package-names/duplicate-names/packages/ui/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "some-pkg",
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {}
+}

packages/turbo-codemod/__tests__/__fixtures__/add-package-names/duplicate-names/packages/utils/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "some-pkg",
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {}
+}

packages/turbo-codemod/__tests__/__fixtures__/add-package-names/missing-names/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "root",
+  "workspaces": [
+    "packages/*"
+  ],
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {},
+  "packageManager": "npm@1.2.3"
+}

packages/turbo-codemod/__tests__/__fixtures__/add-package-names/missing-names/packages/ui/package.json

@@ -0,0 +1,5 @@
+{
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {}
+}

packages/turbo-codemod/__tests__/__fixtures__/add-package-names/missing-names/packages/utils/package.json

@@ -0,0 +1,5 @@
+{
+  "version": "1.0.0",
+  "dependencies": {},
+  "devDependencies": {}
+}

packages/turbo-codemod/__tests__/add-package-names.test.ts

@@ -0,0 +1,117 @@
+import { setupTestFixtures } from "@turbo/test-utils";
+import { transformer } from "../src/transforms/add-package-names";
+
+describe("add-package-names", () => {
+  const { useFixture } = setupTestFixtures({
+    directory: __dirname,
+    test: "add-package-names",
+  });
+
+  test("missing names", async () => {
+    // load the fixture for the test
+    const { root, readJson } = useFixture({
+      fixture: "missing-names",
+    });
+
+    // run the transformer
+    const result = await transformer({
+      root,
+      options: { force: false, dry: false, print: false },
+    });
+
+    // result should be correct
+    expect(result.fatalError).toBeUndefined();
+    expect(result.changes).toMatchInlineSnapshot(`
+      Object {
+        "packages/ui/package.json": Object {
+          "action": "modified",
+          "additions": 1,
+          "deletions": 0,
+        },
+        "packages/utils/package.json": Object {
+          "action": "modified",
+          "additions": 1,
+          "deletions": 0,
+        },
+      }
+    `);
+
+    // validate unique names
+    const names = new Set();
+
+    for (const pkg of ["ui", "utils"]) {
+      const pkgJson = readJson<{ name: string }>(
+        `packages/${pkg}/package.json`
+      );
+      expect(pkgJson?.name).toBeDefined();
+      expect(names.has(pkgJson?.name)).toBe(false);
+      names.add(pkgJson?.name);
+    }
+  });
+
+  test("duplicate names", async () => {
+    // load the fixture for the test
+    const { root, readJson } = useFixture({
+      fixture: "duplicate-names",
+    });
+
+    // run the transformer
+    const result = await transformer({
+      root,
+      options: { force: false, dry: false, print: false },
+    });
+
+    // result should be correct
+    expect(result.fatalError).toBeUndefined();
+    expect(result.changes).toMatchInlineSnapshot(`
+      Object {
+        "packages/utils/package.json": Object {
+          "action": "modified",
+          "additions": 1,
+          "deletions": 1,
+        },
+      }
+    `);
+
+    // validate unique names
+    const names = new Set();
+
+    for (const pkg of ["ui", "utils"]) {
+      const pkgJson = readJson<{ name: string }>(
+        `packages/${pkg}/package.json`
+      );
+      expect(pkgJson?.name).toBeDefined();
+      expect(names.has(pkgJson?.name)).toBe(false);
+      names.add(pkgJson?.name);
+    }
+  });
+
+  test("correct names", async () => {
+    // load the fixture for the test
+    const { root, readJson } = useFixture({
+      fixture: "correct-names",
+    });
+
+    // run the transformer
+    const result = await transformer({
+      root,
+      options: { force: false, dry: false, print: false },
+    });
+
+    // result should be correct
+    expect(result.fatalError).toBeUndefined();
+    expect(result.changes).toMatchInlineSnapshot(`Object {}`);
+
+    // validate unique names
+    const names = new Set();
+
+    for (const pkg of ["ui", "utils"]) {
+      const pkgJson = readJson<{ name: string }>(
+        `packages/${pkg}/package.json`
+      );
+      expect(pkgJson?.name).toBeDefined();
+      expect(names.has(pkgJson?.name)).toBe(false);
+      names.add(pkgJson?.name);
+    }
+  });
+});

packages/turbo-codemod/__tests__/generate-package-name.test.ts

@@ -0,0 +1,29 @@
+import { getNewPkgName } from "../src/transforms/add-package-names";
+
+describe("getNewPkgName", () => {
+  it.each([
+    {
+      pkgPath: "/packages/ui/package.json",
+      pkgName: "old-name",
+      expected: "ui-old-name",
+    },
+    // scoped
+    {
+      pkgPath: "/packages/ui/package.json",
+      pkgName: "@acme/name",
+      expected: "@acme/ui-name",
+    },
+    // no name
+    {
+      pkgPath: "/packages/ui/package.json",
+      pkgName: undefined,
+      expected: "ui",
+    },
+  ])(
+    "should return a new package name for pkgPath: $pkgPath and pkgName: $pkgName",
+    ({ pkgPath, pkgName, expected }) => {
+      const newName = getNewPkgName({ pkgPath, pkgName });
+      expect(newName).toBe(expected);
+    }
+  );
+});

packages/turbo-codemod/src/cli.ts

@@ -36,7 +36,11 @@ codemodCli
     "Bypass Git safety checks and forcibly run codemods",
     false
   )
-  .option("--dry", "Dry run (no changes are made to files)", false)
+  .option(
+    "--dry, --dry-run, -d",
+    "Dry run (no changes are made to files)",
+    false
+  )
   .option("--print", "Print transformed files to your terminal", false)
   .action(migrate);
 
@@ -52,7 +56,11 @@ codemodCli
     false
   )
   .option("--list", "List all available transforms", false)
-  .option("--dry", "Dry run (no changes are made to files)", false)
+  .option(
+    "--dry, --dry-run, -d",
+    "Dry run (no changes are made to files)",
+    false
+  )
   .option("--print", "Print transformed files to your terminal", false)
   .action(transform);
 

packages/turbo-codemod/src/transforms/add-package-manager.ts

@@ -4,7 +4,7 @@ import { getWorkspaceDetails, type Project } from "@turbo/workspaces";
 import { type PackageJson, getAvailablePackageManagers } from "@turbo/utils";
 import { getTransformerHelpers } from "../utils/getTransformerHelpers";
 import type { TransformerResults } from "../runner";
-import type { TransformerArgs } from "../types";
+import type { Transformer, TransformerArgs } from "../types";
 
 // transformer details
 const TRANSFORMER = "add-package-manager";
@@ -66,7 +66,7 @@ export async function transformer({
   return runner.finish();
 }
 
-const transformerMeta = {
+const transformerMeta: Transformer = {
   name: TRANSFORMER,
   description: DESCRIPTION,
   introducedIn: INTRODUCED_IN,