Skip to content

Commit 411d5a1

Browse files
feat: add cspell configuration and CI spell-check
1 parent 45fb503 commit 411d5a1

File tree

3 files changed

+61
-0
lines changed

3 files changed

+61
-0
lines changed

.github/workflows/build.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,3 +169,16 @@ jobs:
169169
- uses: actions/checkout@v4
170170
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
171171
- uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
172+
173+
spell-check:
174+
name: Spell Check
175+
runs-on: ubuntu-latest
176+
steps:
177+
- name: Checkout
178+
uses: actions/checkout@v4
179+
180+
- name: Base Setup
181+
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
182+
183+
- name: Run spell check
184+
run: jlpm run spell-check

cspell.json

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"version": "0.2",
3+
"ignorePaths": [
4+
"node_modules",
5+
"package-lock.json",
6+
"yarn.lock",
7+
"dist",
8+
"lib",
9+
"build",
10+
"coverage",
11+
".vscode",
12+
".git",
13+
"*.min.js",
14+
"*.min.css",
15+
"*.map",
16+
"jupyterlab_deepnote/labextension"
17+
],
18+
"language": "en",
19+
"overrides": [
20+
{
21+
"filename": "**/*.md",
22+
"words": [
23+
"deepnote",
24+
"jupyter",
25+
"jupyterlab",
26+
"ipynb",
27+
"labextension",
28+
"jlpm",
29+
"pnpm",
30+
"monorepo"
31+
]
32+
}
33+
],
34+
"words": [
35+
"deepnote",
36+
"jupyter",
37+
"jupyterlab",
38+
"ipynb",
39+
"labextension",
40+
"jlpm",
41+
"pnpm",
42+
"monorepo"
43+
],
44+
"useGitignore": true
45+
}

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@
5353
"stylelint": "jlpm stylelint:check --fix",
5454
"stylelint:check": "stylelint --cache \"style/**/*.css\"",
5555
"test": "jest --coverage",
56+
"spell-check": "cspell \"**/*.{md,txt,json,js,ts,tsx,jsx,yml,yaml}\"",
57+
"spell-check:fix": "cspell \"**/*.{md,txt,json,js,ts,tsx,jsx,yml,yaml}\" --no-exit-code --show-suggestions",
5658
"watch": "run-p watch:src watch:labextension",
5759
"watch:src": "tsc -w --sourceMap",
5860
"watch:labextension": "jupyter labextension watch ."
@@ -70,6 +72,7 @@
7072
"zod": "^4.1.11"
7173
},
7274
"devDependencies": {
75+
"cspell": "9.2.1",
7376
"@jupyterlab/builder": "^4.0.0",
7477
"@jupyterlab/testutils": "^4.0.0",
7578
"@types/jest": "^29.2.0",

0 commit comments

Comments
 (0)