https://github.com/axelson/dep_viz

A visual tool to help developers understand Elixir recompilation in their projects
https://github.com/axelson/dep_viz

data-visualization developer-tools elixir

Last synced: 21 days ago
JSON representation

A visual tool to help developers understand Elixir recompilation in their projects

• Host: GitHub
• URL: https://github.com/axelson/dep_viz
• Owner: axelson
• Created: 2020-10-18T23:03:22.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-15T19:16:07.000Z (3 months ago)
• Last Synced: 2024-10-15T19:43:44.482Z (about 2 months ago)
• Topics: data-visualization, developer-tools, elixir
• Language: JavaScript
• Homepage: https://depviz.jasonaxelson.com/
• Size: 13.9 MB
• Stars: 192
• Watchers: 6
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• beamtoolbox - [ex

README

        
# DepViz

DepViz is a visual tool to understand Elixir recompilation.

It is accessible online at: [https://depviz.jasonaxelson.com/](https://depviz.jasonaxelson.com/)

The intent is to help developers rapidly understand what compilation dependencies they have in their project. Then they can take steps to minimize them to reduce the feedback loop between writing code and seeing results.

Helps you answer questions about the Elixir code base:

* Why when I change file A does it cause 100 files to recompile?

  * Investigate: What files will **cause this** file to recompile?

  * Investigate: What files does **this file cause** to recompile?

To better understand how to use DepViz and why recompilation happens check out my Code BEAM BR talk: [https://www.codebeambr.com/video/12](https://www.codebeambr.com/video/12)

## Screenshots

![Screenshot of Credo](contrib/screenshot_credo.png)

![Screenshot of Credo while hovering over a node](contrib/screenshot_highlight_credo.png)

## FAQ

* Is this usable with other graphs?

  - A: Not really, for example the graph algorithms needs to revisit the starting node if the starting node is itself part of a transitive compile time dependency chain

## Running locally

To start the server:

  * Install dependencies with `mix deps.get`

  * Install Node.js dependencies with `npm install` inside the `assets` directory

  * Start Phoenix endpoint with `mix phx.server`

Now visit [`localhost:4040`](http://localhost:4040) from your browser.