Be aware that this repository is no longer under maintenance, for a better alternative please have a look at diff-check.
When using checkstyle to scan a project, it will output all the problems in each file at once. This makes it difficult to perform an effective style check on the codes under development before cleaning up all the existing style problems.
In response to this pain point, I extended the checkstyle command-line tool to support style checks only on incremental changes of code lines.
- Besides the original command-line options of checkstyle, this tool adds three new options: --git-dir, --include-staged-codes and --base-rev
- git-dir：Specify the root directory of the git repository. When using this option, the check job will only consider the files based on git-diff.
- include-staged-codes：With this option, the tool will also consider the changes in git staging area.
- base-rev：Specify the reference(commit or branch or tag) with which the latest commit(HEAD) will compare on the diff calculation. The default value of base-rev will be HEAD(the latest commit) if --include-staged-codes is used, otherwise the default is HEAD~(the first parent of the latest commit).
java -jar diff-checkstyle.jar -c /custom_checks.xml --git-dir ${your_git_repo_path} --base-rev HEAD~3 --include-staged-codes
Run with maven-exec-plugin
- Execute
mvn installto install the archive file to your local maven repository - Introduce the following configuration to pom.xml of your project
<properties>
<!-- the default value of base-rev，can be overwritten when running -->
<checkstyle.base.rev>HEAD~</checkstyle.base.rev>
</properties>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>1.5.0</version>
<configuration>
<executable>java</executable>
<includeProjectDependencies>false</includeProjectDependencies>
<includePluginDependencies>true</includePluginDependencies>
<executableDependency>
<groupId>io.github.yangziwen</groupId>
<artifactId>diff-checkstyle</artifactId>
</executableDependency>
<mainClass>io.github.yangziwen.checkstyle.Main</mainClass>
<cleanupDaemonThreads>false</cleanupDaemonThreads>
<arguments>
<!-- any parameters supported by the original checkstyle command-line tool -->
<argument>-c</argument>
<argument>/custom_checks.xml</argument>
<argument>--git-dir</argument>
<argument>${basedir}</argument>
<argument>-f</argument>
<argument>xml</argument>
<argument>-o</argument>
<argument>${project.build.directory}/checkstyle.xml</argument>
<argument>--base-rev</argument>
<!-- pass the base-rev value via the system variable -->
<argument>${checkstyle.base.rev}</argument>
<argument>--include-staged-codes</argument>
</arguments>
</configuration>
<dependencies>
<dependency>
<groupId>io.github.yangziwen</groupId>
<artifactId>diff-checkstyle</artifactId>
<version>${the_version_in_use}</version>
<type>jar</type>
</dependency>
</dependencies>
</plugin>
</plugins>- Execute
mvn exec:java -Dcheckstyle.base.rev=HEAD~10to do the check job
- Copy the pre-commit hook and the diff-checkstyle.jar file to the git hooks directory (${git_dir}/.git/hooks). This hook will do the check job whenever you submit a commit to your repository, and aborts the commit if it will introduce any incremental style problems.
- Or you can run the following commands to install the hook