-
Notifications
You must be signed in to change notification settings - Fork 77
spelling warnings
JC Franco edited this page Jan 10, 2025
·
1 revision
We have configured https://www.npmjs.com/package/@cspell/eslint-plugin to help catch typos. This doc covers guidelines to prevent the plugin from impacting workflows.
- If new, valid words are needed, add these to:
-
dict-calcite-design-system
for terms within the Calcite Design System domain. -
dict-cspell-pending-upstream
for terms belonging to an existingcspell
dictionary. Submit a PR to add the words.- Once a PR is accepted and a package is updated, remove the local entry and rely on the updated package or add a new one to our
cspell
config file.
- Once a PR is accepted and a package is updated, remove the local entry and rely on the updated package or add a new one to our
-
dict-calcite-design-system-examples
for terms not covered above but needed for examples (avoid this option whenever possible).
-
- For dynamic terms, add a pattern to our
cspell
config file. - For cases like hex color strings, where neither adding a word nor handling it dynamically is feasible, disable the rule for the line and include an explainer.
- Use hyphens for compound words (e.g.,
grand-grandchild
instead ofgrandgrandchild
). - For random or long text, use sequential letters (e.g.,
abcdefg
instead ofasdfjkl
). - For long blocks of text, use standard lorem ipsum or long sentences.