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

Update dependency mermaid to v10 #370

Merged
merged 1 commit into from
May 10, 2023
Merged

Update dependency mermaid to v10 #370

merged 1 commit into from
May 10, 2023

Conversation

renovate[bot]
Copy link
Contributor

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

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
mermaid ^9.2.2 -> ^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

Configuration

📅 Schedule: Branch creation - "every weekend" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot changed the title Update dependency mermaid to v10 Update dependency mermaid to v10 - autoclosed Mar 7, 2023
@renovate renovate bot closed this Mar 7, 2023
@renovate renovate bot deleted the renovate/mermaid-10.x branch March 7, 2023 17:52
@renovate renovate bot changed the title Update dependency mermaid to v10 - autoclosed Update dependency mermaid to v10 Mar 7, 2023
@renovate renovate bot reopened this Mar 7, 2023
@renovate renovate bot restored the renovate/mermaid-10.x branch March 7, 2023 20:52
@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 7, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@onigoetz onigoetz merged commit a130273 into master May 10, 2023
@renovate renovate bot deleted the renovate/mermaid-10.x branch May 10, 2023 11:29
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
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@onigoetz