No documentation on cspell.json

[GeorgeXCV]

I see cspell.json referenced and I assume it is the config file but no documentation on it in the ReadMe. Where should the file be? How can I exclude words and file directories?

[Jason3S]

This action uses cspell to do the spell checking.

• Getting Started with CSpell | CSpell should be a good place to start.

I suggest creating: .config/cspell.config.yaml. The action will find it.

.config/cspell.config.yaml

ignorePaths: # glob patterns to ignore
  - cspell*.{yaml,json}
  - node_modules
words: # words to add to dictionary
  - MyCompanyName
ignoreWords: # words to ignore, but not suggest
  - todos
flagWords: # words to flag as forbidden with optional suggestions indicated by `->`.
  - blacklist->denylist
  - whitelist->allowlist
  - café->cafe
  - bluelist->greenList
  - Bluelist->GreenList

[Jason3S]

@GeorgeXCV,

You make a good point. An example config in the README would be useful.