fix: hookup cspell and eslint for lint-staged (#16)

* fix: hookup cspell and eslint for lint-staged * Update README.md
webex · Aug 18, 2021 · ad42e8b · ad42e8b
1 parent 3f95e59
commit ad42e8b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -8,3 +8,7 @@ Handles the WebRTC core functionality.
 1. Run `yarn dev:bootstrap`
 1. Run `yarn dev`
 1. Open http://localhost:3000/
+
+## Usage
+
+This library uses [cspell](https://github.com/streetsidesoftware/cspell) to check spelling throughout the codebase. Any words that need to be ignored (e.g., package names, protocols, etc.), should be added to the `ignoreWords` field in the [cpsell.json](./cspell.json) configuration file.
diff --git a/package.json b/package.json
@@ -74,7 +74,8 @@
   "lint-staged": {
     "*.ts": [
       "prettier --write",
-      "eslint"
+      "eslint --max-warnings=0",
+      "cspell"
     ]
   },
   "engines": {