feat: Add diagramType to RenderResult and ParseResult #5118
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
sidharthv96
commented
Dec 6, 2023
sidharthv96
requested review from
aloisklink,
jgreywolf,
nirname,
knsv and
Yokozuna59
sidharthv96
added
Type: Enhancement
aloisklink
reviewed
Dec 7, 2023
There was a problem hiding this comment.
Two things:
- I'd like the
| falseto be moved out of theParseResulttype and instead into the ReturnType ofparse(), since that will make it easier to work with. - Please add a
!into the PR title, e.g.feat!: my description, to further emphasise that there is a breaking change. I'd even recommend changing the name of this PR to something like:feat!: change `parse()` to return object on valid diagramsto make it more obvious that there is a breaking change, and what it is.
Other than that, this PR looks good to me!
Co-authored-by: Alois Klink <alois@aloisklink.com>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## next #5118 +/- ##
=======================================
Coverage 44.50% 44.50%
=======================================
Files 25 25
Lines 5206 5206
Branches 25 25
=======================================
Hits 2317 2317
Misses 2888 2888
Partials 1 1
Flags with carried forward coverage won't be shown. Click here to find out more. |
* next: chore: Fix import.meta.vitest warnings Update docs Update NiceGuy.io links in integrations-community.md
Co-authored-by: Alois Klink <alois@mermaidchart.com>
into sidv/diagramType * 'sidv/diagramType' of https://github.com/mermaid-js/mermaid: Update docs Update packages/mermaid/src/docs/config/usage.md
aloisklink
approved these changes
Dec 8, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
This allows users to get the type of the diagram without calling an extra function.
Resolves #5117
📏 Design Decisions
The return type of
parsechanges, so it is a breaking change. We decided that keeping the return type non-homogeneous is the best option in terms of forward and backwards compatibility.renderonly has an additional parameter to the return type, so it is unlikely to cause issues.📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.nextbranch