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.

Sign up for GitHub

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

Jump to bottom

Refactor shapes definition #5923

Merged
merged 11 commits into from
Oct 9, 2024
Merged

Refactor shapes definition #5923

merged 11 commits into from
Oct 9, 2024

Conversation

sidharthv96
Copy link
Member

📑 Summary

Organizes the shapes definition, so that we can utilize it better.

📏 Design Decisions

The new structure allows us to have a single source of truth for the shape data. This can be used to auto generate documentation, tests etc.

📋 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:.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Oct 3, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 29b9d30

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

@netlify Netlify
Copy link

netlify bot commented Oct 3, 2024 •
edited
Loading

✅ Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 29b9d30
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/67050d52912a3d000879a369
😎 Deploy Preview https://deploy-preview-5923--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.

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Oct 3, 2024 •
edited
Loading

Open in Stackblitz

pnpm add https://pkg.pr.new/mermaid-js/mermaid@5923

pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@5923

pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@5923

pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@5923

commit: 29b9d30

@argos-ci Argos CI
Copy link

argos-ci bot commented Oct 3, 2024 •
edited
Loading

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

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Oct 8, 2024, 10:53 AM

@codecov Codecov
Copy link

codecov bot commented Oct 3, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 0% with 523 lines in your changes missing coverage. Please review.

Project coverage is 4.65%. Comparing base (c38d9a6) to head (29b9d30).
Report is 12 commits behind head on develop.

Files with missing lines Patch % Lines
...id/src/rendering-util/rendering-elements/shapes.ts 0.00% 481 Missing ⚠️
...aid/src/rendering-util/rendering-elements/nodes.js 0.00% 8 Missing ⚠️
...rendering-util/rendering-elements/shapes/anchor.ts 0.00% 1 Missing ⚠️
...ering-util/rendering-elements/shapes/bowTieRect.ts 0.00% 1 Missing ⚠️
...c/rendering-util/rendering-elements/shapes/card.ts 0.00% 1 Missing ⚠️
...ng-util/rendering-elements/shapes/crossedCircle.ts 0.00% 1 Missing ⚠️
...g-util/rendering-elements/shapes/curlyBraceLeft.ts 0.00% 1 Missing ⚠️
...-util/rendering-elements/shapes/curlyBraceRight.ts 0.00% 1 Missing ⚠️
...ring-util/rendering-elements/shapes/curlyBraces.ts 0.00% 1 Missing ⚠️
...-util/rendering-elements/shapes/curvedTrapezoid.ts 0.00% 1 Missing ⚠️
... and 26 more
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #5923       /-   ##
==========================================
- Coverage     4.67%   4.65%   -0.02%     
==========================================
  Files          373     374        1     
  Lines        51680   51863      183     
  Branches       586     587        1     
==========================================
  Hits          2414    2414              
- Misses       49266   49449      183
Flag Coverage Δ
unit 4.65% <0.00%> (-0.02%) ⬇️

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

Files with missing lines Coverage Δ
...rendering-util/rendering-elements/shapes/anchor.ts 0.00% <0.00%> (ø)
...ering-util/rendering-elements/shapes/bowTieRect.ts 0.00% <0.00%> (ø)
...c/rendering-util/rendering-elements/shapes/card.ts 0.00% <0.00%> (ø)
...ng-util/rendering-elements/shapes/crossedCircle.ts 0.00% <0.00%> (ø)
...g-util/rendering-elements/shapes/curlyBraceLeft.ts 0.00% <0.00%> (ø)
...-util/rendering-elements/shapes/curlyBraceRight.ts 0.00% <0.00%> (ø)
...ring-util/rendering-elements/shapes/curlyBraces.ts 0.00% <0.00%> (ø)
...-util/rendering-elements/shapes/curvedTrapezoid.ts 0.00% <0.00%> (ø)
...ring-util/rendering-elements/shapes/dividedRect.ts 0.00% <0.00%> (ø)
...ndering-util/rendering-elements/shapes/document.ts 0.00% <0.00%> (ø)
... and 26 more

@sidharthv96
Merge branch 'develop' into sidv/refactorShapes
cda48a7 
* develop:
  fix: Hard code handDrawnSeed
@sidharthv96
Merge branch 'develop' into sidv/refactorShapes
e247404 
* develop:
  chore: move handDrawnSeed to mermaidUrl function
@sidharthv96
chore: rebuild
5a3e0cc
aloisklink
aloisklink approved these changes Oct 7, 2024
View reviewed changes
Copy link
Member

@aloisklink aloisklink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! This seems a lot easier to work with!

packages/mermaid/src/rendering-util/rendering-elements/shapes.ts Outdated Show resolved Hide resolved
packages/mermaid/src/rendering-util/rendering-elements/shapes.ts Outdated Show resolved Hide resolved
packages/mermaid/src/rendering-util/rendering-elements/shapes.ts Outdated Show resolved Hide resolved
@sidharthv96 sidharthv96 merged commit 463ba6e into develop Oct 9, 2024
25 checks passed
@sidharthv96 sidharthv96 deleted the sidv/refactorShapes branch October 9, 2024 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@saurabhg772244 saurabhg772244 saurabhg772244 approved these changes

@aloisklink aloisklink aloisklink approved these changes

@omkarht omkarht Awaiting requested review from omkarht

@knsv knsv Awaiting requested review from knsv

@ashishjain0512 ashishjain0512 Awaiting requested review from ashishjain0512

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sidharthv96 @aloisklink @saurabhg772244