Skip to content
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

Merged
merged 5 commits into from Feb 16, 2024
Merged

Conversation

Jason3S
Copy link
Contributor

@Jason3S Jason3S commented Feb 14, 2024

📑 Summary

Brief description about the content of your PR.

Resolves #5176

  1. Updated CSpell from v6 to v8
  2. Converted cSpell.json to cspell.config.yaml for ease of use.
  3. Moved the words out of cSpell.json and into separate dictionaries in the ./.cspell/ dir.
  4. Removed most of the ignoreRegExpList patterns since they hid spelling issues.
  5. Update fixCSpell.ts to sort the dictionary files: ./.cspell/*.txt.
  6. Enabled the spell checking of variable names and strings for production code.
  7. Enabled the spell checking of code within Markdown files.
  8. Fix spelling issues.

📏 Design Decisions

Describe the way your implementation works or what design decisions you made if applicable.

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

  1. code-terms - For code related terms like loglevel
  2. mermaid-terms - For Mermaid related terms or APIs.
  3. contributors - For the names of contributors mentioned in the code or documentation.
  4. 3rd-party-terms - For terms from third party libraries.
  5. 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

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
    Functionality should not have changed.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🔖 targeted develop branch

- 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
Copy link

netlify bot commented Feb 14, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit e54d090
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/65ce3655af46b70008ada2c3
😎 Deploy Preview https://deploy-preview-5286--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Feb 14, 2024

Codecov Report

Attention: 6 lines in your changes are missing coverage. Please review.

Comparison is base (fe1cff3) 79.14% compared to head (e54d090) 79.15%.

Additional details and impacted files

Impacted file tree graph

@@           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           
Flag Coverage Δ
e2e 84.72% <89.09%> (+<0.01%) ⬆️
unit 43.20% <100.00%> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
packages/mermaid/src/dagre-wrapper/clusters.js 88.67% <ø> (ø)
packages/mermaid/src/dagre-wrapper/createLabel.js 92.85% <ø> (ø)
packages/mermaid/src/dagre-wrapper/edges.js 83.88% <100.00%> (ø)
packages/mermaid/src/dagre-wrapper/index.js 98.90% <100.00%> (ø)
packages/mermaid/src/diagrams/block/layout.ts 88.51% <100.00%> (ø)
packages/mermaid/src/diagrams/c4/c4Renderer.js 86.83% <100.00%> (ø)
packages/mermaid/src/diagrams/c4/svgDraw.js 87.65% <ø> (ø)
packages/mermaid/src/diagrams/flowchart/flowDb.js 81.62% <100.00%> (ø)
.../mermaid/src/diagrams/flowchart/flowRenderer-v2.js 93.58% <100.00%> (ø)
packages/mermaid/src/diagrams/gantt/ganttDb.js 78.35% <100.00%> (+0.02%) ⬆️
... and 14 more

Copy link
Member

@sidharthv96 sidharthv96 left a 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.

packages/mermaid/src/diagrams/c4/c4Db.js Outdated Show resolved Hide resolved
Copy link
Member

@aloisklink aloisklink left a 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

, other than that, I think it's good to merge.

.cspell/misc-terms.txt Outdated Show resolved Hide resolved
packages/mermaid/src/diagrams/sankey/parser/sankey.jison Outdated Show resolved Hide resolved
@sidharthv96 sidharthv96 added this pull request to the merge queue Feb 16, 2024
Merged via the queue into mermaid-js:develop with commit 6be91bc Feb 16, 2024
20 checks passed
Copy link

mermaid-bot bot commented Feb 16, 2024

@Jason3S, Thank you for the contribution!
You are now eligible for a year of Premium account on MermaidChart.
Sign up with your GitHub account to activate.

@Jason3S Jason3S deleted the cspell branch February 16, 2024 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants