Skip to content

run Error Edge Case & run Help Format Correction#7531

Open
MDeacon7843 wants to merge 2 commits intomermaid-js:developfrom
MDeacon7843:develop
Open

run Error Edge Case & run Help Format Correction#7531
MDeacon7843 wants to merge 2 commits intomermaid-js:developfrom
MDeacon7843:develop

Conversation

@MDeacon7843
Copy link
Copy Markdown

@MDeacon7843 MDeacon7843 commented Mar 26, 2026

📑 Summary

Very tiny change to fix both of the issues reported by me.

The run error is fixed by adding run text eol=lf to .gitattributes forcing git to format run in a manner that removes the '\r' (carriage return) that caused the error.

The missing \n in the ./run help command was added.

Resolves #7532

�[1mMERMAID LOCAL DOCKER DEVELOPMENT�[0m

Welcome! Thank you for joining the development.
This is a script for running commands within docker containers at ease.
__________________________________________________________________________________________

Development Quick Start Guide:

�[1m./run pnpm install�[0m           # Install packages
�[1m./run dev�[0m                    # Launch dev server with examples, open http://localhost:9000
�[1m./run docs:dev�[0m               # Launch official website, open http://localhost:3333

�[1m./run pnpm vitest�[0m            # Run watcher for unit tests
�[1m./run cypress�[0m                # Run integration tests (after starting dev server)
�[1m./run pnpm build�[0m             # Prepare it for production
__________________________________________________________________________________________

Commands:

�[1m./run build�[0m                  # Build image
�[1m./run cypress�[0m                # Run integration tests
�[1m./run dev�[0m                    # Run dev server with examples, open http://localhost:9000
�[1m./run docs:dev�[0m               # For docs contributions, open http://localhost:3333
�[1m./run help�[0m                   # Show this help
�[1m./run pnpm�[0m                   # Run any 'pnpm' command
�[1m./run sh�[0m                     # Open 'sh' inside docker container for development
__________________________________________________________________________________________

Examples of frequently used commands:

�[1m./run pnpm add --filter mermaid�[0m �[4mpackage�[0m
        Add package to mermaid

�[1m./run pnpm -w run lint:fix�[0m
        Run prettier and ES lint

�[1mgit diff --name-only develop | xargs ./run pnpm prettier --write�[0m
        Prettify everything you added so far

�[1m./run cypress open --project .�[0m
        Open cypress interactive GUI

�[1m./run cypress run --spec cypress/integration/rendering/�[0m�[4mtest.spec.ts�[0m
        Run specific test in cypress

�[1mxhost +local:�[0m
        Allow local connections for x11 server or
�[1mMERMAID LOCAL DOCKER DEVELOPMENT�[0m

Welcome! Thank you for joining the development.
This is a script for running commands within docker containers at ease.
__________________________________________________________________________________________

Development Quick Start Guide:

�[1m./run pnpm install�[0m           # Install packages
�[1m./run dev�[0m                    # Launch dev server with examples, open http://localhost:9000
�[1m./run docs:dev�[0m               # Launch official website, open http://localhost:3333

�[1m./run pnpm vitest�[0m            # Run watcher for unit tests
�[1m./run cypress�[0m                # Run integration tests (after starting dev server)
�[1m./run pnpm build�[0m             # Prepare it for production
__________________________________________________________________________________________

Commands:

�[1m./run build�[0m                  # Build image
�[1m./run cypress�[0m                # Run integration tests
�[1m./run dev�[0m                    # Run dev server with examples, open http://localhost:9000
�[1m./run docs:dev�[0m               # For docs contributions, open http://localhost:3333
�[1m./run help�[0m                   # Show this help
�[1m./run pnpm�[0m                   # Run any 'pnpm' command
�[1m./run sh�[0m                     # Open 'sh' inside docker container for development
__________________________________________________________________________________________

Examples of frequently used commands:

�[1m./run pnpm add --filter mermaid�[0m �[4mpackage�[0m
        Add package to mermaid

�[1m./run pnpm -w run lint:fix�[0m
        Run prettier and ES lint

�[1mgit diff --name-only develop | xargs ./run pnpm prettier --write�[0m
        Prettify everything you added so far

�[1m./run cypress open --project .�[0m
        Open cypress interactive GUI

�[1m./run cypress run --spec cypress/integration/rendering/�[0m�[4mtest.spec.ts�[0m
        Run specific test in cypress

�[1mxhost +local:�[0m
        Allow local connections for x11 server output
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 26, 2026

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 1be08b6
🔍 Latest deploy log https://app.netlify.com/projects/mermaid-js/deploys/69c59fe0986697000895517d
😎 Deploy Preview https://deploy-preview-7531--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 project configuration.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 26, 2026

⚠️ No Changeset found

Latest commit: 1be08b6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Mar 26, 2026

Open in StackBlitz

@mermaid-js/examples

npm i https://pkg.pr.new/@mermaid-js/examples@7531

mermaid

npm i https://pkg.pr.new/mermaid@7531

@mermaid-js/layout-elk

npm i https://pkg.pr.new/@mermaid-js/layout-elk@7531

@mermaid-js/layout-tidy-tree

npm i https://pkg.pr.new/@mermaid-js/layout-tidy-tree@7531

@mermaid-js/mermaid-zenuml

npm i https://pkg.pr.new/@mermaid-js/mermaid-zenuml@7531

@mermaid-js/parser

npm i https://pkg.pr.new/@mermaid-js/parser@7531

@mermaid-js/tiny

npm i https://pkg.pr.new/@mermaid-js/tiny@7531

commit: 1be08b6

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 3.34%. Comparing base (e9d4c11) to head (1be08b6).
⚠️ Report is 68 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #7531   +/-   ##
=======================================
  Coverage     3.34%   3.34%           
=======================================
  Files          524     524           
  Lines        55256   55256           
  Branches       795     795           
=======================================
  Hits          1850    1850           
  Misses       53406   53406           
Flag Coverage Δ
unit 3.34% <ø> (ø)

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

Edge Case Error in run & Formatting Issue in ./run help Output

1 participant