Release/10.0.0 #4108
Release/10.0.0 #4108
Conversation
chore(deps): update dependency vite to v4
* master: (24 commits) docs: fix links Skip precommit hooks on CI Fix release-publish Fix timeline and mindmap Updating integration instructions for timeline and mindmap Remove node heap Revert "chore: Set node heap size" Revert "Remove text hint" Split cytoscape Linear build Remove text hint Fix elk import Dynamic elk import Remove heap option elk web-worker Test publish docs chore: Add file extension for dynamic import chore: Defer elk loading Update vitepress Fix links to integrations.md ...
chore(deps): update dependency cypress to v12
Manually tree shaking import statement of package.json
* develop: Add highlight tag info in contributing.md chore(deps): update dependency cypress to v12 docs: fix links Fix types chore(deps): update dependency vite to v4
fix(api): tree shaking package.json import
Both render and parse are async now. Return type of render contains svg and bindFunctions. Parse will not throw error if parseOptions.silent is passed.
|
Sneakpeek esbuild |
sidharthv96
requested review from
knsv,
aloisklink,
ashishjain0512,
jgreywolf and
pbrolin47
There was a problem hiding this comment.
I probably won't have time for a while to do a full review, but as a temporary review, all the breaking changes look good to me! 🚀
However, I think we need a bit more documentation in V10-BreakingChanges.md
Edit: One potential issue with the migration to ESM is that some projects that use Mermaid are still not on ESM (e.g. docusaurus). This means that we might need to backport security fixes if people are still using v9.x and can't upgrade to v10.
|
|
||
| ## Async | ||
|
|
||
| `parse`, `render` are now async. |
There was a problem hiding this comment.
It might be worth having some examples here, since this is probably one of the most important changes!
There was a problem hiding this comment.
Yes, I'll add documentation soon (with examples and live editor commits for migration)
This file is currently used to keep note of points to elaborate before release.
| @@ -1,5 +1,58 @@ | |||
| # A collection of updates that change the behaviour | |||
| # A collection of updates that change the behavior | |||
|
|
|||
There was a problem hiding this comment.
We need to document that Mermaid is now ESM only.
Ideally we should show some example usage too.
Co-authored-by: Alois Klink <alois@aloisklink.com>
packages/mermaid/src/mermaidAPI.ts
Outdated
| /** | ||
| * @deprecated This is an internal function and should not be used. Will be removed in v10. | ||
| */ | ||
| export interface RenderResult { |
There was a problem hiding this comment.
Maybe move this declaration to top of file?
| try { | ||
| // diag = new Diagram(text); | ||
| diag = getDiagramFromText(text); | ||
| if ('then' in diag) { |
There was a problem hiding this comment.
I noticed that the if('then' in diag) { ... on line 476 on current file is no longer present. Not needed any longer?
There was a problem hiding this comment.
Nope, that was used to check whether it's a promise or not. Now, it'll always be a promise.
Nice catch!
Co-authored-by: Per Brolin <per@mermaidchart.com>
📑 Summary
PSA: Don't get overwhelmed by the files changed.
Most are test changes, as almost all E2E tests and many unit tests had to be modified because the render type changed.
Then there are lots of small import changes.
Only 3 files have significant changes.
Breaking changes planned in v10
mermaid.initis not using theconfigthat's passed. #3406Fixes #3590
Fixes #3577
Fixes #3394
Fixes #3406
Fixes #3055
Optional - Could be pushed to v11 as it's going to be a massive change including diagram rendering code.
📋 Tasks
Make sure you
masterbranch