lint:check

Full name:

com.lewisd:lint-maven-plugin:0.0.10:check

Description:

Perform checks on the POM, and fail the build if violations are found.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: verify.

Required Parameters

Name Type Since Description
configLocation String - The root spring config location.
Default value is: config/maven_lint.xml.
User property is: maven-lint.config.location.

Optional Parameters

Name Type Since Description
failOnViolation boolean - Fail the build when there are violations.
default: true
can be overriden by giving -Dmaven-lint.failOnViolation=true|false

Default value is: true.
User property is: maven-lint.failOnViolation.
htmlOutputFile File - Specifies the path and filename to save the HTML report to.
Default value is: ${project.build.directory}/maven-lint-result.html.
User property is: maven-lint.output.file.html.
onlyRunRules String[] - Comma-separates list of rules to be executed
list of rules can be taken from goal 'list'
default: all
can be overriden by giving -Dmaven-lint.rules=all
hint: can be overriden by <rules/>-section
onlyRunRulesSwitch String[] - Comma-separates list of rules to be executed
list of rules can be taken from goal 'list'
default: all
User property is: maven-lint.rules.
outputReports String - Comma-separates list of output reports to generate.
Supported reports are:
summary (written to standard out, or file specified by summaryOutputFile)
xml (written to file specified by xmlOutputFile)
html (written to file specified by xmlOutputFile) (NOT YET IMPLEMENTED)
Default value is: summary,xml.
User property is: maven-lint.output.reports.
rules PatternSet - based on patterns you can include and exclude rules
default configuration is
<rules>
  <excludes/>
  <includes>
    <include>*</include>
  </includes/>
</rules/>

hints:
- excludes overrides includes
- onlyRunRules are overriden by these rules
xmlOutputFile File - Specifies the path and filename to save the XML report to.
defaultValue: ${project.build.directory}/maven-lint-result.xml
can be overriden by giving -Dmaven-lint.output.file.xml=path

Default value is: ${project.build.directory}/maven-lint-result.xml.
User property is: maven-lint.output.file.xml.

Parameter Details

configLocation:

The root spring config location.
  • Type: java.lang.String
  • Required: Yes
  • User Property: maven-lint.config.location
  • Default: config/maven_lint.xml

failOnViolation:

Fail the build when there are violations.
default: true
can be overriden by giving -Dmaven-lint.failOnViolation=true|false
  • Type: boolean
  • Required: No
  • User Property: maven-lint.failOnViolation
  • Default: true

htmlOutputFile:

Specifies the path and filename to save the HTML report to.
  • Type: java.io.File
  • Required: No
  • User Property: maven-lint.output.file.html
  • Default: ${project.build.directory}/maven-lint-result.html

onlyRunRules:

Comma-separates list of rules to be executed
list of rules can be taken from goal 'list'
default: all
can be overriden by giving -Dmaven-lint.rules=all
hint: can be overriden by <rules/>-section
  • Type: java.lang.String[]
  • Required: No

onlyRunRulesSwitch:

Comma-separates list of rules to be executed
list of rules can be taken from goal 'list'
default: all
  • Type: java.lang.String[]
  • Required: No
  • User Property: maven-lint.rules

outputReports:

Comma-separates list of output reports to generate.
Supported reports are:
summary (written to standard out, or file specified by summaryOutputFile)
xml (written to file specified by xmlOutputFile)
html (written to file specified by xmlOutputFile) (NOT YET IMPLEMENTED)
  • Type: java.lang.String
  • Required: No
  • User Property: maven-lint.output.reports
  • Default: summary,xml

rules:

based on patterns you can include and exclude rules
default configuration is
<rules>
  <excludes/>
  <includes>
    <include>*</include>
  </includes/>
</rules/>

hints:
- excludes overrides includes
- onlyRunRules are overriden by these rules
  • Type: org.apache.maven.model.PatternSet
  • Required: No

xmlOutputFile:

Specifies the path and filename to save the XML report to.
defaultValue: ${project.build.directory}/maven-lint-result.xml
can be overriden by giving -Dmaven-lint.output.file.xml=path
  • Type: java.io.File
  • Required: No
  • User Property: maven-lint.output.file.xml
  • Default: ${project.build.directory}/maven-lint-result.xml