Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: update dependency mermaid to v10 #95

Merged
merged 14 commits into from
Apr 18, 2024
Merged

fix: update dependency mermaid to v10 #95

merged 14 commits into from
Apr 18, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 21, 2023 •
edited
Loading

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
mermaid ^8.8.3 -> ^10.0.0 age adoption passing confidence

Release Notes

mermaid-js/mermaid

v10.0.2: 10.0.2

Compare Source

Release Notes

Bugfixes

v10.0.1: 10.0.1

Compare Source

Release Notes

Features

Bugfixes

Documentation

  • docs(flowchart): duplicated hexagon node example by @​Oliboy50
  • add links to NiceGUI integration by @​rodja
  • Adding app (Deepdwn) to integrations list by @​Billiam

Chores

🎉 Thanks to all contributors helping with this release! 🎉

New Contributors

Full Changelog: mermaid-js/mermaid@v10.0.0...v10.0.1

v10.0.0

Compare Source

Mermaid is ESM only!

We've dropped CJS support. So, you will have to update your import scripts as follows.

<script type="module">
  import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs';
  mermaid.initialize({ startOnLoad: true });
</script>

You can keep using v9 by adding the @9 in the CDN URL.

- <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.js"></script>
+ <script src="https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.js"></script>
mermaid.render is async and doesn't accept callbacks
// < v10
mermaid.render('id', 'graph TD;\nA-->B', (svg, bindFunctions) => {
  element.innerHTML = svg;
  if (bindFunctions) {
    bindFunctions(element);
  }
});

// Shorter syntax
if (bindFunctions) {
  bindFunctions(element);
}
// can be replaced with the `?.` shorthand
bindFunctions?.(element);

// >= v10 with async/await
const { svg, bindFunctions } = await mermaid.render('id', 'graph TD;\nA-->B');
element.innerHTML = svg;
bindFunctions?.(element);

// >= v10 with promise.then
mermaid.render('id', 'graph TD;A-->B').then(({ svg, bindFunctions }) => {
  element.innerHTML = svg;
  bindFunctions?.(element);
});
mermaid.parse is async and ParseError is removed
// < v10
mermaid.parse(text, parseError);

//>= v10
await mermaid.parse(text).catch(parseError);
// or
try {
  await mermaid.parse(text);
} catch (err) {
  parseError(err);
}
Init deprecated and InitThrowsErrors removed

The config passed to init was not being used eariler.
It will now be used.
The init function is deprecated and will be removed in the next major release.
init currently works as a wrapper to initialize and run.

// < v10
mermaid.init(config, selector, cb);

//>= v10
mermaid.initialize(config);
mermaid.run({
  querySelector: selector,
  postRenderCallback: cb,
  suppressErrors: true,
});
// < v10
mermaid.initThrowsErrors(config, selector, cb);

//>= v10
mermaid.initialize(config);
mermaid.run({
  querySelector: selector,
  postRenderCallback: cb,
  suppressErrors: false,
});

// TODO: Populate changelog pre v10

  • Config has a lot of changes
  • globalReset resets to defaultConfig instead of current config. Use reset instead.

v9.4.3

Compare Source

Full Changelog: mermaid-js/mermaid@v9.4.2...v9.4.3

Fixes imports for dayjs and cytoscape.

v9.4.2

Compare Source

What's Changed

New Contributors

Full Changelog: mermaid-js/mermaid@v9.4.0...v9.4.2

v9.4.0

Compare Source

What's Changed

Features
Breaking changes
  • Mind map and timeline diagrams are lazy loaded by mermaid. In order to use these diagrams you need to use the renderAsync method of rendering. The @​mermaid-js/mermaid-mindmap package is deprecated by this.
Documentation
Bug Fixes
Chores

New Contributors

Full Changelog: mermaid-js/mermaid@v9.3.0...v9.4.0

v9.3.0

Compare Source

Significant Changes

  • 25% Smaller
  • New docs
  • Replaces the deprecated and vulnerable dagre-d3 with dagre-es

Release Notes

🎉 Thanks to all contributors helping with this release! 🎉

What's Changed

New Contributors

@renovate renovate bot added the maintenance label Feb 21, 2023
@renovate renovate bot force-pushed the renovate/mermaid-10.x branch from 2862e40 to 720b30d Compare March 7, 2023 02:39
@renovate renovate bot force-pushed the renovate/mermaid-10.x branch from 720b30d to b4d63e5 Compare March 18, 2023 13:42
@renovate renovate bot force-pushed the renovate/mermaid-10.x branch from b4d63e5 to 1d549dd Compare April 9, 2023 08:20
@renovate
Copy link
Contributor Author

renovate bot commented May 12, 2023

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠ Warning: custom changes will be lost.

@dword-design dword-design linked an issue May 13, 2023 that may be closed by this pull request
Are you planning to release a v5 with support for the new v10? #174
Closed
@dword-design dword-design merged commit 913232d into master Apr 18, 2024
2 checks passed
@dword-design dword-design deleted the renovate/mermaid-10.x branch April 18, 2024 21:50
github-actions bot pushed a commit that referenced this pull request Apr 18, 2024
@semantic-release-bot
chore: 6.0.0 [skip ci]
879ac10 
# [6.0.0](v5.0.1...v6.0.0) (2024-04-18)

### Bug Fixes

* update dependency mermaid to v10 ([#95](#95)) ([913232d](913232d))

### BREAKING CHANGES

* update dependency mermaid to v10
@github-actions GitHub Actions
Copy link

🎉 This PR is included in version 6.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
maintenance released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Are you planning to release a v5 with support for the new v10?
1 participant
@dword-design