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: Node with text renders by default as Markdown #6087

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

knsv
Copy link
Collaborator

@knsv knsv commented Nov 27, 2024

… text

📑 Summary

Adding differentiation between regular strings and markdown strings.

Resolves #5824 and #6048

📏 Design Decisions

Adding back createLabel for the cases where you do not want markdown text

📋 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 Nov 27, 2024

🦋 Changeset detected

Latest commit: c7880d7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
mermaid Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link

netlify bot commented Nov 27, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit c7880d7
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/67470d74ff52f1000883bf92
😎 Deploy Preview https://deploy-preview-6087--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 Nov 27, 2024

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6087
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6087
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6087
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6087

commit: c7880d7

Copy link

codecov bot commented Nov 27, 2024

Codecov Report

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

Project coverage is 4.48%. Comparing base (65f9b29) to head (c7880d7).
Report is 6 commits behind head on develop.

Files with missing lines Patch % Lines
...c/rendering-util/rendering-elements/shapes/util.ts 0.00% 21 Missing ⚠️
...aid/src/rendering-util/rendering-elements/edges.js 0.00% 10 Missing ⚠️
packages/mermaid/src/diagrams/flowchart/flowDb.ts 0.00% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #6087      +/-   ##
==========================================
- Coverage     4.49%   4.48%   -0.02%     
==========================================
  Files          382     383       +1     
  Lines        53914   54067     +153     
  Branches       621     596      -25     
==========================================
  Hits          2425    2425              
- Misses       51489   51642     +153     
Flag Coverage Δ
unit 4.48% <0.00%> (-0.02%) ⬇️

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

Files with missing lines Coverage Δ
packages/mermaid/src/diagrams/flowchart/flowDb.ts 0.00% <0.00%> (ø)
...aid/src/rendering-util/rendering-elements/edges.js 0.00% <0.00%> (ø)
...c/rendering-util/rendering-elements/shapes/util.ts 0.00% <0.00%> (ø)

... and 4 files with indirect coverage changes

@@ -917,4 +917,24 @@ graph TD
}
);
});
it('68: should be able to string and markdown labels (#5824)', () => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
it('68: should be able to string and markdown labels (#5824)', () => {
it('68: should be able to render string and markdown labels (#5824)', () => {

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.

Bug Flowchart: Node with text renders by default as Markdown
2 participants