This tool works with a report from the following command (run from the root folder of an inspected project):
./pants -q dep-usage.jvm --no-summary src/scala/:: > deps.json
Make this report before using this tool, it may take a few minutes!
Binary (cargo required - how to install rust)
cargo build --release
Docker (docker required)(may take a few minutes)
docker build -t dep-sanitizer .
Run this tool from the root of your Pants project. If the report file isn't in the project root,
specify report file via --report-file e.g.
dep-sanitizer --report-file=/tmp/deps.json unused show
To get help
dep-sanitizer help
To show all unused dependencies
dep-sanitizer --prefix=src/ unused show
To remove all unused dependencies
dep-sanitizer unused fix
To show all undeclared but transitively used modules dependencies (doesn't make sense if 'exports' block used)
dep-sanitizer undeclared show
To add all undeclared dependencies to corresponded BUILD files (doesn't make sense if 'exports' block used)
dep-sanitizer undeclared fix
To sort dependencies in dependencies and export blocks,
replace " to ', and add trailing commas
dep-sanitizer --prefix=src/ sort
Use with docker
docker run -v ${PWD}/../your-repo:/project/ dep-sanitizer unused show
Note that, we mount 'your-repo' project into a container as 'project' folder. This folder should contain 'deps.json' file as well.
Sometimes we can get false positives and try to remove correct dependencies (very rare). If it happens to you, add this comment to the dependency line:
dependencies=[
'src/scala/whisk/util/converters', #skip-sanitize
...
]