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

Update Requirement diagram to unified renderer #6219

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

Conversation

yari-dewalt
Copy link
Collaborator

@yari-dewalt yari-dewalt commented Jan 24, 2025

📑 Summary

Updates the Requirement diagram to the new unified way of rendering including changes to bring it up to par with other diagrams. Styling and classes are now supported as well as changing the direction of the diagram and the hand drawn look.

  • New requirementBox shape
  • Hand drawn look
  • Direction statement to change the direction of the diagram
  • Styling now supported via the style statement, classDef and class statements, as well as the shorthand syntax.
  • Updated documentation to reflect all new changes

📏 Design Decisions

  • Made the requirementBox shape's behavior match the typical behavior of requirement diagrams. Dynamically sized based off the amount of text and won't show undefined information.

📋 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 Jan 24, 2025

⚠️ No Changeset found

Latest commit: baf3adf

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 Jan 24, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit baf3adf
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/6799040b681be10008c6c64e
😎 Deploy Preview https://deploy-preview-6219--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 Jan 24, 2025

Open in Stackblitz

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

commit: baf3adf

Copy link

codecov bot commented Jan 24, 2025

Codecov Report

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

Project coverage is 4.47%. Comparing base (8dd0e7a) to head (baf3adf).

Files with missing lines Patch % Lines
.../mermaid/src/diagrams/requirement/requirementDb.ts 0.00% 349 Missing ⚠️
...g-util/rendering-elements/shapes/requirementBox.ts 0.00% 222 Missing ⚠️
...d/src/rendering-util/rendering-elements/markers.js 0.00% 39 Missing ⚠️
...id/src/diagrams/requirement/requirementRenderer.ts 0.00% 36 Missing ⚠️
...ackages/mermaid/src/diagrams/requirement/styles.js 0.00% 15 Missing ⚠️
...aid/src/diagrams/requirement/requirementDiagram.ts 0.00% 5 Missing ⚠️
...id/src/rendering-util/rendering-elements/shapes.ts 0.00% 4 Missing ⚠️
...rc/rendering-util/rendering-elements/edgeMarker.ts 0.00% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #6219      +/-   ##
==========================================
- Coverage     4.47%   4.47%   -0.01%     
==========================================
  Files          385     384       -1     
  Lines        54191   54235      +44     
  Branches       598     623      +25     
==========================================
  Hits          2425    2425              
- Misses       51766   51810      +44     
Flag Coverage Δ
unit 4.47% <0.00%> (-0.01%) ⬇️

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

Files with missing lines Coverage Δ
...rc/rendering-util/rendering-elements/edgeMarker.ts 0.00% <0.00%> (ø)
...id/src/rendering-util/rendering-elements/shapes.ts 0.00% <0.00%> (ø)
...aid/src/diagrams/requirement/requirementDiagram.ts 0.00% <0.00%> (ø)
...ackages/mermaid/src/diagrams/requirement/styles.js 0.00% <0.00%> (ø)
...id/src/diagrams/requirement/requirementRenderer.ts 0.00% <0.00%> (ø)
...d/src/rendering-util/rendering-elements/markers.js 0.00% <0.00%> (ø)
...g-util/rendering-elements/shapes/requirementBox.ts 0.00% <0.00%> (ø)
.../mermaid/src/diagrams/requirement/requirementDb.ts 0.00% <0.00%> (ø)

... and 1 file with indirect coverage changes

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