-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: Update CSpell configuration #5286
Conversation
- covert `cSpell.json` to `cspell.config.yaml` - break up the word list into multiple dictionary files - fix spelling issues - Enable spell checking code for non-test files
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## develop #5286 +/- ##
========================================
Coverage 79.14% 79.15%
========================================
Files 175 175
Lines 14512 14514 +2
Branches 866 866
========================================
+ Hits 11486 11488 +2
Misses 2823 2823
Partials 203 203
Flags with carried forward coverage won't be shown. Click here to find out more.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks excellent to me.
Must've taken a solid chunk of effort!
@knsv @aloisklink @nirname we should do a quick review and merge it ASAP to avoid conflicts.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks amazing!!!
Stupendous work @Jason3S!
The only thing I'm worried about is the change in
%options easy_keyword_rules |
Co-authored-by: Alois Klink <alois@aloisklink.com>
@Jason3S, Thank you for the contribution! |
📑 Summary
Resolves #5176
cSpell.json
tocspell.config.yaml
for ease of use.cSpell.json
and into separate dictionaries in the./.cspell/
dir.ignoreRegExpList
patterns since they hid spelling issues.fixCSpell.ts
to sort the dictionary files:./.cspell/*.txt
.📏 Design Decisions
Since the code base was in pretty good shape, there wasn't a lot of changes or fixes that were needed. Most of the work was adding words to the various dictionaries.
Dictionaries
code-terms
- For code related terms likeloglevel
mermaid-terms
- For Mermaid related terms or APIs.contributors
- For the names of contributors mentioned in the code or documentation.3rd-party-terms
- For terms from third party libraries.misc
- For things that didn't really belong in any of the above.There should be NO functional changes to Mermaid.
📋 Tasks
Make sure you
Functionality should not have changed.
MERMAID_RELEASE_VERSION
is used for all new features.develop
branch