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

Feature/5950 Architecture: Icon loading in config #6211

Draft
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

FelixMarcus
Copy link

📑 Summary

Adding option to load architecture diagram icons via the config using URLs. This enables icon loading when not using the full renderer (e.g. when using the Live Editor or CLI).

Resolves #5950

📏 Design Decisions

  • Adding option to register icons by providing only a URL (using inline async loader)
  • Adding a new option in the architecture diagram config that takes array of UrlIconLoader parameters (defaults to empty array), loads all icons as defined
  • This allows loading of icons in config without the need to write code in yaml (following the same paradigm as outlined already in the docs)

📋 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 Jan 22, 2025

⚠️ No Changeset found

Latest commit: 927bfd1

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

@github-actions github-actions bot added the Type: Enhancement New feature or request label Jan 22, 2025
Copy link

netlify bot commented Jan 22, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 927bfd1
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/67914bd7c7011e0008baff39
😎 Deploy Preview https://deploy-preview-6211--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 Jan 22, 2025

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6211
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6211
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6211
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6211

commit: 927bfd1

Copy link

codecov bot commented Jan 22, 2025

Codecov Report

Attention: Patch coverage is 28.00000% with 54 lines in your changes missing coverage. Please review.

Project coverage is 4.49%. Comparing base (e9e663f) to head (927bfd1).

Files with missing lines Patch % Lines
packages/mermaid/src/preprocess.ts 0.00% 23 Missing ⚠️
.../src/diagrams/architecture/architectureRenderer.ts 0.00% 18 Missing ⚠️
packages/mermaid/src/rendering-util/icons.ts 0.00% 9 Missing ⚠️
...id/src/diagrams/architecture/architectureParser.ts 0.00% 2 Missing ⚠️
...aid/src/diagrams/architecture/architectureTypes.ts 0.00% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #6211      +/-   ##
==========================================
+ Coverage     4.47%   4.49%   +0.01%     
==========================================
  Files          385     384       -1     
  Lines        54180   54216      +36     
  Branches       598     624      +26     
==========================================
+ Hits          2425    2436      +11     
- Misses       51755   51780      +25     
Flag Coverage Δ
unit 4.49% <28.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/src/defaultConfig.ts 47.51% <100.00%> (+2.13%) ⬆️
...ermaid/src/diagrams/architecture/architectureDb.ts 0.00% <ø> (ø)
packages/mermaid/src/utils.ts 41.81% <100.00%> (ø)
packages/mermaid/src/utils/sanitizeDirective.ts 13.25% <ø> (+0.15%) ⬆️
...id/src/diagrams/architecture/architectureParser.ts 0.00% <0.00%> (ø)
...aid/src/diagrams/architecture/architectureTypes.ts 0.00% <0.00%> (ø)
packages/mermaid/src/rendering-util/icons.ts 0.00% <0.00%> (ø)
.../src/diagrams/architecture/architectureRenderer.ts 0.00% <0.00%> (ø)
packages/mermaid/src/preprocess.ts 0.00% <0.00%> (ø)

... and 1 file with indirect coverage changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Enhancement New feature or request
Projects
None yet
1 participant