Inspectory is a static analysis tool created using Java and designed to inspect Git repositories for Java projects. Its goal is to detect some anti-patterns using metrics.
- detect Supernova methods: methods that grow abruptly in size at some point in time
- detect Pulsar methods: methods that repeatedly grow and shrink in size
- detect Ownership problems on classes and methods
To run the tool you need to have minimum Java 8 and Git installed on your computer. As well, you need to download the latest ChronoLens 0.1.X from here (currently, the latest version is metanalysis-0.1.8 released on Feb 6).
First, after assuring the prerequisites are met, download the latest release of Inspectory from here. Using the command line, either on Unix-like or Windows systems, follow the next steps:
# Clone the repository to be inspected into the current working directory.
git clone <desired_Git_repository_URL>
# Copy the metanalysis-0.1.X folder into the repository's folder.
# Persist the repository to get its history model.
./metanalysis-<version>/bin/metanalysis persist
# After the ChronoLens tool finished, copy Inspectory .jar into the repository's folder.
# Run all the metrics available using '-all' option. For more options, use '-h' instead.
java -jar inspectory-<version>.jar -all
# Analyze CSV and JSON results in .inspectory folder.
# Clean the repository by deleting ChronoLens and Inspectory results.
./metanalysis-<version>/bin/metanalysis clean
java -jar inspectory-<version>.jar --clean
This project is licensed under the MIT License - see the LICENSE.md file for details.