bld Checkstyle Extension https://github.com/rife2/bld-checkstyle
Find a file
2024-03-21 00:11:39 -07:00
.github/workflows Fixed truncated workflow 2024-03-21 00:11:37 -07:00
.idea Bumped checkstyle to 10.13.0 and bld to 1.8.0 2024-03-21 00:11:39 -07:00
.vscode Improved Visual Studio Code support 2024-03-21 00:11:39 -07:00
config Initial commit 2023-08-28 00:55:08 -07:00
examples Improved Visual Studio Code support 2024-03-21 00:11:39 -07:00
lib/bld Bumped JUnit and AssertJ test dependencies 2024-03-21 00:11:39 -07:00
src Bumped JUnit and AssertJ test dependencies 2024-03-21 00:11:39 -07:00
.gitignore Initial commit 2023-08-28 00:55:08 -07:00
bld Initial commit 2023-08-28 00:55:08 -07:00
bld.bat Initial commit 2023-08-28 00:55:08 -07:00
checkcliargs.sh Added script to compare checkstyle CLI arguments 2024-03-21 00:11:38 -07:00
LICENSE.txt Initial commit 2023-08-28 00:55:08 -07:00
README.md Bumped checkstyle to 10.13.0 and bld to 1.8.0 2024-03-21 00:11:39 -07:00

Checkstyle Extension for bld

License Java bld Release Snapshot GitHub CI

To install, please refer to the extensions documentation.

To check your code with Chesktyle, include the following in your build file:

@BuildCommand(summary = "Check code style")
public void checkstyle() throws Exception {
    new CheckstyleOperation()
            .fromProject(this)
            .configurationFile("config/sun_checks.xml")
            .execute();
}
./bld checkstyle

Please check the CheckstyleOperation documentation for all available configuration options.

Checkstyle Dependency

Don't forget to add a Checkstyle test dependency to your build file, as it is not provided by the extension. For example:

repositories = List.of(MAVEN_CENTRAL);
scope(test).include(dependency("com.puppycrawl.tools", "checkstyle", version(10, 13, 0)));