severeoverfl0w / vizns

Visualize the relationships between your namespaces and dependencies

Vizns

Visualize the relationship between namespaces and their dependencies.

Usage

Add vizns as an alias in your ~/.clojure/deps.edn so it’s available in any project:

{:aliases
 {:user/vizns
  {:deps {io.dominic/vizns {:git/url "https://github.com/SevereOverfl0w/vizns.git"
                            :sha "85b375763b038c33f2290b9383cde3eebcf6bc8d"}}
   :main-opts ["-m" "io.dominic.vizns.core"]}}}

Run in your project

Produce a navigable folder of SVGs

$ clj -A:user/vizns navigate

Produce a deps-graph.dot file

$ clj -A:user/vizns

Tip	You can upload the .dot file to https://edotor.net/ to view without having graphviz installed.

Produce a deps-graph image directly

$ clj -A:user/vizns single -o deps-graph.png -f png
$ clj -A:user/vizns single -o deps-graph.svg -f svg

View graph without saving

$ clj -A:user/vizns single --show

Output information

Dependencies can be colored 3 colors:

Green

You’re doing the right thing, carry on.

Red

You’re using this dependency, but you’re relying on it being brought in transitively. This means you’re relying on an implementation detail of a library. You should add this dependency to your deps.edn

Grey

You’re not using this dependency (NOTE: There’s a lot of false positives here, especially around java)

Example

(Example sourced from camelot)

Navigation of Camelot (Click nodes to filter)

vizns's Issues

tools.deps api changes

Just wanted to drop a note that the newest version of tools.deps.alpha contains some api changes (moving towards getting out of alpha). So when you bump to tools.deps.alpha >= 0.9.745, you'll need to change your use of clojure.tools.deps.alpha.reader - that functionality is now in clojure.tools.deps.alpha, may be some function name changes too.

Opportunities for improving new user experience

As suggested on Slack,

1. I first naïvely ran it in a folder without a deps.edn file, and spent some time figuring out why it didn't work.
2. Then I reran it in an actual project, only to find out I was making it crash because I hadn't supplied any main args
3. Then I figured I needed to sudo apt install graphviz, because of the dependency on dot.

Suggested fixes:

1. Improved error message
2. Show usage on empty args
3. Note that graphviz must be installed in README

I'm not promising a PR, but feel free to ping me if you haven't heard back in a while :)

Teodor

Dependency warning message

Hi,
First thanks for your work,
I have a warning message regarding the dependencies.

I suggest to update the deps.edn.