Update cspell config (#4189)

* Update cspell config Signed-off-by: Ian Maddaus <[email protected]> * update file name in text Signed-off-by: Ian Maddaus <[email protected]> --------- Signed-off-by: Ian Maddaus <[email protected]>
chef · Oct 16, 2023 · 9bbe690 · 9bbe690
1 parent 0e4a3ac
commit 9bbe690
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 54 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -27,8 +27,8 @@ jobs:
           incremental_files_only: true
           inline: error
           strict: true
-          # Path to `cspell.json`
-          config: 'cspell.json'
+          # Path to CSpell config file
+          config: 'cspell.yaml'
   markdownlint:
     runs-on: ubuntu-latest
     steps:

diff --git a/Makefile b/Makefile
@@ -32,7 +32,7 @@ lint: bundle
 ## See:
 ## - https://cspell.org/docs/getting-started/
 ## - https://cspell.org/configuration/
-## - and cspell.json file.
+## - and cspell.yaml file.
 spellcheck:
 	cspell --no-progress "**/*.{md, html, js, yml, yaml, toml, json}"
 

diff --git a/cspell.json b/cspell.json
diff --git a/cspell.yaml b/cspell.yaml
@@ -0,0 +1,49 @@
+---
+# Version of the setting file. Always 0.2
+version: '0.2'
+
+# language - current active spelling language
+language: en_US
+
+dictionaries:
+- chef
+- docs
+
+dictionaryDefinitions:
+- name: chef
+  path: https://raw.githubusercontent.com/chef/chef_dictionary/main/chef.txt
+  description: Custom Chef Dictionary
+- name: docs
+  path: https://raw.githubusercontent.com/chef/chef_dictionary/main/docs.txt
+  description: Custom Docs Dictionary
+
+# 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"
+- archetypes/*.md
+- _vendor/**/*
+- cspell.yaml
+- public/**
+- themes/docs-new/node_modules/**
+- resources/**
+
+# Ignore patterns list
+# https://cspell.org/configuration/patterns/
+ignoreRegExpList:
+  # ignore URLs with predefined pattern - https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/lib/Settings/RegExpPatterns.ts#L3
+- Urls
+  # ignore URLs in a Markdown link
+- "\\]\\([\\w|/|#|\\.|_|\\-]+\\)"
+- "/'s\\b/"
+- "/'d\\b/"
+- "/^\\s*```[\\s\\S]*?^\\s*```/gm"
+- "{{(.+)(?=}})"
+words:
+- Grammarly