mermaid dep graph script improvements #2916
Open
Conversation
This file contains hidden or 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
This updates the `mermaid-deptree` script to include the state of a package as a production, development, optional, peer, or optional-peer dependency via link styling and text.
The output now also:
- wraps the output in a Markdown fenced code block
- includes front-matter config for appropriate styling
- includes a word-wrapping fix
Example output:
```mermaid
---
config:
themeVariables:
fontFamily: "Fira Mono,Menlo,Consolas,Liberation Mono,monospace"
---
graph TD
webpackish-app--> |"`_dev_`"| jorts-folder
webpackish-app--> |"`_dev_`"| pantspack
jorts-folder--- |"`_peer_`"| pantspack
pantspack==> pantspack-folder-runner
classDef default white-space:nowrap
```
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.
This updates the
mermaid-deptreescript to include the state of a package as a production, development, optional, peer, or optional-peer dependency via link styling and text.The output now also:
Example output:
--- config: themeVariables: fontFamily: "Fira Mono,Menlo,Consolas,Liberation Mono,monospace" --- graph TD webpackish-app--> |"`_dev_`"| jorts-folder webpackish-app--> |"`_dev_`"| pantspack jorts-folder--- |"`_peer_`"| pantspack pantspack==> pantspack-folder-runner classDef default white-space:nowrapAlso updates the
README.mdfor thefixtures-dynamic-ancestorin@endo/compartment-mapperwith a generated graph.I guess there's no example of "optional peer" in that example. oops