Cleanup prior to making logic changes #6041

jgreywolf · 2024-11-08T21:56:53Z

📑 Summary

This PR is for small cleanup to code before making larger changes to address multiple issues related to class diagrams.
Ensure consistent naming between documentation and code, and remove an unnecessary function

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

… unnecessary function

changeset-bot · 2024-11-08T21:56:56Z

⚠️ No Changeset found

Latest commit: 53bb6ef

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 · 2024-11-08T21:57:08Z

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	`53bb6ef`
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/6734b506909dca0008db400d
😎 Deploy Preview	https://deploy-preview-6041--mermaid-js.netlify.app
📱 Preview on mobile	Toggle 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 · 2024-11-08T21:58:06Z

Open in Stackblitz

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

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

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

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

commit: 53bb6ef

codecov · 2024-11-08T21:59:39Z

Codecov Report

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

Project coverage is 4.49%. Comparing base (c8ce416) to head (53bb6ef).

Files with missing lines	Patch %	Lines
packages/mermaid/src/diagrams/class/classDb.ts	0.00%	45 Missing ⚠️
packages/mermaid/src/diagrams/class/svgDraw.js	0.00%	16 Missing ⚠️
...ndering-util/rendering-elements/shapes/classBox.ts	0.00%	14 Missing ⚠️
packages/mermaid/src/diagrams/class/shapeUtil.ts	0.00%	11 Missing ⚠️
packages/mermaid/src/dagre-wrapper/nodes.js	0.00%	9 Missing ⚠️
packages/mermaid/src/diagrams/class/classTypes.ts	0.00%	4 Missing ⚠️
packages/mermaid-layout-elk/src/render.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           develop   #6041   +/-   ##
=======================================
  Coverage     4.49%   4.49%           
=======================================
  Files          383     383           
  Lines        53925   53910   -15     
  Branches       596     596           
=======================================
  Hits          2425    2425           
+ Misses       51500   51485   -15

Flag	Coverage Δ
unit	`4.49% <0.00%> (+<0.01%)`	⬆️

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

Files with missing lines	Coverage Δ
packages/mermaid-layout-elk/src/render.ts	`0.00% <0.00%> (ø)`
packages/mermaid/src/diagrams/class/classTypes.ts	`0.00% <0.00%> (ø)`
packages/mermaid/src/dagre-wrapper/nodes.js	`0.00% <0.00%> (ø)`
packages/mermaid/src/diagrams/class/shapeUtil.ts	`0.00% <0.00%> (ø)`
...ndering-util/rendering-elements/shapes/classBox.ts	`0.00% <0.00%> (ø)`
packages/mermaid/src/diagrams/class/svgDraw.js	`0.00% <0.00%> (ø)`
packages/mermaid/src/diagrams/class/classDb.ts	`0.00% <0.00%> (ø)`

argos-ci · 2024-11-08T22:03:55Z

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

Build	Status	Details	Updated (UTC)
default (Inspect)	⚠️ Changes detected (Review)	7 changed, 343 added, 343 removed	Nov 13, 2024, 2:34 PM

jgreywolf · 2024-11-11T19:37:19Z

@sidharthv96 @ashishjain0512 Can one of you please review? I would like to get this in place before I work on all of the pending classDiagram issues

packages/mermaid/src/diagrams/class/classDb.ts

sidharthv96 · 2024-11-12T05:32:45Z

packages/mermaid/src/diagrams/class/classTypes.ts

-  members: ClassMember[];
+  attributes: ClassMember[];


This change needs to be documented in a changeset. I'm not really sure if we should consider this as breaking or not, but it should atleast be a minor version bump. @aloisklink wdyt?

I don't see why it should be documented in a changeset.

Are we exposing the class types externally to any users of Mermaid?

The only thing I can exported that is potentially risky is the InternalHelpers type:

mermaid/packages/mermaid/src/internals.ts

Line 33 in 037ba2f

export type InternalHelpers = typeof internalHelpers;

, which looks to be used by the @mermaid-js/layout-elk package:

mermaid/packages/mermaid/src/internals.ts

Lines 15 to 33 in 037ba2f

/**

* Internal helpers for mermaid

* @deprecated - This should not be used by external packages, as the definitions will change without notice.

*/

export const internalHelpers = {

common,

getConfig,

insertCluster,

insertEdge,

insertEdgeLabel,

insertMarkers,

insertNode,

interpolateToCurve,

labelHelper,

log,

positionEdgeLabel,

};

export type InternalHelpers = typeof internalHelpers;

