Skip to content

Effortlessly visualize mod graph with all external dependencies for your Go projects

License

Notifications You must be signed in to change notification settings

bayraktugrul/modview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

   __  ___        __     _           
  /  |/  /__  ___/ /  __(_)__ _    __
 / /|_/ / _ \/ _  / |/ / / -_) |/|/ /
/_/  /_/\___/\_,_/|___/_/\__/|__,__/

Transform your Go project's dependency graph into a dynamic, interactive visualization with modview. This powerful tool takes the complexity out of your module graph, offering a clear and explorable view of your project's dependencies.

Modview Example Image

modview leverages the output of go mod graph to create a browser-based visualization, enabling you to navigate, search, and understand your dependency structure effortlessly. Whether you're optimizing your codebase, resolving version conflicts, or exploring the ecosystem surrounding your project, modview is your guide through the intricate web of Go modules.

Features

Interactive HTML Visualization: Generate a dynamic, browser-friendly graph of your Go module dependencies.

Dependency Highlighting: Easily distinguish between picked and unpicked dependencies, as determined by the Minimal Version Selection (MVS) algorithm.

Intuitive Navigation: Zoom, pan, and explore large dependency graphs with ease.

Search Functionality: Quickly locate specific dependencies within your graph.

Dark Mode Support: Seamlessly switch between light and dark themes for a comfortable viewing experience, especially during late-night coding sessions.

Installation

Option 1

To install modview, use the following command:

go install github.com/bayraktugrul/modview@latest

Ensure that your Go bin directory is in your system's PATH.

Option 2

git clone https://github.com/bayraktugrul/modview.git
cd modview
go install

Usage

Navigate to your Go project's root directory and run:

modview

This will generate a file named dependency_tree.html in the current directory. Open this file in a web browser to view your module's dependency graph.

modview go mod graph dependency tree

To automatically open the dependency graph in your default web browser, use the --open flag:

modview --open

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License

Contact

For questions and feedback, please open an issue on the GitHub repository.

About

Effortlessly visualize mod graph with all external dependencies for your Go projects

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages