Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Infer component groupings based on folder structure #3

Open
naturallymitchell opened this issue Oct 17, 2017 · 4 comments
Open

Infer component groupings based on folder structure #3

naturallymitchell opened this issue Oct 17, 2017 · 4 comments

Comments

@naturallymitchell
Copy link

Would it be possible to organize the graph output structure like this visual paradigm - class diagram using the relationships encoded as a source code folder hierarchy? For example, this project's code seems organized well to fit that type of output.

@adjivas
Copy link
Owner

adjivas commented Oct 18, 2017

@mitchtbaum: There is a current limitation; the mll library has for dependency the dot crates who not implement the Subgraphs and Clusters described by the Graphviz's DOT language.

@naturallymitchell
Copy link
Author

@adjivas thanks for your reply and your work. I added an issue upstream, so hopefully it will hit someone's radar who can make it happen.

Hypothetically for now then, does this feature make sense as described? Would a component graph of this library come out better organized based on your existing coding style and folder structure?

@adjivas
Copy link
Owner

adjivas commented Oct 19, 2017

Well we can hypothetically envisage two features:

  • mod : where the subgraph is only a group of item with the name of the submodule.
  • mod-hierarchic : where we have a tree of subgraph imbricated

@naturallymitchell
Copy link
Author

I can sorta imagine what those would look like in relation to the diagram above, and they seem to cover it from two different angles. I believe it'd make a big difference since most auto-generated component diagrams make little use of an organization scheme and they end up looking barely usable, eg https://github.com/mitchtbaum/pelican-visualizations/blob/master/class_diagram-no_tests.png. Thanks again. Hopefully the next visual programmer will see this in action soon.

Aside: If there's any discussion about idiomatic folder schemes for Rust or structured programming in general, then perhaps these will inform eachother.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants