chore: add local CI script and format:check (#965)

karfau · web-flow · commit be45d04f1520 · 2026-03-23T08:15:54.000+01:00
## Summary

- Adds `.github/workflows/ci-local.sh` to run the full CI suite locally
before pushing — validates Node version against `.nvmrc`, exports
`CI=true`, and runs the same steps as GitHub Actions (`test`, `fuzz`,
`lint`, `test:types`, `format:check`)
- Adds `format:check` npm script and wires it into the `lint` job in
`test-node.js.yml`
- Ignores generated files that would otherwise cause false positives:
`examples/typescript-node-es6/dist` (from `test:types`) in
`.eslintignore` and `.prettierignore`; `test/error/reported.json` in
`.prettierignore`
- Fixes `test:types` failing locally when root `node_modules` is
installed: restricts `typeRoots` in
`examples/typescript-node-es6/tsconfig.json` to the example's own
`node_modules` so TypeScript 3 doesn't pick up `@types/yargs` (which
uses TS 4.1+ template literal syntax)
- Script cleans up generated test artefacts (`test/error/reported.json`,
`test/errors/reported.json`) on start to prevent cross-branch
contamination

## Test plan

- [x] CI passes on this PR
- [ ] `bash .github/workflows/ci-local.sh` passes locally on `master`
after merge
diff --git a/.eslintignore b/.eslintignore
@@ -1 +1,2 @@
 test/grammar/regexp.js
+examples/typescript-node-es6/dist
diff --git a/.github/workflows/ci-local.sh b/.github/workflows/ci-local.sh
@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+set -euo pipefail
+export CI=true
+
+EXPECTED=$(cat .nvmrc)
+ACTUAL=$(node --version)
+if [[ "$ACTUAL" != "v${EXPECTED}"* ]]; then
+  echo "ERROR: expected node $EXPECTED, got $ACTUAL" >&2
+  exit 1
+fi
+
+# Remove generated test artefacts that differ between branches to avoid cross-branch contamination
+rm -f test/error/reported.json test/errors/reported.json
+
+npm ci
+npm run test
+npm run fuzz
+npm run lint
+npm run test:types
+npm run format:check
diff --git a/.github/workflows/test-node.js.yml b/.github/workflows/test-node.js.yml
@@ -65,3 +65,4 @@ jobs:
         node-version-file: .node-version
     - run: npm ci --no-audit
     - run: npm run lint
+    - run: npm run format:check
diff --git a/.prettierignore b/.prettierignore
@@ -1 +1,3 @@
 test/grammar/regexp.js
+test/error/reported.json
+examples/typescript-node-es6/dist
diff --git a/examples/typescript-node-es6/tsconfig.json b/examples/typescript-node-es6/tsconfig.json
@@ -32,7 +32,9 @@
 		// "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
 		// "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
 		// "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
-		// "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+		"typeRoots": [
+			"./node_modules/@types"
+		] /* Specify multiple folders that act like `./node_modules/@types`. */,
 		// "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
 		// "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
 		// "resolveJsonModule": true,                        /* Enable importing .json files */
diff --git a/package.json b/package.json
@@ -30,6 +30,7 @@
 	"scripts": {
 		"lint": "eslint examples lib test",
 		"format": "prettier --write examples lib test index.d.ts",
+		"format:check": "prettier --check examples lib test index.d.ts",
 		"changelog": "auto-changelog --unreleased-only",
 		"start": "nodemon --watch package.json --watch lib --watch test --exec 'npm --silent run test && npm --silent run lint'",
 		"test": "jest",

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`test/grammar/regexp.js`
	`2`	`+examples/typescript-node-es6/dist`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`test/grammar/regexp.js`
	`2`	`+test/error/reported.json`
	`3`	`+examples/typescript-node-es6/dist`