Specifies the cache file used to speed up Checkstyle on successive runs.

By using this property, you can specify the whole Checkstyle rules inline directly inside this pom.

<plugin>
  ...
  <configuration>
    <checkstyleRules>
      <module name="Checker">
        <module name="FileTabCharacter">
          <property name="eachLine" value="true" />
        </module>
        <module name="TreeWalker">
          <module name="EmptyBlock"/>
        </module>
      </module>
    </checkstyleRules>
  </configuration>
  ...

The header to use for the inline configuration. Only used when you specify checkstyleRules.

Specifies the location of the XML configuration to use.

Potential values are a filesystem path, a URL, or a classpath resource. This parameter expects that the contents of the location conform to the xml format (Checkstyle Checker module) configuration of rulesets.

This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the configuration is copied into the ${project.build.directory}/checkstyle-configuration.xml file before being passed to Checkstyle as a configuration.

There are 2 predefined rulesets.

• sun_checks.xml: Sun Checks.
• google_checks.xml: Google Checks.

Output errors to console.

Specifies whether generated source files should be excluded from Checkstyle.

Specifies the names filter of the source files to be excluded for Checkstyle.

Fail the build on a violation. The goal checks for the violations after logging them (if logViolationsToConsole is true). Compare this to failsOnError which fails the build immediately before examining the output log.

If this is true, and Checkstyle reported any violations or errors, the build fails immediately after running Checkstyle, before checking the log for logViolationsToConsole. If you want to use logViolationsToConsole, use failOnViolation instead of this.

Specifies the location of the License file (a.k.a. the header file) that can be used by Checkstyle to verify that source code has the correct license header.

You need to use ${checkstyle.header.file} in your Checkstyle xml configuration to reference the name of this header file.

For instance:

<module name="RegexpHeader">
  <property name="headerFile" value="${checkstyle.header.file}"/>
</module>

Whether to apply Checkstyle to resource directories.

Whether to apply Checkstyle to test resource directories.

Include or not the test source directory to be used for Checkstyle.

Specifies the names filter of the source files to be used for Checkstyle.

The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used. Note: This parameter always overrides the property charset from Checkstyle's TreeWalker module.

Output the detected violation count to the console.

Output the detected violations to the console.

The maximum number of allowed violations. The execution fails only if the number of violations is above this limit.

Specifies whether modules with a configured severity of ignore should be omitted during Checkstyle invocation.

Specifies the path and filename to save the Checkstyle output. The format of the output file is determined by the outputFileFormat parameter.

Specifies the format of the output to be used when writing to the output file. Valid values are "plain", "sarif" and "xml".

Specifies the location of the properties file.

This parameter is resolved as URL, File then resource. If successfully resolved, the contents of the properties location is copied into the ${project.build.directory}/checkstyle-checker.properties file before being passed to Checkstyle for loading.

The contents of the propertiesLocation will be made available to Checkstyle for specifying values for parameters within the xml configuration (specified in the configLocation parameter).

Allows for specifying raw property expansion information.

Specifies the names filter of the files to be excluded for Checkstyle when checking resources.

Specifies the names filter of the files to be used for Checkstyle when checking resources.

Dump file for inlined Checkstyle rules.

Skip entire check.

Skip Checkstyle execution will only scan the outputFile.

Specifies the location of the source directories to be used for Checkstyle. Default value is ${project.compileSourceRoots}.

Deprecated.
instead use sourceDirectories. For version 3.0.0, this parameter is only defined to break the build if you use it!

Specifies the location of the source directory to be used for Checkstyle.

The key to be used in the properties for the suppressions file.

Specifies the location of the suppressions XML file to use.

This parameter is resolved as resource, URL, then file. If successfully resolved, the contents of the suppressions XML is copied into the ${project.build.directory}/checkstyle-suppressions.xml file before being passed to Checkstyle for loading.

See suppressionsFileExpression for the property that will be made available to your Checkstyle configuration.

Specifies the location of the test source directories to be used for Checkstyle. Default value is ${project.testCompileSourceRoots}.

Deprecated.
instead use testSourceDirectories. For version 3.0.0, this parameter is only defined to break the build if you use it!

Specifies the location of the test source directory to be used for Checkstyle.

If null, the Checkstyle plugin will display violations on stdout. Otherwise, a text file will be created with the violations.

Violations to ignore. This is a comma-separated list, each value being either a rule name, a rule category or a java package name of rule class.

The lowest severity level that is considered a violation. Valid values are "error", "warning" and "info".