Upgrade Mermaid to 11.17.2 (fixes six advisories in 11.12.x)
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 60/100
- Issue type
- Refactor
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- javascript
Research direction
Start with dev-docs/upgrade-dependencies.md, which describes the vendoring steps. The bundles to replace are mermaid.js and mermaid.min.js in src/resources/formats/html/mermaid/, taken from the unpkg 11.17.2 dist. Render a page with a classDiagram, a C4 diagram and a Gantt chart before and after to check the new renderer. Done means both files are updated and those diagrams still render.
Written by the indexing model from the issue text.
Description
quarto-cli vendors Mermaid 11.12.0 in src/resources/formats/html/mermaid/. Every rendered HTML page that uses Mermaid ships it. Six advisories affect all 11.12.x releases, and they're fixed in 11.14.1 or 11.16.1:
- GHSA-c4c3-pg64-4m4v
- GHSA-6x64-9x62-f2gx
- GHSA-87f9-hvmw-gh4p
- GHSA-xcj9-5m2h-648r
- GHSA-ghcm-xqfw-q4vr
- GHSA-6m6c-36f7-fhxh
They cover config prototype pollution, CSS/classDef and HTML injection, and an infinite loop in Gantt charts. 11.17.2 has none of them.
Proposal: bump to 11.17.2. That would match the VS Code extension, which moved its notebook renderer and its diagram preview to 11.17.2 in quarto-dev/quarto#1189. Both now run ahead of the CLI's Mermaid version.
As in dev-docs/upgrade-dependencies.md, get dist/mermaid.js and dist/mermaid.min.js from https://unpkg.com/[email protected]/ and copy them into src/resources/formats/html/mermaid/.
Things to know about 11.13 to 11.17:
- These releases mostly add syntax (new diagram types and shapes, extra directives), so existing diagrams should keep working.
- One visible change: in 11.17,
classDiagramand C4 diagrams moved to Mermaid's unified (v2) renderer, so they'll look somewhat different. - 11.17 builds no longer embed
name:"mermaid",version:"…"in the bundle. Anything that sniffs the version from the file needs another pattern; the extension's test now matches therenderer.draw(…, "X.Y.Z"literal. mermaid.min.jsgrows from 2.75 MB to 3.57 MB.
- Dominant language
- JavaScript
- Stars
- 6.1k
- Forks
- 466
- Avg merge
- 20h 18m
- Merged PRs (30d)
- 74
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from quarto-dev/quarto-cli
-
accessibility documentation revealjs
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
quarto-dev/quarto-cli#14971 ·
Maintainers usually reply within 1 day
-
accessibility revealjs
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
quarto-dev/quarto-cli#14970 · 1 comment ·
Maintainers usually reply within 1 day
-
accessibility revealjs themes
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
quarto-dev/quarto-cli#14963 ·
Maintainers usually reply within 1 day
-
accessibility revealjs themes
Difficulty 1/5 Under an hour Newbie friendliness 88/100
quarto-dev/quarto-cli#14962 ·
Maintainers usually reply within 1 day
-
accessibility bug revealjs
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
quarto-dev/quarto-cli#14961 ·
Maintainers usually reply within 1 day
All issues in quarto-dev/quarto-cli
Similar issues
-
t0ggles
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
nolimits4web/swiper#8240 · 1 comment ·
-
netbox status: backlog topic: testing type: housekeeping
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
netbox-community/netbox#23395 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
[scanner] check:spelling skips blog/ — posts and author metadata are never spell-checkedPossibly taken @hivecommons-hive claimed this today. Openagent/scanner bug hive/covered-by-pr hive/hosted-available-lke648397-260827-5n31
Difficulty 1/5 Under an hour Newbie friendliness 72/100
cncf/endusers#1452 · 1 comment ·
Maintainers usually reply within 1 day
-
Edit: HTVKey.vnOpenchannels:edit check:passed
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Maintainers usually reply within 6 days