Fix GitHub Actions + add spell-check (#57)

Author: seladb

.cspell.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "dictionaries": ["startrack-js"],
+  "dictionaryDefinitions": [
+    {
+      "name": "startrack-js",
+      "path": "./dictionary.txt"
+    }
+  ]
+}

.github/workflows/test-deploy.yml

@@ -20,9 +20,11 @@ jobs:
       - name: Install packages
         run: yarn install
       - name: Format
-        run: yarn run format
+        run: yarn run format:check
       - name: Lint
         run: yarn run lint
+      - name: Spell check
+        run: yarn run spellcheck
       - name: Test build
         run: yarn run build
       - name: Run tests

dictionary.txt

@@ -0,0 +1,21 @@
+seladb
+startrack
+pcapplusplus
+Overridable
+testid
+plotly
+Relayout
+xaxis
+yaxis
+modebar
+hovertemplate
+hoverlabel
+showlegend
+autorange
+fixedrange
+Formik
+datagrid
+camelcase
+slugified
+TTFB
+octicon

package.json

@@ -39,7 +39,9 @@
     "eject": "react-scripts eject",
     "lint": "eslint --ext js,jsx,ts,tsx src/",
     "lint:fix": "eslint --ext js,jsx,ts,tsx --fix src/",
-    "format": "prettier --write . --config ./.prettierrc"
+    "format": "prettier --write . --config ./.prettierrc",
+    "format:check": "prettier --check . --config ./.prettierrc",
+    "spellcheck": "cspell **/*.{ts,tsx}"
   },
   "jest": {
     "transformIgnorePatterns": [
@@ -69,6 +71,7 @@
     "@types/react-plotly.js": "^2.6.0",
     "@typescript-eslint/eslint-plugin": "^5.50.0",
     "@typescript-eslint/parser": "^5.50.0",
+    "cspell": "^8.3.2",
     "eslint": "^8.33.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-prettier": "^4.2.1",

src/components/GitHubAuth/GitHubAuthForm.tsx

@@ -1,3 +1,5 @@
+// cspell: ignore aren
+
 import {
   Button,
   Dialog,

src/utils/GitHubUtils.ts

@@ -7,7 +7,7 @@ const stargazersURL =
 const validateAccessTokenURL = "https://api.github.com/user";
 const repoUrlTemplate = "https://github.com/{user}/{repo}";
 
-export const storageKey = "statrack_js_access_token";
+export const storageKey = "startrack_js_access_token";
 
 const maxSupportedPagesWithoutAccessToken = 30;
 

src/utils/StringUtils.test.ts

@@ -1,3 +1,5 @@
+// cSpell:ignore capitalletters, specialchars
+
 import { slugify } from "./StringUtils";
 
 describe(slugify, () => {