chore: setup cspell

Author: chenjiahan

.github/workflows/lint.yml

@@ -35,4 +35,7 @@ jobs:
           run_install: true
 
       - name: Run Lint
-        run: pnpm run lint
+        run: node --run lint
+
+      - name: Check Spell
+        run: node --run check-spell

cspell.config.js

@@ -0,0 +1,33 @@
+import { banWords } from 'cspell-ban-words';
+
+export default {
+  version: '0.2',
+  language: 'en',
+  files: ['**/*.{ts,tsx,js,jsx,md,mdx}'],
+  enableFiletypes: ['mdx'],
+  ignoreRegExpList: [
+    // ignore markdown anchors such as [modifyRsbuildConfig](#modifyrsbuildconfig)
+    '#.*?\\)',
+    // ignore custom anchor declarations such as ## createRsbuild \{#creatersbuild}
+    '\\\\\\{#[^}]+\\}',
+    // ignore release note author mentions such as "by @chenjiahan"
+    'by\\s+@[A-Za-z0-9_-]+',
+  ],
+  ignorePaths: [
+    'dist',
+    'dist-*',
+    'coverage',
+    'doc_build',
+    'node_modules',
+    'pnpm-lock.yaml',
+  ],
+  flagWords: banWords,
+  dictionaries: ['dictionary'],
+  dictionaryDefinitions: [
+    {
+      name: 'dictionary',
+      path: './scripts/dictionary.txt',
+      addWords: true,
+    },
+  ],
+};

package.json

@@ -24,6 +24,7 @@
   },
   "scripts": {
     "build": "rslib",
+    "check-spell": "pnpm dlx cspell",
     "dev": "rslib -w",
     "format": "oxfmt .",
     "format:check": "oxfmt . --check",
@@ -41,6 +42,7 @@
     "@rslint/core": "catalog:",
     "@types/node": "catalog:",
     "cac": "catalog:",
+    "cspell-ban-words": "catalog:",
     "oxfmt": "catalog:",
     "playwright": "catalog:",
     "typescript": "catalog:"

pnpm-lock.yaml

@@ -15,6 +15,7 @@ catalog:
   '@types/react': '^19.2.17'
   '@types/react-dom': '^19.2.3'
   'cac': '^7.0.0'
+  'cspell-ban-words': '^0.0.4'
   'oxfmt': '^0.56.0'
   'playwright': '^1.60.0'
   'react': '^19.2.7'

pnpm-workspace.yaml

@@ -0,0 +1,6 @@
+# Custom Dictionary Words
+rslib
+rslint
+rsbuild
+rspack
+rstack