Add Cspell config (#3478)

* Add Cspell config Signed-off-by: kagarmoe <[email protected]> * dictionary definition Signed-off-by: kagarmoe <[email protected]> * Exclude svgs Signed-off-by: kagarmoe <[email protected]> * give dictionary location Signed-off-by: kagarmoe <[email protected]> * remove bad path Signed-off-by: kagarmoe <[email protected]> * ignore vendored Signed-off-by: kagarmoe <[email protected]>
chef · Oct 12, 2021 · ac0701c · ac0701c
1 parent 5a2ad03
commit ac0701c
Showing 1 changed file with 44 additions and 0 deletions.
diff --git a/cspell.json b/cspell.json
@@ -0,0 +1,44 @@
+// cSpell Settings
+{
+  // Version of the setting file.  Always 0.1
+  "version": "0.1",
+  // language - current active spelling language
+  "language": "en",
+  "dictionaryDefinitions": [
+    {
+      "name": "chef",
+      "path": "./chef_dictionary.txt",
+      "description": "Custom Chef Dictionary",
+      "addWords": true
+    }
+  ],
+  "dictionaries": [
+    "chef"
+  ],
+  "locale": ["en-US"],
+  // words - list of words to be always considered correct
+  "words": [
+    "!blacklist",
+    "!whitelist"
+  ],
+  // 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"
+  ],
+  "ignorePaths": [
+    ".expeditor/**/*",
+    "**/*.yml",
+    "**/*.toml",
+    "./_vendor/**/*"
+  ],
+  "ignoreRegExpList": [
+    // Ignore "'s" at the end of a word. If "Chef" is an accepted word, so is "Chef's".
+    "/'s\\b/",
+    // Ignore "'d" at the end of a word. If "dup" is an accepted word, so is "dup'd".
+    "/'d\\b/",
+    // Ignore code blocks
+    "/^\\s*```[\\s\\S]*?^\\s*```/gm"
+  ]
+}