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

fix: Allow equals sign in sequenceDiagram labels #6332

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

ajuckel
Copy link

@ajuckel ajuckel commented Feb 26, 2025

📑 Summary

Resolves the issue where equals sign was accidentally disallowed in sequence diagram participants.

Resolves #6171

📏 Design Decisions

Commit e852156 unintentionally changed an escaped hyphen in a regex character class to an escaped left-angle-bracket followed by an un-escaped hyphen. Rather than disallowing <, -, and >, this change inadvertently disallowed characters < through >. Nestled in between < and > in the ASCII characters is =.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Copy link

changeset-bot bot commented Feb 26, 2025

🦋 Changeset detected

Latest commit: 6cc1926

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
mermaid Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

pkg-pr-new bot commented Feb 26, 2025

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6332
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6332
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6332
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6332

commit: 6cc1926

Copy link

netlify bot commented Feb 26, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 6cc1926
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/67c61af8aec8e80008614de1
😎 Deploy Preview https://deploy-preview-6332--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Feb 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 3.88%. Comparing base (bc2bd3d) to head (6cc1926).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #6332   +/-   ##
=======================================
  Coverage     3.88%   3.88%           
=======================================
  Files          398     398           
  Lines        42044   42044           
  Branches       638     638           
=======================================
  Hits          1635    1635           
  Misses       40409   40409           
Flag Coverage Δ
unit 3.88% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link

argos-ci bot commented Feb 26, 2025

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Mar 3, 2025, 9:21 PM

@fleon
Copy link

fleon commented Feb 26, 2025

@sidharthv96 @ashishjain0512 Could either of you please take a look? Looks like a straightforward fix. This is one of the issues that will help us upgrade Mermaid from v10.x to v11.x easily in GitLab: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/171452

@ajuckel ajuckel force-pushed the ajuckel/issue-6171-equals-in-sequence-labels branch from b773fd5 to 6cc1926 Compare March 3, 2025 21:11
@ajuckel ajuckel changed the title Re-enable equal sign in sequence diagram participants fix: Allow equals sign in sequenceDiagram labels Mar 3, 2025
@ajuckel
Copy link
Author

ajuckel commented Mar 3, 2025

@sidharthv96 @ashishjain0512 I've added a changeset, rebased the change on top of latest develop, amended the commit message and PR title to coincide with the changeset. Is there anything else I can do to help get this reviewed and merged? Any concerns from your end that I should address?

Ideally, this PR and #6345 could be merged before the next release. I believe these two PRs would be sufficient to allow GitLab to more easily adopt the 11.x series.

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.

Equal sign "=" no longer valid in participant of sequence diagrams
2 participants