README.md
1# Dependency Mapper
2
3[dependency-mapper] command line tool. This tool finds the usage based dependencies between java
4files by utilizing byte-code and java file analysis.
5
6# Getting Started
7
8## Inputs
9* rsp file, containing list of java files separated by whitespace.
10* jar file, containing class files generated after compiling the contents of rsp file.
11
12## Output
13* proto file, representing the list of dependencies for each java file present in input rsp file,
14represented by [proto/usage.proto]
15
16## Usage
17```
18dependency-mapper --src-path [src-list.rsp] --jar-path [classes.jar] --usage-map-path [usage-map.proto]"
19```
20
21# Notes
22## Dependencies enlisted are only within the java files present in input.
23## Ensure that [SourceFile] is present in the classes present in the jar.
24## To ensure dependencies are listed correctly
25* Classes jar should only contain class files generated from the source rsp files.
26* Classes jar should not exclude any class file that was generated from source rsp files.