Add cspell to CI (#203)

* Add cspell to CI

* Run prettier

Author: JonasDov

.github/workflows/CI.yml

@@ -37,6 +37,9 @@ jobs:
       - name: Prettier
         run: npm run prettier
 
+      - name: cspell
+        run: npm run cspell
+
       - name: Build app/common
         run: npm run build --prefix ./app/common
 

.vscode/settings.json

@@ -1,64 +1,4 @@
 {
-  "cSpell.words": [
-    "appui",
-    "autosizer",
-    "baytown",
-    "cooldown",
-    "crossorigin",
-    "ecsql",
-    "exton",
-    "fonttools",
-    "frontstage",
-    "frontstages",
-    "ibim",
-    "imodel",
-    "imodelaccess",
-    "imodeljs",
-    "imodels",
-    "itemprop",
-    "itwin",
-    "itwinjs",
-    "itwins",
-    "itwinui",
-    "linkcode",
-    "metrostation",
-    "oidc",
-    "rpcs",
-    "ruleset",
-    "rulesets",
-    "sidenav",
-    "signin",
-    "signout",
-    "tablist",
-    "testid",
-    "threagile",
-    "twinjs",
-    "typecheck",
-    "unicodes",
-    "unmangled",
-    "unregisters",
-    "unroute",
-    "unstringified",
-    "unsymlinking",
-    "viewports",
-    "vite",
-    "widgetid"
-  ],
-  "cSpell.ignoreWords": [
-    "brotli",
-    "fnames",
-    "imjs",
-    "lcov",
-    "mmap",
-    "pyftsubset",
-    "pwdebug",
-    "rralign",
-    "wdth",
-    "wght"
-  ],
-  "cSpell.ignorePaths": ["package.json", ".vscode", "*.yaml", "*.yml"],
-  "cSpell.ignoreRegExpList": ["from\\s\".*\";"],
-
   "editor.insertSpaces": true,
   "editor.tabSize": 2,
   "editor.trimAutoWhitespace": true,

CONTRIBUTING.md

@@ -28,15 +28,13 @@ To summarize, we only do string localization inside `ITwinJsApp/` subdirectory.
 We have two sets of tests:
 
 - Unit tests for `presentation-rules-editor` package, which require 100% test coverage.
-
   - To run these tests navigate to `presentation-rules-editor-react/` and execute:
 
   ```bash
    npm test
   ```
 
 - End-to-end tests for the editor application. These tests are split into `web` and `local` tests.
-
   - To run `web` tests navigate to `app/e2e-tests/` and execute:
 
   ```bash

app/backend/src/main.ts

@@ -14,6 +14,8 @@ import { Presentation, PresentationBackendLoggerCategory, PresentationBackendNat
 import { PresentationRulesEditorRpcImpl } from "./PresentationRulesEditorRpcImpl.js";
 import { initialize } from "./web/BackendServer.js";
 
+// cspell:words Mmap
+
 dotenv.config({ path: "../../.env" });
 
 void (async () => {

app/frontend/src/app/experimental/StationPropertyValueRenderer.tsx

@@ -266,6 +266,7 @@ function createStationValueReader(imodel: IModelConnection, elementId: Id64Strin
     }
   }
 
+  // cspell:disable
   const ecsql = `
     SELECT
       linearlyLocated.DistanceAlongFromStart DistanceAlong,
@@ -282,6 +283,7 @@ function createStationValueReader(imodel: IModelConnection, elementId: Id64Strin
     LIMIT
       1
   `;
+  // cspell:enable
   const bindings = new QueryBinder().bindId("elementId", elementId);
   return imodel.createQueryReader(ecsql, bindings, { rowFormat: QueryRowFormat.UseECSqlPropertyIndexes });
 }

cspell.json

@@ -0,0 +1,39 @@
+{
+  "words": [
+    "appui",
+    "Autosizer",
+    "baytown",
+    "cooldown",
+    "ecschema",
+    "ecsql",
+    "Exton",
+    "frontstage",
+    "frontstages",
+    "ibim",
+    "imodel",
+    "imodeljs",
+    "imodels",
+    "itwin",
+    "itwinjs",
+    "itwins",
+    "itwinui",
+    "npmjs",
+    "Metrostation",
+    "rpcinterface",
+    "threagile",
+    "unstringified",
+    "widgetid"
+  ],
+  "ignorePaths": [
+    "package.json",
+    "dist",
+    "scripts",
+    "coverage",
+    "**/*.test.ts",
+    "**/*.test.tsx",
+    "pnpm-lock.yaml",
+    "**/*.d.ts",
+    "**/*.config.*",
+    "playwright-report"
+  ]
+}

package.json

@@ -9,6 +9,7 @@
     "build:components": "npm run build --prefix ./presentation-rules-editor-react",
     "build:frontend": "npm run build --prefix ./app/frontend",
     "build:common": "npm run build --prefix ./app/common",
+    "cspell": "cspell .",
     "start:frontend": "npm run start --prefix ./app/frontend -- --open",
     "link": "npm run link --prefix ./scripts --",
     "unlink": "npm run unlink --prefix ./scripts --",
@@ -42,9 +43,10 @@
   },
   "dependencies": {
     "cross-env": "^7.0.3",
+    "cspell": "^9.2.0",
     "eslint-config-prettier": "^9.1.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^3.4.2"
+    "prettier": "^3.6.2"
   },
   "pnpm": {
     "overrides": {