Skip to content
This repository

sbt plugin to create a dependency graph for your project

README.md

sbt-dependency-graph

Visualize your project's dependencies.

How To Use

For sbt 0.11/0.12/0.13, add sbt-dependency-graph as a dependency in project/plugins.sbt:

addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.7.4")

Then, add the following to your <project-root>/build.sbt (that's not project/build.sbt!) as a standalone line:

net.virtualvoid.sbt.graph.Plugin.graphSettings

OR, alternatively, if you use the full configuration, i.e. you define your build definition in project/build.scala, for example, to define a multi-module project, you should add

.settings(net.virtualvoid.sbt.graph.Plugin.graphSettings: _*)

to each of the project definitions for which you want to use the plugin. The definition of your project should then look approximately this way:

object MyBuild extends Build {
  val proj =
    Project("my-project", file("base"))
      .settings(net.virtualvoid.sbt.graph.Plugin.graphSettings: _*)
}

Check out the example project for a skeleton build setup.

Tasks

  • dependency-graph: Shows an ASCII graph of the project's dependencies on the sbt console
  • dependency-graph-ml: Generates a .graphml file with the project's dependencies to target/dependencies-<config>.graphml. Use e.g. yEd to format the graph to your needs.
  • dependency-dot: Generates a .dot file with the project's dependencies to target/dependencies-<config>.dot. Use graphviz to render it to your preferred graphic format.
  • dependency-tree: Shows an ASCII tree representation of the project's dependencies
  • what-depends-on <organization> <module> <revision>: Find out what depends on an artifact. Shows a reverse dependency tree for the selected module.
  • dependency-license-info: show dependencies grouped by declared license
  • ivy-report: let's ivy generate the resolution report for you project. Use show ivy-report for the filename of the generated report

All tasks can be scoped to a configuration to get the report for a specific configuration. test:dependency-graph, for example, prints the dependencies in the test configuration. If you don't specify any configuration, compile is assumed as usual.

Configuration settings

  • filterScalaLibrary: Defines if the scala library should be excluded from the output of the dependency-* functions. If true, instead of showing the dependency "[S]" is appended to the artifact name. Set to false if you want the scala-library dependency to appear in the output. (default: true)
  • dependencyGraphMLFile: a setting which allows configuring the output path of dependency-graph-ml.
  • dependencyDotFile: a setting which allows configuring the output path of dependency-dot.
  • dependencyDotHeader: a setting to customize the header of the dot file (e.g. to set your preferred node shapes).
  • dependencyDotNodeLabel: defines the format of a node label (default set to [organisation]<BR/><B>[name]</B><BR/>[version])

E.g. in build.sbt you can change configuration settings like this:

filterScalaLibrary := false // include scala library in output

dependencyDotFile := file("dependencies.dot") //render dot file to `./dependencies.dot`

Standalone usage

You can use the project without sbt as well by either depending on the library and calling IvyGraphMLDependencies.saveAsGraphML(IvyGraphMLDependencies.graph(reportFile), outputFile) or by just getting the binary and calling it like scala sbt-dependency-graph-0.7.4.jar <ivy-report-xml-path> <target-path>.

Inner Workings

sbt/Ivy's update task create ivy-report xml-files inside .ivy2/cache (in sbt 0.12.1: <project-dir>/target/resolution-cache/reports/<project-id>). You can just open them with your browser to look at the dependency report for your project. This project takes the report xml of your project and creates a graphml file out of it. (BTW, ivy can create graphml files itself, but since I didn't want to spend to much time getting sbt to call into Ivy to create graphs, I went with the easy way here)

Known issues

  • #19: There's an unfixed bug with graph generation for particular layouts. Workaround: Use dependency-tree instead of dependency-graph.
  • #12: Excluded dependencies will be shown in the graph in sbt < 0.12, works with later versions

Credits

  • Matt Russell (@mdr) for contributing the ASCII graph layout.
  • berleon (@berleon) for contributing rendering to dot.

License

Copyright (c) 2011, 2012 Johannes Rudolph

Published under the Apache License 2.0.

Something went wrong with that request. Please try again.