Remove default properties before generating the config types #5126
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. |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## next #5126 +/- ##
=======================================
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. |
sidharthv96
approved these changes
Dec 8, 2023
aloisklink
approved these changes
Dec 8, 2023
|
@diegosogari, Thank you for the contribution! |
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
Currently, some configuration types listed in
packages/mermaid/src/config.type.tsappear duplicated (such asXYChartAxisConfig1andXYChartAxisConfig2). This is caused by an issue on thejson-schema-to-typescriptpackage.This PR addresses the effect of that third-party issue on the generated types.
Resolves #5125
📏 Design Decisions
I added a small routine that recursively removes a given property from the loaded JSON schema. It gets called before generating the TypeScript types, in order to remove the
defaultproperty. This does not affect the default values loaded at run-time, since those values are obtained through the.vite/jsonSchemaPlugin.tsscript.📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.developbranch