luke
/
sbt
mirror of https://github.com/sbt/sbt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

README and notes

This commit is contained in:
Johannes Rudolph 2012-05-23 12:35:49 +02:00
parent d480c79ccc
commit 3132466e06
3 changed files with 31 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -14,7 +14,7 @@ How To Use
For sbt 0.11, add sbt-dependency-graph as a dependency in `project/plugins.sbt`:
```scala
addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.5.2")
addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.6.0")
```
*Note*: The organization has recently been changed to `net.virtual-void`.
@ -34,12 +34,22 @@ object Plugins extends Build {
Then, add the following in your `build.sbt`:
```scala
seq(net.virtualvoid.sbt.graph.Plugin.graphSettings: _*)
net.virtualvoid.sbt.graph.Plugin.graphSettings
```
In sbt you can then use the `dependency-graph` task in sbt to generate a graphml file
in `target/dependencies.graphml`. Use e.g. [yEd](http://www.yworks.com/en/products_yed_about.html)
to format the graph to your needs.
Tasks & Settings
----------------
* `dependency-graph`: Shows an ASCII graph of your dependency on the sbt console
* `dependency-graph-ml`: Generates a .graphml file with your dependencies to `target/dependencies-<config>.graphml`.
Use e.g. [yEd](http://www.yworks.com/en/products_yed_about.html) to format the graph to your needs.
* `dependency-graph-ml-file`: a setting which allows configuring the output path of `dependency-graph-ml`.
* `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.
Standalone usage
----------------
@ -52,7 +62,7 @@ and calling it like `scala sbt-dependency-graph-0.5.1.jar <ivy-report-xml-path>
Inner Workings
--------------
sbt/Ivy's `deliver-local` task create ivy-report xml-files inside `.ivy2/cache`. You can
sbt/Ivy's `update` task create ivy-report xml-files inside `.ivy2/cache`. 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

12
notes/0.6.0.markdown Normal file
View File

@ -0,0 +1,12 @@
New features in this version:
* `dependency-graph` task now prints the dependency graph to the console
(contributed by @gseitz)
* `dependency-graph-ml` contains now the old functionality of `dependency-graph`
which generates a `.graphml` file. Nodes contain the dependency version as well (contributed by @gseitz).
* The output filename of `dependency-graph-ml` has been changed to include the configuration name. It is now
configurable using the `dependency-graph-ml-file` setting.
* The common `scalaVersion in update` idiom to support Scala 2.9.1 libraries in a
Scala 2.9.2 broke the plugin in 0.5.2, because it wouldn't find the ivy report xml file
any more. This was fixed.
* All tasks are scoped by configuration.

3
notes/about.markdown Normal file
View File

@ -0,0 +1,3 @@
[sbt-dependency-graph][gh] is an sbt plugin to visualize dependencies of your build.
[gh]:https://github.com/jrudolph/sbt-dependency-graph/