Switch from yarn@1.22.22 to pnpm@11.0.8 (#949)

Switch from yarn@1.22.22 to pnpm@11.0.8, as per
#945 (comment).

This also pins `@types/node@22.9.0`, matching the version previously
resolved through `yarn.lock`. Without the pin, pnpm resolves
`@types/node@25.6.0`, which TypeScript 4.9 cannot check. The observed
diagnostics:

- `error TS1165: A computed property name in an ambient context must
refer to an expression whose type is a literal type or a 'unique symbol'
type`
- `error TS2339: Property 'dispose' does not exist on type
'SymbolConstructor'`
- `error TS2726: Cannot find lib definition for 'esnext.disposable'`

Install pnpm via the methods on the installation page:

- https://pnpm.io/installation

TODO:

- [x] Delete `yarn.lock`
- [x] Generate `pnpm-lock.yaml`
- [x] Update package scripts from Yarn commands to pnpm commands
- [x] Update GitHub Actions from Yarn commands to pnpm commands
- [x] Update contributor docs from Yarn commands to pnpm commands
- [x] Remove the README install example with Yarn
- [x] Update CI from Node 18 to Node 22 for pnpm 11 compatibility
- [x] Enable pnpm dependency caching in CI
- [x] Pin `devEngines.packageManager` to `pnpm@11.0.8`
- [x] Pin `@types/node@22.9.0`
- [x] Verify dependencies before scripts with `verifyDepsBeforeRun:
error`
- [x] Declare the root workspace package with `packages: ['.']`
- [x] Block packages newer than seven days with `minimumReleaseAge:
10080`
- [x] Apply release-age checks strictly with `minimumReleaseAgeStrict:
true`
- [x] Treat missing publish times as unsafe with
`minimumReleaseAgeIgnoreMissingTime: false`
- [x] Prevent trust downgrades with `trustPolicy: no-downgrade`
- [x] Allow the trust-policy exception `eslint-config-prettier@8.10.2`
- [x] Allow the trust-policy exception `eslint-plugin-prettier@4.2.5`
- [x] Allow the trust-policy exception `semver@5.7.2 || 6.3.1`
- [x] Allow the trust-policy exception `undici-types@6.19.8`
- [x] Block exotic subdependencies with `blockExoticSubdeps: true`


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Chores**
  * Updated CI and project tooling to Node.js 22.x.
* Migrated package management from Yarn to pnpm across CI, scripts, and
project config.
* Added a pnpm workspace with stricter dependency and verification
policies.
* Updated developer scripts and bumped dev tooling/type dependency
versions.

* **Documentation**
* Updated install and contribution instructions to reflect pnpm and
Node.js 22.x.

<!-- review_stack_entry_start -->

[![Review Change
Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/sql-formatter-org/sql-formatter/pull/949)

<!-- review_stack_entry_end -->
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Author: nene

.github/workflows/coveralls.yaml

@@ -10,21 +10,32 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [22.x]
 
     steps:
       - uses: actions/checkout@v4
 
+      # Work around pnpm/action-setup v6 resolving the wrong version from package.json
+      # https://github.com/pnpm/action-setup/issues/227
+      - name: Read pnpm version
+        id: pnpm-version
+        run: 'echo "version=$(jq --raw-output ''.devEngines.packageManager.version | split("+")[0]'' package.json)" >> "$GITHUB_OUTPUT"'
+
+      - uses: pnpm/action-setup@v6
+        with:
+          version: ${{ steps.pnpm-version.outputs.version }}
+
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: pnpm
 
       - name: Install
-        run: yarn install --ignore-scripts
+        run: pnpm install --ignore-scripts
 
       - name: Test
-        run: yarn test --coverage
+        run: pnpm run test -- --coverage
 
       - name: Coveralls GitHub Action
         uses: coverallsapp/github-action@1.1.3

.github/workflows/webpack.yaml

@@ -9,30 +9,41 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [22.x]
 
     steps:
       - uses: actions/checkout@v4
 
+      # Work around pnpm/action-setup v6 resolving the wrong version from package.json
+      # https://github.com/pnpm/action-setup/issues/227
+      - name: Read pnpm version
+        id: pnpm-version
+        run: 'echo "version=$(jq --raw-output ''.devEngines.packageManager.version | split("+")[0]'' package.json)" >> "$GITHUB_OUTPUT"'
+
+      - uses: pnpm/action-setup@v6
+        with:
+          version: ${{ steps.pnpm-version.outputs.version }}
+
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: pnpm
 
       - name: Install
-        run: yarn install --ignore-scripts
+        run: pnpm install --ignore-scripts
 
       - name: Format
-        run: yarn pretty:check
+        run: pnpm run pretty:check
 
       - name: Lint
-        run: yarn lint
+        run: pnpm run lint
 
       - name: Test
-        run: yarn test
+        run: pnpm run test
 
       - name: Build
-        run: yarn build
+        run: pnpm run build
 
       - name: Typecheck
-        run: yarn ts:check
+        run: pnpm run ts:check

.prettierignore

@@ -2,6 +2,6 @@
 /dist
 /lib
 /node_modules
-yarn.lock
+pnpm-lock.yaml
 LICENSE
 /src/parser/grammar.ts

CONTRIBUTING.md

@@ -5,11 +5,11 @@ as SQL Formatter is mostly in maintenance mode.
 
 ## Setup
 
-Run `yarn` after checkout to install all dependencies.
+Run `pnpm install` after checkout to install all dependencies.
 
 ## Tests
 
-Tests can be run with `yarn test`.
+Tests can be run with `pnpm test`.
 
 Please add new tests for any new features and bug fixes.
 Language-specific tests should be included in their respective `sqldialect.test.ts` files.
@@ -19,7 +19,7 @@ Tests that apply to all languages should be in `behavesLikeSqlFormatter.ts`.
 
 For those who have admin access on the repo, the new release publish flow is as such:
 
-- `npm run release` (bumps version, git tag, git release, npm release) (does not work with `yarn`).
+- `pnpm run release` (bumps version, git tag, git release, npm release).
 - `git subtree push --prefix static origin gh-pages` (pushes demo page to GH pages)
 
 [prettier-plugin-sql-cst]: https://github.com/nene/prettier-plugin-sql-cst

README.md

@@ -19,16 +19,10 @@ It does not support:
 
 ## Install
 
-Get the latest version from NPM:
+Get the latest version using your package manager of choice:
 
 ```sh
-npm install sql-formatter
-```
-
-Also available with yarn:
-
-```sh
-yarn add sql-formatter
+npm install sql-formatter # or yarn, pnpm, bun, etc
 ```
 
 ## Usage

package.json

@@ -54,21 +54,21 @@
     "ts:check": "tsc --noEmit",
     "ts:changes": "tsc --noEmit --incremental",
     "lint": "eslint --cache .",
-    "lint:changes": "sh -c eslint --cache $(yarn git:changes)",
+    "lint:changes": "sh -c 'eslint --cache $(pnpm run --silent git:changes)'",
     "pretty": "prettier --write .",
     "pretty:check": "prettier --check .",
-    "fix": "yarn pretty && eslint --fix .",
-    "test": "yarn grammar && jest",
-    "test:watch": "yarn test -- --watch",
-    "test:perf": "yarn grammar && jest --testMatch '<rootDir>/test/perftest.ts' --coverage=false",
-    "check": "yarn ts:check && yarn pretty:check && yarn lint && yarn test",
-    "prepare": "yarn clean && yarn grammar && yarn fix && yarn check && yarn build",
+    "fix": "pnpm run pretty && eslint --fix .",
+    "test": "pnpm run grammar && jest",
+    "test:watch": "pnpm run test -- --watch",
+    "test:perf": "pnpm run grammar && jest --testMatch '<rootDir>/test/perftest.ts' --coverage=false",
+    "check": "pnpm run ts:check && pnpm run pretty:check && pnpm run lint && pnpm run test",
+    "prepare": "pnpm run clean && pnpm run grammar && pnpm run fix && pnpm run check && pnpm run build",
     "pre-commit": "npm-run-all --parallel ts:changes lint:changes",
     "grammar": "nearleyc src/parser/grammar.ne -o src/parser/grammar.ts",
     "build:cjs": "tsc -p tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
     "build:esm": "tsc -p tsconfig.esm.json",
     "build:webpack": "webpack --config webpack.prod.js && cp dist/sql-formatter.min.cjs dist/sql-formatter.min.js",
-    "build": "yarn grammar && npm-run-all --parallel build:cjs build:esm build:webpack",
+    "build": "pnpm run grammar && npm-run-all --parallel build:cjs build:esm build:webpack",
     "release": "release-it"
   },
   "repository": {
@@ -92,6 +92,7 @@
     "@types/babel__core": "^7.1.15",
     "@types/jest": "^29.5.14",
     "@types/nearley": "^2.11.2",
+    "@types/node": "22.9.0",
     "@typescript-eslint/eslint-plugin": "^5.21.0",
     "@typescript-eslint/parser": "^5.21.0",
     "babel-eslint": "^10.1.0",
@@ -133,8 +134,8 @@
   },
   "devEngines": {
     "packageManager": {
-      "name": "yarn",
-      "version": "1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+      "name": "pnpm",
+      "version": "11.0.8+sha512.4c4097e1dd2d42372c4e7fa5a791ff28fc75a484c7ac192e64b1df0fdef17594ba982f9b4fed9adfb3c757846f565b799b2763fb3733d1de1bcb82cf46684912"
     }
   }
 }