But it doesn't look like this ClassNode is being exported anywhere.

Although we are not exporting it, it's being used by others like excalidraw. So it's good to be documented in the changelog.

Ah, we are exporting it, just not via the import XXX from 'mermaid'; entry-point.

We should probably ban import type XXX from 'mermaid/dist/xxxxx' by removing this line in our package.json:

mermaid/packages/mermaid/package.json

Line 14 in d4e5acc

"./*": "./*"

(although this will be a breaking change), as otherwise every future change in the internal types will be a breaking change.

Maybe we can create a separate entry-point like import type XXX from 'mermaid/internal-types' where all these types are explicitly marked as not covered by SemVer and may change even between patch releases?

Or we could use something like https://api-extractor.com/ to mark types as @alpha/@beta/@internal and warn us about breaking changes to the types automatically.

Should it? Agree with Alois that internal names should not be an issue that causes a version bump.

Co-authored-by: Sidharth Vinod <[email protected]>

Ensure consistent naming between documentation and code, also removed…

afaf528

… unnecessary function

jgreywolf requested review from sidharthv96 and yari-dewalt November 8, 2024 21:56

github-actions bot added the Type: Other Not an enhancement or a bug label Nov 8, 2024

Update string assignment

3efe563

sidharthv96 approved these changes Nov 12, 2024

View reviewed changes

packages/mermaid/src/diagrams/class/classDb.ts Outdated Show resolved Hide resolved

packages/mermaid/src/diagrams/class/classDb.ts Outdated Show resolved Hide resolved

sidharthv96 reviewed Nov 12, 2024

View reviewed changes

jgreywolf and others added 2 commits November 13, 2024 06:17

Update packages/mermaid/src/diagrams/class/classDb.ts

4bbf5f0

Co-authored-by: Sidharth Vinod <[email protected]>

Update packages/mermaid/src/diagrams/class/classDb.ts

53bb6ef

Co-authored-by: Sidharth Vinod <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cleanup prior to making logic changes #6041

Cleanup prior to making logic changes #6041

jgreywolf commented Nov 8, 2024

changeset-bot bot commented Nov 8, 2024 •

edited

Loading

netlify bot commented Nov 8, 2024 •

edited

Loading

pkg-pr-new bot commented Nov 8, 2024 •

edited

Loading

codecov bot commented Nov 8, 2024 •

edited

Loading

argos-ci bot commented Nov 8, 2024 •

edited

Loading

jgreywolf commented Nov 11, 2024

sidharthv96 Nov 12, 2024

aloisklink Nov 12, 2024

sidharthv96 Nov 12, 2024

aloisklink Nov 12, 2024

jgreywolf Nov 13, 2024

	/**
	* Internal helpers for mermaid
	* @deprecated - This should not be used by external packages, as the definitions will change without notice.
	*/
	export const internalHelpers = {
	common,
	getConfig,
	insertCluster,
	insertEdge,
	insertEdgeLabel,
	insertMarkers,
	insertNode,
	interpolateToCurve,
	labelHelper,
	log,
	positionEdgeLabel,
	};

	export type InternalHelpers = typeof internalHelpers;

Cleanup prior to making logic changes #6041

Are you sure you want to change the base?

Cleanup prior to making logic changes #6041

Conversation

jgreywolf commented Nov 8, 2024

📑 Summary

📋 Tasks

changeset-bot bot commented Nov 8, 2024 • edited Loading

⚠️ No Changeset found

netlify bot commented Nov 8, 2024 • edited Loading

✅ Deploy Preview for mermaid-js ready!

pkg-pr-new bot commented Nov 8, 2024 • edited Loading

codecov bot commented Nov 8, 2024 • edited Loading

Codecov Report

argos-ci bot commented Nov 8, 2024 • edited Loading

jgreywolf commented Nov 11, 2024

sidharthv96 Nov 12, 2024

Choose a reason for hiding this comment

aloisklink Nov 12, 2024

Choose a reason for hiding this comment

sidharthv96 Nov 12, 2024

Choose a reason for hiding this comment

aloisklink Nov 12, 2024

Choose a reason for hiding this comment

jgreywolf Nov 13, 2024

Choose a reason for hiding this comment

changeset-bot bot commented Nov 8, 2024 •

edited

Loading

netlify bot commented Nov 8, 2024 •

edited

Loading

pkg-pr-new bot commented Nov 8, 2024 •

edited

Loading

codecov bot commented Nov 8, 2024 •

edited

Loading

argos-ci bot commented Nov 8, 2024 •

edited

Loading