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.

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

Update dependency mermaid to v10 #219

Merged
merged 1 commit into from
Jul 1, 2023
Merged

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 24, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
mermaid 9.4.3 -> 10.2.3 age adoption passing confidence

Release Notes

mermaid-js/mermaid (mermaid)

v10.2.3: 10.2.3

Compare Source

Release Notes

🎉 Thanks to all contributors helping with this release! 🎉

What's Changed

New Contributors

Full Changelog: mermaid-js/mermaid@v10.2.2...v10.2.3

v10.2.2: 10.2.2

Compare Source

What's Changed

Full Changelog: mermaid-js/mermaid@v10.2.1...v10.2.2

v10.2.1: 10.2.1

Compare Source

What's Changed

Bugfixes

Full Changelog: mermaid-js/mermaid@v10.2.0...v10.2.1

v10.2.0: 10.2.0

Compare Source

What's Changed

Features

Bugfixes

Documentation

Chores

🎉 Thanks to all contributors helping with this release! 🎉

New Contributors


Full Changelog: mermaid-js/mermaid@v10.1.0...v10.2.0

Thanks to Mermaid Chart for ongoing support

v10.1.0: 10.1.0

Compare Source

What's Changed

Features

Bugfixes

Documentation

Chores

New Contributors

Full Changelog: mermaid-js/mermaid@v10.0.2...v10.1.0

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.

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), 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.

@github-actions
Copy link

github-actions bot commented Feb 24, 2023

The following packages are updated in the Pull Request.

  • mermaid

The affected CDN links are listed below.

mermaid

CDN Provider Status Integrity
jsdelivr ✅ 200 sha256-JFptYy4KzJ5OQP+Q9fubNf3cxpPPmZKqUOovyEONKrQ=
unpkg ✅ 200 sha256-JFptYy4KzJ5OQP+Q9fubNf3cxpPPmZKqUOovyEONKrQ=
cdnjs ✅ 200 sha256-JFptYy4KzJ5OQP+Q9fubNf3cxpPPmZKqUOovyEONKrQ=

@stevenjoezhang stevenjoezhang marked this pull request as draft March 1, 2023 06:35
@renovate renovate bot force-pushed the renovate/mermaid-10.x branch 3 times, most recently from 5e08d74 to 2cbdf02 Compare March 5, 2023 14:47
@renovate renovate bot force-pushed the renovate/mermaid-10.x branch 2 times, most recently from 836b59a to d80c8fb Compare April 7, 2023 14:16
@stevenjoezhang
Copy link
Member

Breaking: Mermaid is ESM only!

@stevenjoezhang
Copy link
Member

UMD is back again in mermaid-js/mermaid#4281

@stevenjoezhang stevenjoezhang marked this pull request as ready for review June 4, 2023 15:32
@stevenjoezhang stevenjoezhang merged commit 87ae559 into main Jul 1, 2023
@stevenjoezhang stevenjoezhang deleted the renovate/mermaid-10.x branch July 1, 2023 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant