splitDiagrams #4110
Merged
splitDiagrams #4110
Conversation
This file contains 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
* develop: (233 commits)
style(docs): use `github-dark` hightlight theme
refactor(docs): use default vitepress highlighter
fix: Move redirection to router
ci(renovate): disable pinning dependencies
Revert "chore(deps): pin dependencies"
change shiki getHighlighter import
create separate spec for stateRenderer-v2
diagramStates should not be global; pass it into functions; minor comment fixes
diagramClasses no longer needs to be cached; mermaidAPI no longer calls it repeatedly
(minor) import expectTypeOf in spec
(minor) fix JSdoc tag
+ spec stateRenderer-v2.js getClasses() to verify it returns a {}
(minor) fix JSdoc types in comments
(minor) add comments, remove duplicated line
chore: Add master to link checker
chore: Add docs to redirect.ts
stateDB classes must be a {} not []
feat: Redirect old documentation links.
add stateDiagram-v2 to list of graphs with classDefs
fix(docs): ClassDiagram table
...
* sidv/sizeCheck: feat: Add size inspection plugin
* sidv/viz: feat: Add package visualization Ignore stats.html feat: Add bundle visualization
lodash with specific imports use lesser space than lodash-es
* develop: (79 commits) Minor change feat: Add @include support to docs feat: Add @include example to docs feat: Add @include support to docs cleanup fix lines fix Async rendering Revert "sync" chore(deps): update pnpm to v7.17.1 chore(deps): remove dependency on `graphlib` test(e2e): make gitgraph snapshots consistent chore: Fix lint test: Update vitest Add official vim plugin to list in integrations chore: Cleanup package.json chore: Cleanup package.json chore: Cleanup package.json fix lock Docs Fix: array concat ...
* release/10.0.0: (333 commits) 10.0.0-rc.3 Export more types no side effects 10.0.0-rc.2 skip failing elk test Cleanup Update docs fix(#3406, #3394): Remove init & initThrowsErrors chore: Rename lazy loaded diagram definitions Skip flowchart-elk failing test Fix docs fix Server Fix lint Remove Readme Fix E2E Tests Fix tests feat: Break render and parse types chore: Remove all non async render/parse/init Remove CJS builds from docs chore: Remove cjs from build ...
* release/10.0.0: Skip all elk tests as it's flaky
* release/10.0.0: Skip elk
* release/10.0.0: Cleanup
sidharthv96
requested review from
aloisklink,
knsv,
pbrolin47,
ashishjain0512 and
jgreywolf
pbrolin47
reviewed
Feb 20, 2023
| registerDiagram(id, diagram, detector); | ||
| } catch (err) { | ||
| // Remove failed diagram from detectors | ||
| log.error(`Failed to load external diagram with key ${key}. Remozing from detectors.`); |
There was a problem hiding this comment.
Minor typo. Change 'Remozing from detectors' to 'Removing from detectors'
pbrolin47
reviewed
Feb 20, 2023
| export const c4Detector: DiagramDetector = (txt) => { | ||
| const id = 'c4'; | ||
|
|
||
| const detector = (txt: string) => { |
There was a problem hiding this comment.
It seems the majority of other diagram detectors have a declaration "const detector: DiagramDetector = ...",
but in this file the detector type is not present. It's only declared as "const detector = ..."
pbrolin47
reviewed
Feb 20, 2023
| import erRenderer from './erRenderer'; | ||
| import erStyles from './styles'; | ||
|
|
||
| export const diagram = { |
There was a problem hiding this comment.
Maybe add type definition "DiagramDefinition" as "export const diagram: DiagramDefinition = {"
pbrolin47
reviewed
Feb 20, 2023
| import { MermaidConfig } from '../../config.type'; | ||
| import { setConfig } from '../../config'; | ||
|
|
||
| export const diagram = { |
There was a problem hiding this comment.
Maybe add type definition "DiagramDefinition" as "export const diagram: DiagramDefinition = {"
pbrolin47
reviewed
Feb 20, 2023
| import flowStyles from './styles'; | ||
| import { MermaidConfig } from '../../config.type'; | ||
|
|
||
| export const diagram = { |
There was a problem hiding this comment.
Maybe add type definition "DiagramDefinition" as "export const diagram: DiagramDefinition = {"
aloisklink
reviewed
Feb 23, 2023
There was a problem hiding this comment.
Looks good to me!
Two quick questions:
- Are we still publishing a giant
mermaid.esm.min.mjsbundle that has everything in a single-file (i.e. without any lazy-loading)?
I know there's still quite a few people that just copy a single filemermaid.min.jsfile to their projects (e.g. this is what joplin does, see https://github.com/laurent22/joplin/tree/dev/packages/renderer/assets/mermaid).
(Themermaid-cliproject used to do the same thing, but we recently had to switch to usingviteto get mermaid-mindmaps working). - We should probably document this change as a BREAKING CHANGE in our release notes too. I think pretty much every bundler should support
lazyLoading, but just in case, we should document it.
Plus, this might also affect people using websites in offline mode, e.g. in PWA, as lazy-loading probably needs internet connection.
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
Splits all diagrams into lazy loaded modules.
📏 Design Decisions
Mermaid will only load whichever diagram is being used.
📋 Tasks
Make sure you
developbranch