chore: Add cspell

.github/workflows/build.yml

@@ -39,6 +39,8 @@ jobs:
           key: pnpm-${{ hashFiles('pnpm-lock.yaml') }}
       - name: Install dependencies
         run: pnpm install
+      - name: Check spelling
+        run: pnpm run cspell
       - name: Lint
         run: pnpm run lint
       - name: Check types

README.md

@@ -142,7 +142,7 @@ Use `cy.saveLocalStorage()` to save a snapshot of current `localStorage` at the
 
 #### Cookies button example
 
-Next example shows how this package can be used to test a "cookies button" _(which theorically sets a flag into `localStorage` and can be clicked only once)_
+Next example shows how this package can be used to test a "cookies button" _(which in theory sets a flag into `localStorage` and can be clicked only once)_
 
 ```js
 describe("Accept cookies button", () => {

cspell.config.js

@@ -0,0 +1,47 @@
+const { resolve } = require("path");
+
+const DICTIONARIES_BASE_PATH = resolve(__dirname, "cspell");
+
+module.exports = {
+  // Version of the setting file.  Always 0.2
+  version: "0.2",
+  // Paths to be ignored
+  ignorePaths: [
+    "**/node_modules/**",
+    ".husky/**",
+    "**/pnpm-lock.yaml",
+    "**/cspell/*.txt",
+    "cspell.config.js",
+    "**/.gitignore",
+    "**/coverage/**",
+    "**/dist/**",
+    "test-e2e/app/build/**",
+    "test-e2e/*/cypress/integration/**",
+    "test-e2e/app/build/**",
+    "test-e2e/cypress-typescript/cypress/support/cypress-localstorage-commands/**",
+    "reports/**",
+  ],
+  caseSensitive: false,
+  // Language - current active spelling language
+  language: "en",
+  // Dictionaries to be used
+  dictionaryDefinitions: [
+    {
+      name: "missing",
+      path: `${DICTIONARIES_BASE_PATH}/missing.txt`,
+    },
+  ],
+  dictionaries: ["missing"],
+  languageSettings: [
+    {
+      // In markdown files
+      languageId: "markdown",
+      // Exclude code blocks from spell checking
+      ignoreRegExpList: ["/^\\s*```[\\s\\S]*?^\\s*```/gm"],
+    },
+  ],
+  // The minimum length of a word before it is checked.
+  minWordLength: 4,
+  // cspell:disable-next-line FlagWords - list of words to be always considered incorrect. This is useful for offensive words and common spelling errors. For example "hte" should be "the"
+  flagWords: ["hte"],
+};

cspell/missing.txt

@@ -0,0 +1,6 @@
+Brea
+commonmark
+javierbrea
+prelint
+Uninen
+

eslint.config.mjs

@@ -24,6 +24,7 @@ export default [
       "test-e2e/*/cypress/integration/**",
       "test-e2e/app/build/**",
       "test-e2e/cypress-typescript/cypress/support/cypress-localstorage-commands/**",
+      "reports/**",
     ],
   },
   {

package.json

@@ -26,18 +26,19 @@
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
+    "cspell": "cspell . --quiet",
     "lint": "eslint .",
     "lint-staged": "lint-staged",
     "test": "jest",
+    "test:ci": "pnpm run test:unit && pnpm run test:mutation && pnpm run test:e2e",
+    "test:e2e": "pnpm test:e2e:cypress-9 && pnpm test:e2e:cypress-9-no-plugin && pnpm test:e2e:cypress-latest && pnpm test:e2e:cypress-latest-no-plugin && pnpm test:e2e:cypress-typescript",
     "test:e2e:cypress-9": "pnpm --filter cypress-9 test:ci",
     "test:e2e:cypress-9-no-plugin": "pnpm --filter cypress-9-no-plugin test:ci",
     "test:e2e:cypress-latest": "pnpm --filter cypress-latest test:ci",
     "test:e2e:cypress-latest-no-plugin": "pnpm --filter cypress-latest-no-plugin test:ci",
     "test:e2e:cypress-typescript": "pnpm --filter cypress-typescript test:ci",
-    "test:e2e": "pnpm test:e2e:cypress-9 && pnpm test:e2e:cypress-9-no-plugin && pnpm test:e2e:cypress-latest && pnpm test:e2e:cypress-latest-no-plugin && pnpm test:e2e:cypress-typescript",
-    "test:unit": "pnpm run test",
     "test:mutation": "stryker run",
-    "test:ci": "pnpm run test:unit && pnpm run test:mutation && pnpm run test:e2e",
+    "test:unit": "pnpm run test",
     "tsc": "tsc",
     "prepare": "is-ci || husky install"
   },
@@ -55,6 +56,7 @@
     "@typescript-eslint/parser": "8.17.0",
     "babel-loader": "9.2.1",
     "babel-plugin-module-resolver": "5.0.2",
+    "cspell": "8.16.1",
     "cypress": "13.16.1",
     "eslint": "9.16.0",
     "eslint-config-prettier": "9.1.0",