Merge pull request #102 from barrymun/feature/spellcheck

Codebase spell checker

Author: Mathys-Gasnier

.github/workflows/pre-commit-checks.yml

@@ -0,0 +1,31 @@
+name: Pre-commit checks
+
+on:
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  pre-commit-checks:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run cspell
+        run: npm run cspell
+
+      - name: Run lint
+        run: npm run lint
+
+      - name: Run build
+        run: npm run build

.husky/pre-commit

@@ -1,2 +1,3 @@
+npm run cspell
 npm run lint
 npm run build

cspell-dict.txt

@@ -0,0 +1 @@
+quicksnip

cspell.json

@@ -0,0 +1,16 @@
+{
+  "dictionaryDefinitions": [
+    {
+      "name": "workspace",
+      "path": "./cspell-dict.txt",
+      "description": "Custom Workspace Dictionary",
+      "addWords": true
+    }
+  ],
+  "dictionaries": ["workspace"],
+  "ignorePaths": [
+    "node_modules",
+    "dist",
+    "public"
+  ]
+}

package-lock.json

@@ -11,6 +11,7 @@
     "format:check": "prettier --check .",
     "preview": "vite preview",
     "prepare": "husky",
+    "cspell": "cspell --config cspell.json \"**/*.{ts,tsx,js,jsx,json,html}\"",
     "snippets:check": "node ./utils/checkSnippetFormatting.js",
     "snippets:consolidate": "node ./utils/consolidateSnippets.js"
   },
@@ -31,6 +32,7 @@
     "@types/react-dom": "^18.3.0",
     "@types/react-syntax-highlighter": "^15.5.13",
     "@vitejs/plugin-react-swc": "^3.5.0",
+    "cspell": "^8.17.1",
     "eslint": "^9.11.1",
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.7.0",

package.json

@@ -13,7 +13,7 @@ const CategoryList = () => {
 
   if (loading) return <div>Loading...</div>;
 
-  if (error) return <div>Error occured: {error}</div>;
+  if (error) return <div>Error occurred: {error}</div>;
 
   return (
     <ul role="list" className="categories">

src/components/CategoryList.tsx

@@ -17,7 +17,7 @@ const CopyToClipboard = ({ text, ...props }: Props) => {
         setIsCopied(true);
         setTimeout(() => setIsCopied(false), 2000);
       })
-      .catch((err) => alert("Error occured: " + err));
+      .catch((err) => alert("Error occurred: " + err));
   };
 
   return (