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 5747 replace $root with relative paths #5838

Merged
merged 12 commits into from
Sep 9, 2024

Conversation

bollwyvl
Copy link
Contributor

@bollwyvl bollwyvl commented Sep 8, 2024

📑 Summary

  • Replaces references to $root with more verbose (but portable) relative path (e.g. ../../foo.js)
  • Adds pnpm test:check:tsc which builds the tarballs and uses them in a minimal TypeScript project
  • Adds above to CI

Resolves #5747.

Alternative to #5805.

📏 Design Decisions

Mostly see discussion on above-linked items.

vs #5805:

  • By going to relative paths, this also removes a few configuration settings.

📋 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 Sep 8, 2024

🦋 Changeset detected

Latest commit: 1951a0c

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

netlify bot commented Sep 8, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 1951a0c
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/66de75c627514d0008303adc
😎 Deploy Preview https://deploy-preview-5838--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

pkg-pr-new bot commented Sep 8, 2024

Open in Stackblitz

pnpm add https://pkg.pr.new/mermaid-js/mermaid@5838
pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@5838
pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@5838
pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@5838

commit: 1951a0c

Copy link

codecov bot commented Sep 8, 2024

Codecov Report

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

Project coverage is 5.00%. Comparing base (e5aebf3) to head (1951a0c).
Report is 15 commits behind head on develop.

Files with missing lines Patch % Lines
scripts/tsc-check.ts 0.00% 175 Missing ⚠️
...aid/src/rendering-util/rendering-elements/edges.js 0.00% 7 Missing ⚠️
.../src/rendering-util/rendering-elements/clusters.js 0.00% 5 Missing ⚠️
...ng-util/rendering-elements/shapes/rectWithTitle.ts 0.00% 5 Missing ⚠️
packages/mermaid/src/rendering-util/render.ts 0.00% 4 Missing ⚠️
...c/rendering-util/rendering-elements/createLabel.js 0.00% 4 Missing ⚠️
...c/rendering-util/rendering-elements/shapes/util.js 0.00% 4 Missing ⚠️
...kages/mermaid/src/diagrams/architecture/svgDraw.ts 0.00% 3 Missing ⚠️
...rc/rendering-util/rendering-elements/edgeMarker.ts 0.00% 3 Missing ⚠️
...rendering-util/rendering-elements/shapes/choice.ts 0.00% 3 Missing ⚠️
... and 32 more
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #5838      +/-   ##
==========================================
- Coverage     5.01%   5.00%   -0.02%     
==========================================
  Files          336     338       +2     
  Lines        48075   48216     +141     
  Branches       575     551      -24     
==========================================
  Hits          2413    2413              
- Misses       45662   45803     +141     
Flag Coverage Δ
unit 5.00% <0.00%> (-0.02%) ⬇️

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

Files with missing lines Coverage Δ
...aid/src/diagrams/architecture/architectureIcons.ts 0.00% <0.00%> (ø)
.../src/diagrams/architecture/architectureRenderer.ts 0.00% <0.00%> (ø)
packages/mermaid/src/mermaid.ts 0.00% <0.00%> (ø)
packages/mermaid/src/rendering-util/icons.ts 0.00% <0.00%> (ø)
...rc/rendering-util/layout-algorithms/dagre/index.js 0.00% <0.00%> (ø)
...g-util/layout-algorithms/dagre/mermaid-graphlib.js 0.00% <0.00%> (ø)
...d/src/rendering-util/rendering-elements/markers.js 0.00% <0.00%> (ø)
...dering-util/rendering-elements/shapes/labelRect.ts 0.00% <0.00%> (ø)
...ring-util/rendering-elements/shapes/roundedRect.ts 0.00% <0.00%> (ø)
...ering-util/rendering-elements/shapes/squareRect.ts 0.00% <0.00%> (ø)
... and 32 more

... and 1 file with indirect coverage changes

@bollwyvl bollwyvl marked this pull request as ready for review September 8, 2024 17:53
Copy link

argos-ci bot commented Sep 8, 2024

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

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Sep 9, 2024, 4:24 AM

@sidharthv96 sidharthv96 requested a review from knsv September 9, 2024 04:09
@sidharthv96 sidharthv96 added this pull request to the merge queue Sep 9, 2024
Merged via the queue into mermaid-js:develop with commit 750f58d Sep 9, 2024
21 checks passed
@bollwyvl
Copy link
Contributor Author

bollwyvl commented Sep 9, 2024

Thanks!

@bollwyvl bollwyvl deleted the gh-5747-relative-paths branch September 9, 2024 12:12
@github-actions github-actions bot mentioned this pull request Sep 9, 2024
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.

Some typescript import errors around missing files
2 participants