netlify[bot]
commented
1 month ago Deploy Preview for mermaid-js ready!
| Name | Link |
|---|---|
| Latest commit | ea7d28bf1c91fdd0e7cf93dcd67224d3cb29ca23 |
| Latest deploy log | https://app.netlify.com/sites/mermaid-js/deploys/664e38e01000e6000859f9e2 |
| Deploy Preview | https://deploy-preview-5515--mermaid-js.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
codecov[bot]
:bookmark_tabs: Summary
This matches the generated MermaidConfig type with the schema.
Previously, we were removing
requiredto make all fields optional.Now, we're using a PartialMermaidConfig type using PartialDeep instead.
:straight_ruler: Design Decisions
Few alternatives considered.
Use RequiredDeep internally Abandoned, as some types in the schema are actually undefined. So using RequiredDeep will cause runtime errors.
Change all fields inside schema to not have undefined. Abandoned as it'll be a HUGE change, pulling in default values that are scattered throughout the code. This should be done later, and this PR can be considered as the first step to remove unnecessary default variables inside the code. This would also remove the ability of the authors to actually have undefined if they wanted to in the schema.
Match Generated type with Schema, create fully optional type for external use.
Avoids all the problems above, we just need to coerce some test types internally, which is fine, as the test would fail if there are any issues.
Currently, there is a breaking change, that the type names differ. We can switch the names, so that MermaidConfig will be the exported type which has fully partial props.
Didn't do it now, as that would mean a larger diff, making it harder to review.
:clipboard: Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.developbranch