Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

tool to display a graph of dependencies #2478

Open
moul opened this issue Jul 2, 2024 · 2 comments · May be fixed by #2635
Open

tool to display a graph of dependencies #2478

moul opened this issue Jul 2, 2024 · 2 comments · May be fixed by #2635

Comments

@moul
Copy link
Member

moul commented Jul 2, 2024

We should have a tool that displays a graph of dependencies for a set of packages, using Graphviz or a similar visualization tool.

We have two main options. The first is to be file-system-first, where the tool would work against the file system. We have some helpers in the gnomod packages that can return this dependency tree. The second option is to have the tool implemented against a store first, which would be "gnoweb" friendly and work locally, but we need to consider performance implications.

In addition to this tool, we should create a CI/CD script that keeps the graph of dependencies for the examples/ folder up-to-date and displayed, perhaps in a README.md file or on Godoc. This would allow us to easily identify if some examples are lacking usage demonstrations or are potentially "dead code".

The reason for this request is that (I love this kind of graph visualization, and) we need more real-world examples to differentiate well-known examples from potentially "dead code" ones. Having this tool and monitoring the graph of examples would help us identify the most used and isolated ones, and encourage people to write code for using it, not just for the sake of writing code.

@zivkovicmilos
Copy link
Member

Related: gnolang/hackerspace#55

@bmilojkovic
Copy link

Hi, I'd like to try and take a stab at this (I also really love this kind of visualization :) ). This would be my first contribution to the repo, and I feel comfortable with this one. I should have a PoC of the file system version fairly quickly.

@bmilojkovic bmilojkovic linked a pull request Jul 27, 2024 that will close this issue
7 tasks
@leohhhn leohhhn linked a pull request Aug 4, 2024 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📥 Inbox
Status: Backlog
Development

Successfully merging a pull request may close this issue.

3 participants