bld-checkstyle/README.md

Checkstyle Extension for bld

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

• View Examples

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, 21, 1)));