Add graph command to visualize structure dependencies#142
Draft
Add graph command to visualize structure dependencies#142
graph command to visualize structure dependencies#142Conversation
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
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.
Motivation
folders[].structreferences compose structures so users can reason about nested dependencies, detect missing references, and identify cycles.Description
GraphCommandimplemented instructkit/commands/graph.pythat resolves structure paths, extractsfolders[].structdependencies, detects cycles, and records missing references.--all,--format {text,json,mermaid}, and-s/--structures-path, and hook the command into the main parser viastructkit/main.py.format_json), and Mermaid (format_mermaid) including Mermaid classes for missing references and cycles, and safe node id/label escaping.tests/test_graph_command.pyand update docs (README.md,docs/usage.md,docs/cli-reference.md) with usage examples.Testing
pytest tests/test_graph_command.py, which passed (all tests green).pytest, which passed (163 passed).python -m structkit.main graph --help,python -m structkit.main graph terraform/apps/generic --format mermaid, andpython -m structkit.main graph --all --format json, all producing the expected outputs.Codex Task