fix: use mermaid IFFE instead of bundling mermaid #685
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
Since 9e168fb (refactor: use `vite` to bundle `index.html` code, 2022-11-10), we're bundling mermaid using vite. This allows us to get around CORS issues with importing ESM modules. However, Mermaid v10.9.0 is now much much larger, which is causing issues on slower PCs. Loading the Mermaid IFFE seems to fix this issue. It also means that we can move mermaid to a `'dependencies` instead of a `'devDependencies`, allowing users to update Mermaid without waiting for us to update Mermaid. See: 9e168fb
Bumps [mermaid](https://github.com/mermaid-js/mermaid) from 10.8.0 to 10.9.0. - [Release notes](https://github.com/mermaid-js/mermaid/releases) - [Changelog](https://github.com/mermaid-js/mermaid/blob/develop/CHANGELOG.md) - [Commits](mermaid-js/mermaid@v10.8.0...v10.9.0) --- updated-dependencies: - dependency-name: mermaid dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>
aloisklink
added
bug
|
Thank you :) |
MindaugasLaganeckas
approved these changes
May 6, 2024
|
Sorry it took so long :) I've been pretty busy (and was ill for a while too) recently, and I didn't realize the fix would be so simple! @MindaugasLaganeckas, can you make a v10.9.0 release? I still don't know the release process 馃槅 Mermaid v11 is apparently going to be the next Mermaid release, so I'll hopefully also start working on some breaking changes, like finally upgrading Puppeteer and dropping Node.JS v14 and v16 support. |
|
I will document the release procedure :) Thank you :) |
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
Add support for Mermaid v10.9.0 and KaTeX, by importing the mermaid IFFE, instead of bundling it.
Since 9e168fb, we're bundling mermaid using vite. The main reason was that back then, Mermaid was only offering an ESM version of some libraries, but puppeteer doesn't support importing ESM from
file://URLs, due to CORS errors.Unfortunately, the large size of KaTeX in Mermaid v10.9.0 seems to be somehow breaking
mermaid-clion slow computers.However, Mermaid v10.2.0 added back the IFFE bundle, so we can now use that instead, in a
<script src='file://'>, and we therefore don't need to bundle it.This seems to fix the issue. It also means that we can move
mermaidfromdevDependenciesto adependencies, allowing users to update their mermaid version independently frommermaid-cli!Resolves #680
Closes #663
馃搹 Design Decisions
Describe the way your implementation works or what design decisions you made if applicable.
馃搵 Tasks
Make sure you
masterbranch