Skip to content

Commit 8512301

Browse files
holgerd77holgerd77
authored
Some Spellchecker Improvements (#3955)
* Rename cspell to tool-agnistic spellcheck, add simple sc alias * Expand spellcheck command to local packages, extended .md run * Workflow file rename cspell.yml -> spellcheck.yml
1 parent 4d0faa0 commit 8512301

File tree

18 files changed

+69
-4
lines changed

18 files changed

+69
-4
lines changed

‎.github/workflows/cspell.yml renamed to ‎.github/workflows/spellcheck.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ jobs:
1919
node-version: 18
2020
cache: 'npm'
2121

22-
- run: npm run cspell
22+
- run: npm run spellcheck

‎package.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@
77
"biome:fix": "npx @biomejs/biome check --write",
88
"checkNpmVersion": "./scripts/check-npm-version.sh",
99
"clean": "./config/cli/clean-root.sh",
10-
"cspell": "npm run cspell:ts && npm run cspell:md",
11-
"cspell:ts": "npx cspell --gitignore -e \"./packages/ethereum-tests\" -e \"./packages/wallet/test\" -e \"./packages/client/archive\" -c ./config/cspell-ts.json \"./packages/**/*.ts\" --cache --show-suggestions --show-context",
12-
"cspell:md": "npx cspell --gitignore -e \"./packages/ethereum-tests\" -e \"./packages/client/withdrawals-testnet/**\" -e \"./packages/**/docs\" -c ./config/cspell-md.json \"**.md\" --cache --show-suggestions --show-context",
1310
"docs:build": "npm run docs:build --workspaces --if-present",
1411
"e2e:inject": "node ./scripts/e2e-inject-resolutions.js",
1512
"e2e:publish": "./scripts/e2e-publish.sh",
@@ -25,7 +22,11 @@
2522
"preinstall": "npm run checkNpmVersion",
2623
"postinstall": "npm run build --workspaces",
2724
"prepare": "git config --local core.hooksPath .githooks",
25+
"sc": "npm run spellcheck",
2826
"sort-package-json": "sort-package-json \"package.json\" \"packages/*/package.json\"",
27+
"spellcheck": "npm run spellcheck:ts && npm run spellcheck:md",
28+
"spellcheck:ts": "npx cspell --gitignore -e \"./packages/ethereum-tests\" -e \"./packages/wallet/test\" -e \"./packages/client/archive\" -c ./config/cspell-ts.json \"./packages/**/*.ts\" --cache --show-suggestions --show-context",
29+
"spellcheck:md": "npx cspell --gitignore -e \"./packages/ethereum-tests\" -e \"./packages/client/withdrawals-testnet/**\" -e \"./packages/**/docs\" -c ./config/cspell-md.json \"**.md\" --cache --show-suggestions --show-context",
2930
"install-browser-deps": "npm install [email protected] @vitest/[email protected]"
3031
},
3132
"devDependencies": {

‎packages/binarytree/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@
4444
"lint": "npm run biome && eslint --config ./eslint.config.mjs .",
4545
"lint:fix": "npm run biome:fix && eslint --fix --config ./eslint.config.mjs .",
4646
"prepublishOnly": "../../config/cli/prepublish.sh",
47+
"sc": "npm run spellcheck",
48+
"spellcheck": "npm run spellcheck:ts && npm run spellcheck:md",
49+
"spellcheck:ts": "npx cspell --gitignore -c ../../config/cspell-ts.json \"./**/*.ts\" --cache --show-suggestions --show-context",
50+
"spellcheck:md": "npx cspell --gitignore -c ../../config/cspell-md.json \"**.md\" --cache --show-suggestions --show-context",
4751
"test": "npm run test:node",
4852
"test:node": "npx vitest run -c ../../config/vitest.config.mts",
4953
"test:browser": "npx vitest run --config=../../config/vitest.config.browser.mts",

‎packages/block/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@
4040
"lint": "npm run biome && eslint --config ./eslint.config.mjs .",
4141
"lint:fix": "npm run biome:fix && eslint --fix --config ./eslint.config.mjs .",
4242
"prepublishOnly": "../../config/cli/prepublish.sh",
43+
"sc": "npm run spellcheck",
44+
"spellcheck": "npm run spellcheck:ts && npm run spellcheck:md",
45+
"spellcheck:ts": "npx cspell --gitignore -c ../../config/cspell-ts.json \"./**/*.ts\" --cache --show-suggestions --show-context",
46+
"spellcheck:md": "npx cspell --gitignore -c ../../config/cspell-md.json \"**.md\" --cache --show-suggestions --show-context",
4347
"test": "npm run test:node && npm run test:browser",
4448
"test:browser": "npx vitest run --config=../../config/vitest.config.browser.mts",
4549
"test:node": "npx vitest run -c ../../config/vitest.config.mts",

‎packages/blockchain/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@
4040
"lint": "npm run biome && eslint --config ./eslint.config.mjs .",
4141
"lint:fix": "npm run biome:fix && eslint --fix --config ./eslint.config.mjs .",
4242
"prepublishOnly": "../../config/cli/prepublish.sh",
43+
"sc": "npm run spellcheck",
44+
"spellcheck": "npm run spellcheck:ts && npm run spellcheck:md",
45+
"spellcheck:ts": "npx cspell --gitignore -c ../../config/cspell-ts.json \"./**/*.ts\" --cache --show-suggestions --show-context",
46+
"spellcheck:md": "npx cspell --gitignore -c ../../config/cspell-md.json \"**.md\" --cache --show-suggestions --show-context",
4347
"test": "npm run test:node && npm run test:browser",
4448
"test:browser": "npx vitest run --config=./vitest.config.browser.mts",
4549
"test:node": "npx vitest run -c ../../config/vitest.config.mts",

‎packages/client/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@
4040
"lint:fix": "npm run biome:fix && eslint --fix --config ./eslint.config.mjs .",
4141
"preinstall": "npm run binWorkaround",
4242
"prepublishOnly": "../../config/cli/prepublish.sh",
43+
"sc": "npm run spellcheck",
44+
"spellcheck": "npm run spellcheck:ts && npm run spellcheck:md",
45+
"spellcheck:ts": "npx cspell --gitignore -c ../../config/cspell-ts.json \"./**/*.ts\" --cache --show-suggestions --show-context",
46+
"spellcheck:md": "npx cspell --gitignore -c ../../config/cspell-md.json \"**.md\" --cache --show-suggestions --show-context",
4347
"repl": "npx tsx ./bin/repl.ts --logLevel=error",
4448
"test": "npm run test:unit && npm run test:integration",
4549
"test:cli": "npx vitest run -c ../../config/vitest.config.mts ./test/cli/*.spec.ts",

‎packages/common/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@
5353
"lint": "npm run biome && eslint --config ./eslint.config.mjs .",
5454
"lint:fix": "npm run biome:fix && eslint --fix --config ./eslint.config.mjs .",
5555
"prepublishOnly": "../../config/cli/prepublish.sh",
56+
"sc": "npm run spellcheck",
57+
"spellcheck": "npm run spellcheck:ts && npm run spellcheck:md",
58+
"spellcheck:ts": "npx cspell --gitignore -c ../../config/cspell-ts.json \"./**/*.ts\" --cache --show-suggestions --show-context",
59+
"spellcheck:md": "npx cspell --gitignore -c ../../config/cspell-md.json \"**.md\" --cache --show-suggestions --show-context",
5660
"test": "npm run test:node && npm run test:browser",
5761
"test:browser": "npx vitest run --config=../../config/vitest.config.browser.mts",
5862
"test:node": "npx vitest run -c ../../config/vitest.config.mts",

‎packages/devp2p/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@
5656
"lint": "npm run biome && eslint --config ./eslint.config.mjs .",
5757
"lint:fix": "npm run biome:fix && eslint --fix --config ./eslint.config.mjs .",
5858
"prepublishOnly": "../../config/cli/prepublish.sh",
59+
"sc": "npm run spellcheck",
60+
"spellcheck": "npm run spellcheck:ts && npm run spellcheck:md",
61+
"spellcheck:ts": "npx cspell --gitignore -c ../../config/cspell-ts.json \"./**/*.ts\" --cache --show-suggestions --show-context",
62+
"spellcheck:md": "npx cspell --gitignore -c ../../config/cspell-md.json \"**.md\" --cache --show-suggestions --show-context",
5963
"test": "vitest run -c ../../config/vitest.config.mts",
6064
"test:node": "npm run test",
6165
"tsc": "../../config/cli/ts-compile.sh"

‎packages/era/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@
4646
"lint": "npm run biome && eslint --config ./eslint.config.mjs .",
4747
"lint:fix": "npm run biome:fix && eslint --fix --config ./eslint.config.mjs .",
4848
"prepublishOnly": "../../config/cli/prepublish.sh",
49+
"sc": "npm run spellcheck",
50+
"spellcheck": "npm run spellcheck:ts && npm run spellcheck:md",
51+
"spellcheck:ts": "npx cspell --gitignore -c ../../config/cspell-ts.json \"./**/*.ts\" --cache --show-suggestions --show-context",
52+
"spellcheck:md": "npx cspell --gitignore -c ../../config/cspell-md.json \"**.md\" --cache --show-suggestions --show-context",
4953
"test": "npm run test:node",
5054
"test:node": "npx vitest run -c ../../config/vitest.config.mts",
5155
"tsc": "../../config/cli/ts-compile.sh"

‎packages/ethash/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@
4040
"lint": "npm run biome && eslint --config ./eslint.config.mjs .",
4141
"lint:fix": "npm run biome:fix && eslint --fix --config ./eslint.config.mjs .",
4242
"prepublishOnly": "../../config/cli/prepublish.sh",
43+
"sc": "npm run spellcheck",
44+
"spellcheck": "npm run spellcheck:ts && npm run spellcheck:md",
45+
"spellcheck:ts": "npx cspell --gitignore -c ../../config/cspell-ts.json \"./**/*.ts\" --cache --show-suggestions --show-context",
46+
"spellcheck:md": "npx cspell --gitignore -c ../../config/cspell-md.json \"**.md\" --cache --show-suggestions --show-context",
4347
"test": "npx vitest run -c ../../config/vitest.config.mts",
4448
"tsc": "../../config/cli/ts-compile.sh"
4549
},

0 commit comments

Comments
 (0)