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

Reinstate documentation for new features 

This reverts commit a093b91433.
This commit is contained in:
Johannes Rudolph 2019-07-24 08:21:05 +02:00
parent b4eae629a6
commit d2dd796fd7
No known key found for this signature in database
GPG Key ID: 52AF1C9ABD77E6E5
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -25,6 +25,7 @@ the notes of version [0.8.2](https://github.com/jrudolph/sbt-dependency-graph/tr
* `dependencyTree`: Shows an ASCII tree representation of the project's dependencies * `dependencyTree`: Shows an ASCII tree representation of the project's dependencies
* `dependencyBrowseGraph`: Opens a browser window with a visualization of the dependency graph (courtesy of graphlib-dot + dagre-d3). * `dependencyBrowseGraph`: Opens a browser window with a visualization of the dependency graph (courtesy of graphlib-dot + dagre-d3).
* `dependencyBrowseTree`: Opens a browser window with a visualization of the dependency tree (courtesy of jstree).
* `dependencyList`: Shows a flat list of all transitive dependencies on the sbt console (sorted by organization and name) * `dependencyList`: Shows a flat list of all transitive dependencies on the sbt console (sorted by organization and name)
* `whatDependsOn <organization> <module> <revision>?`: Find out what depends on an artifact. Shows a reverse dependency * `whatDependsOn <organization> <module> <revision>?`: Find out what depends on an artifact. Shows a reverse dependency
tree for the selected module. The `<revision>` argument is optional. 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
* `ivyReport`: Lets ivy generate the resolution report for you project. Use * `ivyReport`: Lets ivy generate the resolution report for you project. Use
`show ivyReport` for the filename of the generated report `show ivyReport` for the filename of the generated report
The following tasks also support the `toFile` subtask to save the contents to a file:
* `dependencyTree`
* `dependencyList`
* `dependencyStats`
* `dependencyLicenseInfo`
The `toFile` subtask has the following syntax:
```
<config>:<task>::toFile <filename> [-f|--force]
```
Use `-f` to force overwriting an existing file.
E.g. `test:dependencyStats::toFile target/depstats.txt` will write the output of the `dependencyStats` in the `test`
configuration to the file `target/depstats.txt` but would not overwrite an existing file.
All tasks can be scoped to a configuration to get the report for a specific configuration. `test:dependencyGraph`, All tasks can be scoped to a configuration to get the report for a specific configuration. `test:dependencyGraph`,
for example, prints the dependencies in the `test` configuration. If you don't specify any configuration, `compile` is for example, prints the dependencies in the `test` configuration. If you don't specify any configuration, `compile` is
assumed as usual. assumed as usual.
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>"`. 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>"`.
## Configuration settings ## Configuration settings