Skip to content

Commit 0dbbd1c

Browse files
feat: add cspell configuration and CI spell-check
1 parent 8f22894 commit 0dbbd1c

File tree

3 files changed

+73
-0
lines changed

3 files changed

+73
-0
lines changed

.github/workflows/ci.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,27 @@ jobs:
103103

104104
- name: Check Licenses
105105
run: npm run check-licenses
106+
107+
spell-check:
108+
name: Spell Check
109+
runs-on: ubuntu-latest
110+
timeout-minutes: 15
111+
steps:
112+
- name: Checkout
113+
uses: actions/checkout@v5
114+
115+
- name: Setup Node.js
116+
uses: actions/setup-node@v5
117+
with:
118+
cache: 'npm'
119+
node-version: ${{ env.NODE_VERSION }}
120+
registry-url: 'https://npm.pkg.github.com'
121+
scope: '@deepnote'
122+
123+
- name: Install dependencies
124+
run: npm ci --prefer-offline --no-audit
125+
env:
126+
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
127+
128+
- name: Run spell check
129+
run: npm run spell-check

cspell.json

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

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2055,6 +2055,8 @@
20552055
"build:prerelease": "cross-env IS_PRE_RELEASE_VERSION_OF_JUPYTER_EXTENSION=true npm run build",
20562056
"build:stable": "cross-env IS_PRE_RELEASE_VERSION_OF_JUPYTER_EXTENSION=false npm run build",
20572057
"build": "concurrently npm:compile-release npm:updatePackageJsonForBundle",
2058+
"spell-check": "cspell \"**/*.{md,txt,json,js,ts,tsx,jsx,yml,yaml}\"",
2059+
"spell-check:fix": "cspell \"**/*.{md,txt,json,js,ts,tsx,jsx,yml,yaml}\" --no-exit-code --show-suggestions",
20582060
"check-licenses": "npx license-checker-rseidelsohn --onlyAllow 'MIT;Apache-2.0;Apache v2;ISC;BSD;BSD-2-Clause;BSD-3-Clause;0BSD;Python-2.0;CC0-1.0;CC-BY-3.0;CC-BY-4.0;Unlicense;BlueOak-1.0.0;MPL-2.0' --excludePrivatePackages --excludePackages 'bootstrap-less@3.3.8;chai-as-promised@7.1.1;esbuild-plugin-less@1.3.19;eslint-plugin-local-rules@1.0.0;truncate-utf8-bytes@1.0.2;utf8-byte-length@1.0.4'",
20592061
"checkDependencies": "gulp checkDependencies",
20602062
"clean": "gulp clean",
@@ -2163,6 +2165,7 @@
21632165
"zeromqold": "npm:zeromq@^6.0.0-beta.6"
21642166
},
21652167
"devDependencies": {
2168+
"cspell": "9.2.1",
21662169
"@actions/core": "^1.11.1",
21672170
"@actions/github": "^6.0.1",
21682171
"@actions/glob": "^0.5.0",

0 commit comments

Comments
 (0)