feat: add support for outputting a mermaid flowchart of the kind graph #834
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
bhearsum
force-pushed
the
push-vwkrzvoxstlu
branch
from
6ee9b63 to
4f5c045
Compare
ahal
approved these changes
Oct 23, 2025
| """ | ||
| The dependency graph of kinds. | ||
| @type: Graph |
Collaborator
There was a problem hiding this comment.
I was going to comment that this isn't following the standard docstring format we do everywhere else (e.g), but then noticed we do use this above. We should make this consistent across the repo, but for now I agree it's better to be consistent within the file.
Especially in repositories with large graphs, it can be useful to visualize the relationship between the various kinds. I looked at directly outputting svg files of the graphs here, but decided against it because rendering mermaid diagrams requires a browser or puppeteer AFAICT; and I don't want to add that dependency. I also looked at adding support for visualizing entire graphs, but those quickly get very unwieldy and I decided against it. (This might be useful in conjunction with a new `--target-task` option, but that's more than I'm willing to take on at this time.)
bhearsum
force-pushed
the
push-vwkrzvoxstlu
branch
from
4f5c045 to
5bdd30c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Especially in repositories with large graphs, it can be useful to visualize the relationship between the various kinds.
I looked at directly outputting svg files of the graphs here, but decided against it because rendering mermaid diagrams requires a browser or puppeteer AFAICT; and I don't want to add that dependency.
I also looked at adding support for visualizing entire graphs, but those quickly get very unwieldy and I decided against it. (This might be useful in conjunction with a new
--target-taskoption, but that's more than I'm willing to take on at this time.)