Java Janitor is a Java code quality tool that automates code refactoring, enforces coding standards, and optimizes code. It is designed to help developers and teams produce high-quality code, reduce technical debt, and improve code maintainability.
Java Janitor provides the following features:
Automatic refactoring of code Enforcement of coding standards and best practices Optimization of code Reporting of code quality metric Integration with popular development tools
To use Java Janitor, you will need to have the following installed:
Java Development Kit (JDK) version 8 or higher Gradle build tool version 6.7 or higher You can then download the Java Janitor code from the GitHub repository and build it using Gradle. Once built, you can run the Java Janitor command line tool to analyze your code and generate reports.
Usage Java Janitor can be run as a command line tool or integrated into your development workflow using build tools or plugins.
Command Line To run Java Janitor as a command line tool, navigate to the root directory of the project and run the following command:
css Copy code java -jar javajanitor.jar --path [path/to/project] Replace [path/to/project] with the path to your Java project. Java Janitor will analyze your code and generate reports in the reports directory.
Gradle To integrate Java Janitor into your Gradle build, add the following to your build.gradle file:
bash Copy code plugins { id 'org.javajanitor' version '1.0.0' } Then run the following command to analyze your code and generate reports:
Copy code gradle janitor
Copy code mvn verify IDE Plugins Java Janitor also provides plugins for popular IDEs, including Eclipse and IntelliJ IDEA. These plugins provide real-time analysis of your code as you write it, and generate reports and recommendations for improving code quality.
Reporting Java Janitor generates reports on code quality metric, including code complexity, maintainability, and adherence to coding standards and best practices. Reports can be viewed in a variety of formats, including HTML, XML, and CSV.
Contributing Contributions to Java Janitor are welcome! If you have an idea for a new feature, a bug report, or a pull request, please submit it to the GitHub repository.
License Java Janitor is released under the MIT License. See LICENSE for details.