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

feat: JSON format representation of diagram is returned in render fun… #6095

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

dhananjaydeshmukhperforce

📑 Summary

Intention of this PR is to export json format representation of mermaid diagram.

This PR supports JSON format representation for following types of diagrams

  1. Class Diagram
  2. ER Diagram
  3. Flowchart Diagram
  4. Sequence Diagram
  5. State Diagram

Resolves

https://github.com/orgs/mermaid-js/discussions/6094

Copy link

changeset-bot bot commented Nov 28, 2024

⚠️ No Changeset found

Latest commit: a0c4d34

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

@github-actions github-actions bot added the Type: Enhancement New feature or request label Nov 28, 2024
Copy link

netlify bot commented Nov 28, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit a0c4d34
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/67480cee49a48400087d5331
😎 Deploy Preview https://deploy-preview-6095--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 28, 2024

Open in Stackblitz

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

commit: a0c4d34

Copy link

codecov bot commented Nov 28, 2024

Codecov Report

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

Project coverage is 4.48%. Comparing base (df636c6) to head (a0c4d34).

Files with missing lines Patch % Lines
packages/mermaid/src/Diagram.ts 0.00% 11 Missing ⚠️
.../mermaid/src/diagrams/sequence/sequenceRenderer.ts 0.00% 9 Missing ⚠️
packages/mermaid/src/rendering-util/render.ts 0.00% 9 Missing ⚠️
...rc/rendering-util/layout-algorithms/dagre/index.js 0.00% 7 Missing ⚠️
packages/mermaid/src/diagrams/er/erRenderer.js 0.00% 5 Missing ⚠️
...ges/mermaid/src/diagrams/class/classRenderer-v2.ts 0.00% 4 Missing ⚠️
packages/mermaid/src/mermaidAPI.ts 0.00% 2 Missing ⚠️
...aid/src/diagrams/class/classRenderer-v3-unified.ts 0.00% 1 Missing ⚠️
.../src/diagrams/flowchart/flowRenderer-v3-unified.ts 0.00% 1 Missing ⚠️
...aid/src/diagrams/state/stateRenderer-v3-unified.ts 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #6095      +/-   ##
==========================================
- Coverage     4.48%   4.48%   -0.01%     
==========================================
  Files          383     383              
  Lines        54038   54078      +40     
  Branches       596     596              
==========================================
  Hits          2425    2425              
- Misses       51613   51653      +40     
Flag Coverage Δ
unit 4.48% <0.00%> (-0.01%) ⬇️

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

Files with missing lines Coverage Δ
...aid/src/diagrams/class/classRenderer-v3-unified.ts 0.00% <0.00%> (ø)
.../src/diagrams/flowchart/flowRenderer-v3-unified.ts 0.00% <0.00%> (ø)
...aid/src/diagrams/state/stateRenderer-v3-unified.ts 0.00% <0.00%> (ø)
packages/mermaid/src/mermaidAPI.ts 0.00% <0.00%> (ø)
...ges/mermaid/src/diagrams/class/classRenderer-v2.ts 0.00% <0.00%> (ø)
packages/mermaid/src/diagrams/er/erRenderer.js 0.00% <0.00%> (ø)
...rc/rendering-util/layout-algorithms/dagre/index.js 0.00% <0.00%> (ø)
.../mermaid/src/diagrams/sequence/sequenceRenderer.ts 0.00% <0.00%> (ø)
packages/mermaid/src/rendering-util/render.ts 0.00% <0.00%> (ø)
packages/mermaid/src/Diagram.ts 0.00% <0.00%> (ø)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant