6633: Log warning for blocks exceeding column width #6717
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: f683b03 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
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 |
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
@mermaid-js/examples
mermaid
@mermaid-js/layout-elk
@mermaid-js/mermaid-zenuml
@mermaid-js/parser
@mermaid-js/tiny
commit: |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #6717 +/- ##
==========================================
- Coverage 3.70% 3.70% -0.01%
==========================================
Files 454 454
Lines 44724 44736 +12
Branches 707 707
==========================================
Hits 1659 1659
- Misses 43065 43077 +12
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds a validation check to ensure no block’s width exceeds the configured column count and surfaces a clear error when it does.
- Introduces a runtime check in
blockDB.tsthat throws an error if any block’swidthInColumnsexceeds the declared columns. - Adds a unit test in
block.spec.tsto verify the new error is thrown when a block is too wide. - Updates the Changeset to document this bugfix.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| packages/mermaid/src/diagrams/block/parser/block.spec.ts | Adds a test to verify an error is thrown for over-wide blocks |
| packages/mermaid/src/diagrams/block/blockDB.ts | Implements the width-vs-columns validation and throws an error |
| .changeset/ninety-roses-turn.md | Records the patch changeset for this bugfix |
sidharthv96
requested changes
Jul 15, 2025
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
resolved in ac97624 |
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
aloisklink
approved these changes
Jul 18, 2025
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
…://github.com/mermaid-js/mermaid into 6633-Stacking-blocks-renders-unexpected-space
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
This PR introduces a validation check and corresponding warning when a block's width exceeds the configured number of columns.
Currently, blocks that span beyond the available column count cause render unexpected spaces without clear feedback to the user.
Resolves #6633
📏 Design Decisions
Describe the way your implementation works or what design decisions you made if applicable.
📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.