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

Fix note non html text #6006

Merged
merged 4 commits into from
Oct 30, 2024
Merged

Conversation

yari-dewalt
Copy link
Collaborator

📑 Summary

Fixes notes (note shape) from displaying non-html rendered text incorrectly. The text is now properly centered and useHtmlLabels now uses the config.useHtmlLabels value instead of the hard coded config.flowchart.useHtmlLabels value as it is a better fit in this case. Also included is a similar change to labelHelper() to use config.useHtmlLabels instead of the flowchart's value. And included a special case for ' characters in markdownToLines() so it doesn't get sanitized into the html character code value as that is common in notes.

📏 Design Decisions

  • I believe using config.useHtmlLabels is more appropriate than config.flowchart.useHtmlLabels in regards to the changes made here and it shouldn't cause any issues, but not fully sure.
  • Don't know if the handling of ' characters is the best way to do it.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Copy link

changeset-bot bot commented Oct 29, 2024

⚠️ No Changeset found

Latest commit: dd42305

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Oct 29, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit dd42305
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/672135d36a4dce0008cf8939
😎 Deploy Preview https://deploy-preview-6006--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

pkg-pr-new bot commented Oct 29, 2024

Open in Stackblitz

pnpm add https://pkg.pr.new/mermaid-js/mermaid@6006
pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6006
pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6006
pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6006

commit: dd42305

Copy link

codecov bot commented Oct 29, 2024

Codecov Report

Attention: Patch coverage is 0% with 8 lines in your changes missing coverage. Please review.

Project coverage is 4.50%. Comparing base (8d0902d) to head (dd42305).
Report is 5 commits behind head on develop.

Files with missing lines Patch % Lines
...c/rendering-util/rendering-elements/shapes/note.ts 0.00% 5 Missing ⚠️
...c/rendering-util/rendering-elements/shapes/util.ts 0.00% 2 Missing ⚠️
...mermaid/src/rendering-util/handle-markdown-text.ts 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #6006      +/-   ##
==========================================
- Coverage     4.50%   4.50%   -0.01%     
==========================================
  Files          383     383              
  Lines        53873   53875       +2     
  Branches       622     622              
==========================================
  Hits          2425    2425              
- Misses       51448   51450       +2     
Flag Coverage Δ
unit 4.50% <0.00%> (-0.01%) ⬇️

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

Files with missing lines Coverage Δ
...mermaid/src/rendering-util/handle-markdown-text.ts 0.00% <0.00%> (ø)
...c/rendering-util/rendering-elements/shapes/util.ts 0.00% <0.00%> (ø)
...c/rendering-util/rendering-elements/shapes/note.ts 0.00% <0.00%> (ø)

@yari-dewalt yari-dewalt marked this pull request as ready for review October 29, 2024 19:20
@knsv knsv merged commit ece3b25 into mermaid-js:develop Oct 30, 2024
13 of 21 checks passed
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.

2 participants