Maven Checkstyle Plugin - maven-checkstyle-plugin

Type: boolean
Required: No
Expression: ${checkstyle.failOnViolation}
Default: true

checkstyle:check

Full name:

org.apache.maven.plugins:maven-checkstyle-plugin:2.2:check

Description:

Perform a violation check against the last Checkstyle run to see if there are any violations. It reads the Checkstyle output file, counts the number of violations found and displays it on the console.

Attributes:

Requires a Maven 2.0 project to be executed.
Requires dependency resolution of artifacts in scope: compile.
Binds by default to the lifecycle phase: verify.
Invokes the execution of this plugin's goal checkstyle prior to executing itself.

Optional Parameters

Name	Type	Since	Description
failOnViolation	`boolean`	`-`	Do we fail the build on a violation? Default value is: `true`.
outputFile	`File`	`-`	Specifies the path and filename to save the Checkstyle output. The format of the output file is determined by the `outputFileFormat` parameter. Default value is: `${project.build.directory}/checkstyle-result.xml`.
outputFileFormat	`String`	`-`	Specifies the format of the output to be used when writing to the output file. Valid values are "plain" and "xml". Default value is: `xml`.
skip	`boolean`	`2.2`	Skip entire check. Default value is: `false`.
violationSeverity	`String`	`2.2`	The lowest severity level that is considered a violation. Valid values are "error", "warning" and "info". Default value is: `error`.