Updated blueprints (#144)

* chore: Renamed script * chore: Updated blueprints * chore: Updated blueprints * chore: Updated latestVersions * chore: Updated fixtures * chore: Added changeset --------- Co-authored-by: ijlee2 <[email protected]>
ijlee2 · Jan 15, 2025 · 8c47a2e · 8c47a2e
1 parent fdb57d2
commit 8c47a2e
Show file tree

Hide file tree

Showing 25 changed files with 214 additions and 155 deletions.
diff --git a/.changeset/small-shoes-beg.md b/.changeset/small-shoes-beg.md
@@ -0,0 +1,5 @@
+---
+"@codemod-utils/cli": minor
+---
+
+Updated blueprints
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -87,26 +87,28 @@ Here are some guidelines to help you and everyone else.
 
 <summary>Publish packages (for admins)</summary>
 
-1. Generate a [personal access token](https://github.com/settings/tokens/) in GitHub, with `repo` and `read:user` scopes enabled.
+1. Generate a [personal access token](https://github.com/settings/tokens/) in GitHub, with `repo` and `read:user` scopes enabled. This token will be used to retrieve pull request information.
 
-1. Run the `release:changelog` script. This removes changesets, updates the package versions, and updates the `CHANGELOG`'s.
+1. Run the `release:prepare` script. This removes changesets, updates package versions, and updates `CHANGELOG`s.
 
     ```sh
     # From the workspace root
-    GITHUB_TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN> pnpm release:changelog
+    GITHUB_TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN> pnpm release:prepare
     ```
 
-    The `release:changelog` script also updated the workspace root's version (by following the highest version formula). We will use it to name the tag that will be published.
+    Note, `release:prepare` also updated the workspace root's version (e.g. from `0.1.1` to `0.1.2`). We will use it to name the tag that will be published.
 
-    ```
-    # Highest version formula
-    workspace root version = max(
-      max(all package versions),
-      workspace root version + 0.0.1,
-    );
+1. Review the file changes. Commit them in a branch, then open a pull request to merge the changes to the `main` branch.
+
+    ```sh
+    # From the workspace root
+    git checkout -b tag-0.1.2
+    git add .
+    git commit -m "Tagged 0.1.2"
+    git push origin tag-0.1.2
     ```
 
-1. [Create a tag](https://github.com/ijlee2/codemod-utils/releases/new) and provide release notes. The tag name should match the workspace root's version.
+1. [Create a tag](https://github.com/ijlee2/codemod-utils/releases/new) and provide release notes. The tag name should match the workspace root's version (e.g. `0.1.2`).
 
 1. Publish the packages.
 

diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
     "lint": "pnpm --filter \"*\" lint",
     "lint:fix": "pnpm --filter \"*\" lint:fix",
     "prepare": "pnpm build",
-    "release:changelog": "changeset version; update-workspace-root-version",
+    "release:prepare": "changeset version; update-workspace-root-version",
     "release:publish": "pnpm build && changeset publish",
     "test": "pnpm --filter \"*\" test"
   },

diff --git a/packages/cli/src/blueprints/.github/workflows/ci.yml b/packages/cli/src/blueprints/.github/workflows/ci.yml
@@ -8,7 +8,6 @@ on:
 
 env:
   NODE_VERSION: 18
-  PNPM_VERSION: 9
 
 jobs:
   lint:
@@ -21,8 +20,6 @@ jobs:
 
       - name: Set up pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: ${{ env.PNPM_VERSION }}
 
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4
@@ -47,8 +44,6 @@ jobs:
 
       - name: Set up pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: ${{ env.PNPM_VERSION }}
 
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4

diff --git a/packages/cli/src/blueprints/CONTRIBUTING.md b/packages/cli/src/blueprints/CONTRIBUTING.md
@@ -83,15 +83,28 @@ Here are some guidelines to help you and everyone else.
 
 <summary>Publish package (for admins)</summary>
 
-1. Generate a [personal access token](https://github.com/settings/tokens/) in GitHub, with `repo` and `read:user` scopes enabled.
+1. Generate a [personal access token](https://github.com/settings/tokens/) in GitHub, with `repo` and `read:user` scopes enabled. This token will be used to retrieve pull request information.
 
-1. Run the `release:changelog` script. This removes changesets, updates the package version, and updates the `CHANGELOG`.
+1. Run the `release:prepare` script. This removes changesets, updates package versions, and updates `CHANGELOG`s.
 
     ```sh
-    GITHUB_TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN> pnpm release:changelog
+    # From the workspace root
+    GITHUB_TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN> pnpm release:prepare
     ```
 
-1. [Create a tag](https://github.com/<your-github-handle>/<%= options.codemod.name %>/releases/new) and provide release notes. The tag name should match the package version.
+    Note, `release:prepare` also updated the workspace root's version (e.g. from `0.1.1` to `0.1.2`). We will use it to name the tag that will be published.
+
+1. Review the file changes. Commit them in a branch, then open a pull request to merge the changes to the `main` branch.
+
+    ```sh
+    # From the workspace root
+    git checkout -b tag-0.1.2
+    git add .
+    git commit -m "Tagged 0.1.2"
+    git push origin tag-0.1.2
+    ```
+
+1. [Create a tag](https://github.com/<your-github-handle>/<%= options.codemod.name %>/releases/new) and provide release notes. The tag name should match the workspace root's version (e.g. `0.1.2`).
 
 1. Publish the package.
 

diff --git a/packages/cli/src/blueprints/LICENSE.md b/packages/cli/src/blueprints/LICENSE.md
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024
+Copyright (c) 2025
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/packages/cli/src/blueprints/package.json b/packages/cli/src/blueprints/package.json
@@ -22,13 +22,13 @@
   ],
   "scripts": {
     "build": "./build.sh --production",
-    "lint": "concurrently 'pnpm:lint:*(!fix)' --names 'lint:'",
-    "lint:fix": "concurrently 'pnpm:lint:*:fix' --names 'fix:'",
+    "lint": "concurrently \"pnpm:lint:*(!fix)\" --names \"lint:\"",
+    "lint:fix": "concurrently \"pnpm:lint:*:fix\" --names \"fix:\"",
     "lint:js": "eslint . --cache",
     "lint:js:fix": "eslint . --fix",
     "lint:types": "tsc --noEmit",
     "prepare": "pnpm build",
-    "release:changelog": "changeset version",
+    "release:prepare": "changeset version",
     "release:publish": "pnpm build && changeset publish",
     "test": "./build.sh --test && mt dist-for-testing --quiet"
   },
@@ -61,11 +61,11 @@
     "src"
   ],
   "scripts": {
-    "lint": "concurrently 'pnpm:lint:*(!fix)' --names 'lint:'",
-    "lint:fix": "concurrently 'pnpm:lint:*:fix' --names 'fix:'",
+    "lint": "concurrently \"pnpm:lint:*(!fix)\" --names \"lint:\"",
+    "lint:fix": "concurrently \"pnpm:lint:*:fix\" --names \"fix:\"",
     "lint:js": "eslint . --cache",
     "lint:js:fix": "eslint . --fix",
-    "release:changelog": "changeset version",
+    "release:prepare": "changeset version",
     "release:publish": "changeset publish",
     "test": "mt tests --quiet"
   },

diff --git a/packages/cli/src/steps/update-package-json.ts b/packages/cli/src/steps/update-package-json.ts
@@ -78,6 +78,12 @@ function updateDevDependencies(
   packageJson['devDependencies'] = convertToObject(devDependencies);
 }
 
+function addPackageManager(packageJson: PackageJson): void {
+  const version = getVersion('pnpm').replace(/^\^/, '');
+
+  packageJson['packageManager'] = `pnpm@${version}`;
+}
+
 function addPnpmOverrides(packageJson: PackageJson, options: Options): void {
   const { codemod } = options;
 
@@ -103,6 +109,7 @@ export function updatePackageJson(options: Options): void {
 
   updateDependencies(packageJson, options);
   updateDevDependencies(packageJson, options);
+  addPackageManager(packageJson);
   addPnpmOverrides(packageJson, options);
 
   const destination = join(projectRoot, codemod.name, 'package.json');

diff --git a/packages/cli/src/utils/blueprints/get-version.ts b/packages/cli/src/utils/blueprints/get-version.ts
@@ -2,34 +2,35 @@ import { decideVersion } from '@codemod-utils/blueprints';
 
 const latestVersions = new Map([
   ['@babel/core', '7.26.0'],
-  ['@babel/eslint-parser', '7.25.9'],
-  ['@changesets/cli', '2.27.10'],
+  ['@babel/eslint-parser', '7.26.5'],
+  ['@changesets/cli', '2.27.11'],
   ['@changesets/get-github-info', '0.6.0'],
-  ['@codemod-utils/ast-javascript', '1.2.9'],
-  ['@codemod-utils/ast-template', '1.1.5'],
-  ['@codemod-utils/blueprints', '1.1.6'],
-  ['@codemod-utils/ember', '2.0.1'],
-  ['@codemod-utils/files', '2.0.5'],
-  ['@codemod-utils/json', '1.1.10'],
-  ['@codemod-utils/tests', '1.1.8'],
+  ['@codemod-utils/ast-javascript', '1.2.10'],
+  ['@codemod-utils/ast-template', '1.1.6'],
+  ['@codemod-utils/blueprints', '1.1.7'],
+  ['@codemod-utils/ember', '2.0.2'],
+  ['@codemod-utils/files', '2.0.6'],
+  ['@codemod-utils/json', '1.1.11'],
+  ['@codemod-utils/tests', '1.1.9'],
   ['@sondr3/minitest', '0.1.2'],
   ['@tsconfig/node18', '18.2.4'],
   ['@tsconfig/strictest', '2.0.5'],
-  ['@types/node', '18.19.67'],
+  ['@types/node', '18.19.70'],
   ['@types/yargs', '17.0.33'],
-  ['@typescript-eslint/eslint-plugin', '8.16.0'],
-  ['@typescript-eslint/parser', '8.16.0'],
-  ['concurrently', '9.1.0'],
+  ['@typescript-eslint/eslint-plugin', '8.20.0'],
+  ['@typescript-eslint/parser', '8.20.0'],
+  ['concurrently', '9.1.2'],
   ['eslint', '8.57.1'],
-  ['eslint-config-prettier', '9.1.0'],
-  ['eslint-import-resolver-typescript', '3.6.3'],
+  ['eslint-config-prettier', '10.0.1'],
+  ['eslint-import-resolver-typescript', '3.7.0'],
   ['eslint-plugin-import', '2.31.0'],
-  ['eslint-plugin-n', '17.14.0'],
-  ['eslint-plugin-prettier', '5.2.1'],
+  ['eslint-plugin-n', '17.15.1'],
+  ['eslint-plugin-prettier', '5.2.2'],
   ['eslint-plugin-simple-import-sort', '12.1.1'],
   ['eslint-plugin-typescript-sort-keys', '3.3.0'],
-  ['prettier', '3.4.1'],
-  ['typescript', '5.7.2'],
+  ['pnpm', '9.15.4'],
+  ['prettier', '3.4.2'],
+  ['typescript', '5.7.3'],
   ['yargs', '17.7.2'],
 ]);
 

diff --git a/...es/javascript-with-addons/output/ember-codemod-args-to-signature/.github/workflows/ci.yml b/...es/javascript-with-addons/output/ember-codemod-args-to-signature/.github/workflows/ci.yml
@@ -8,7 +8,6 @@ on:
 
 env:
   NODE_VERSION: 18
-  PNPM_VERSION: 9
 
 jobs:
   lint:
@@ -21,8 +20,6 @@ jobs:
 
       - name: Set up pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: ${{ env.PNPM_VERSION }}
 
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4
@@ -47,8 +44,6 @@ jobs:
 
       - name: Set up pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: ${{ env.PNPM_VERSION }}
 
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4

diff --git a/...s/javascript-with-addons/output/ember-codemod-args-to-signature/CONTRIBUTING.md b/...s/javascript-with-addons/output/ember-codemod-args-to-signature/CONTRIBUTING.md
@@ -83,15 +83,28 @@ Here are some guidelines to help you and everyone else.
 
 <summary>Publish package (for admins)</summary>
 
-1. Generate a [personal access token](https://github.com/settings/tokens/) in GitHub, with `repo` and `read:user` scopes enabled.
+1. Generate a [personal access token](https://github.com/settings/tokens/) in GitHub, with `repo` and `read:user` scopes enabled. This token will be used to retrieve pull request information.
 
-1. Run the `release:changelog` script. This removes changesets, updates the package version, and updates the `CHANGELOG`.
+1. Run the `release:prepare` script. This removes changesets, updates package versions, and updates `CHANGELOG`s.
 
     ```sh
-    GITHUB_TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN> pnpm release:changelog
+    # From the workspace root
+    GITHUB_TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN> pnpm release:prepare
     ```
 
-1. [Create a tag](https://github.com/<your-github-handle>/ember-codemod-args-to-signature/releases/new) and provide release notes. The tag name should match the package version.
+    Note, `release:prepare` also updated the workspace root's version (e.g. from `0.1.1` to `0.1.2`). We will use it to name the tag that will be published.
+
+1. Review the file changes. Commit them in a branch, then open a pull request to merge the changes to the `main` branch.
+
+    ```sh
+    # From the workspace root
+    git checkout -b tag-0.1.2
+    git add .
+    git commit -m "Tagged 0.1.2"
+    git push origin tag-0.1.2
+    ```
+
+1. [Create a tag](https://github.com/<your-github-handle>/ember-codemod-args-to-signature/releases/new) and provide release notes. The tag name should match the workspace root's version (e.g. `0.1.2`).
 
 1. Publish the package.
 

diff --git a/...xtures/javascript-with-addons/output/ember-codemod-args-to-signature/LICENSE.md b/...xtures/javascript-with-addons/output/ember-codemod-args-to-signature/LICENSE.md
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024
+Copyright (c) 2025
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/...tests/fixtures/javascript-with-addons/output/ember-codemod-args-to-signature/package.json b/...tests/fixtures/javascript-with-addons/output/ember-codemod-args-to-signature/package.json
@@ -22,40 +22,41 @@
     "src"
   ],
   "scripts": {
-    "lint": "concurrently 'pnpm:lint:*(!fix)' --names 'lint:'",
-    "lint:fix": "concurrently 'pnpm:lint:*:fix' --names 'fix:'",
+    "lint": "concurrently \"pnpm:lint:*(!fix)\" --names \"lint:\"",
+    "lint:fix": "concurrently \"pnpm:lint:*:fix\" --names \"fix:\"",
     "lint:js": "eslint . --cache",
     "lint:js:fix": "eslint . --fix",
-    "release:changelog": "changeset version",
+    "release:prepare": "changeset version",
     "release:publish": "changeset publish",
     "test": "mt tests --quiet"
   },
   "dependencies": {
-    "@codemod-utils/ast-javascript": "^1.2.9",
-    "@codemod-utils/ast-template": "^1.1.5",
-    "@codemod-utils/blueprints": "^1.1.6",
-    "@codemod-utils/ember": "^2.0.1",
-    "@codemod-utils/files": "^2.0.5",
-    "@codemod-utils/json": "^1.1.10",
+    "@codemod-utils/ast-javascript": "^1.2.10",
+    "@codemod-utils/ast-template": "^1.1.6",
+    "@codemod-utils/blueprints": "^1.1.7",
+    "@codemod-utils/ember": "^2.0.2",
+    "@codemod-utils/files": "^2.0.6",
+    "@codemod-utils/json": "^1.1.11",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
     "@babel/core": "^7.26.0",
-    "@babel/eslint-parser": "^7.25.9",
-    "@changesets/cli": "^2.27.10",
+    "@babel/eslint-parser": "^7.26.5",
+    "@changesets/cli": "^2.27.11",
     "@changesets/get-github-info": "^0.6.0",
-    "@codemod-utils/tests": "^1.1.8",
+    "@codemod-utils/tests": "^1.1.9",
     "@sondr3/minitest": "^0.1.2",
-    "concurrently": "^9.1.0",
+    "concurrently": "^9.1.2",
     "eslint": "^8.57.1",
-    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-n": "^17.14.0",
-    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-n": "^17.15.1",
+    "eslint-plugin-prettier": "^5.2.2",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "prettier": "^3.4.1"
+    "prettier": "^3.4.2"
   },
   "engines": {
     "node": "18.* || >= 20"
-  }
+  },
+  "packageManager": "[email protected]"
 }
diff --git a/...cli/tests/fixtures/javascript/output/ember-codemod-pod-to-octane/.github/workflows/ci.yml b/...cli/tests/fixtures/javascript/output/ember-codemod-pod-to-octane/.github/workflows/ci.yml
@@ -8,7 +8,6 @@ on:
 
 env:
   NODE_VERSION: 18
-  PNPM_VERSION: 9
 
 jobs:
   lint:
@@ -21,8 +20,6 @@ jobs:
 
       - name: Set up pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: ${{ env.PNPM_VERSION }}
 
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4
@@ -47,8 +44,6 @@ jobs:
 
       - name: Set up pnpm
         uses: pnpm/action-setup@v4
-        with:
-          version: ${{ env.PNPM_VERSION }}
 
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4