Skip to content
This repository was archived by the owner on Apr 8, 2021. It is now read-only.

Commit d2dd796

Browse files
committed
Reinstate documentation for new features
This reverts commit a093b91.
1 parent b4eae62 commit d2dd796

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ the notes of version [0.8.2](https://github.com/jrudolph/sbt-dependency-graph/tr
2525

2626
* `dependencyTree`: Shows an ASCII tree representation of the project's dependencies
2727
* `dependencyBrowseGraph`: Opens a browser window with a visualization of the dependency graph (courtesy of graphlib-dot + dagre-d3).
28+
* `dependencyBrowseTree`: Opens a browser window with a visualization of the dependency tree (courtesy of jstree).
2829
* `dependencyList`: Shows a flat list of all transitive dependencies on the sbt console (sorted by organization and name)
2930
* `whatDependsOn <organization> <module> <revision>?`: Find out what depends on an artifact. Shows a reverse dependency
3031
tree for the selected module. The `<revision>` argument is optional.
@@ -38,11 +39,30 @@ the notes of version [0.8.2](https://github.com/jrudolph/sbt-dependency-graph/tr
3839
* `ivyReport`: Lets ivy generate the resolution report for you project. Use
3940
`show ivyReport` for the filename of the generated report
4041

42+
The following tasks also support the `toFile` subtask to save the contents to a file:
43+
44+
* `dependencyTree`
45+
* `dependencyList`
46+
* `dependencyStats`
47+
* `dependencyLicenseInfo`
48+
49+
The `toFile` subtask has the following syntax:
50+
51+
```
52+
<config>:<task>::toFile <filename> [-f|--force]
53+
```
54+
55+
Use `-f` to force overwriting an existing file.
56+
57+
E.g. `test:dependencyStats::toFile target/depstats.txt` will write the output of the `dependencyStats` in the `test`
58+
configuration to the file `target/depstats.txt` but would not overwrite an existing file.
59+
4160
All tasks can be scoped to a configuration to get the report for a specific configuration. `test:dependencyGraph`,
4261
for example, prints the dependencies in the `test` configuration. If you don't specify any configuration, `compile` is
4362
assumed as usual.
4463

45-
Note: If you want to run tasks with parameters from outside the sbt shell, make sure to put the whole task invocation in quotes, e.g. `sbt "whatDependsOn <org> <module> <version>"`.
64+
Note: If you want to run tasks with parameters from outside the sbt shell, make sure to put the whole task invocation in
65+
quotes, e.g. `sbt "whatDependsOn <org> <module> <version>"`.
4666

4767
## Configuration settings
4868

0 commit comments

Comments
 (0)