Fork me on GitHub

walkmod:check

Full name:

org.walkmod.maven.plugins:walkmod-maven-plugin:2.0.1:check

Description:

Reports which files violate the applied coding style conventions

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: process-classes.

Required Parameters

Name Type Since Description
project MavenProject - Current project
Default value is: ${project}.
User property is: project.

Optional Parameters

Name Type Since Description
chains String - Chains to execute
Default value is: ${walkmod.chains}.
User property is: chains.
excludes String[] - List of excluded files
includes String[] - List of included files
offline boolean - If dependencies are resolved off-line
Default value is: false.
User property is: offline.
path String - Source file directory
User property is: path.
printError boolean - If it prints errors
Default value is: false.
User property is: printError.
properties String - Dynamic parameters to set
Default value is: ${walkmod.properties}.
User property is: properties.
skipWalkmod boolean - If it skips walkmod
User property is: skipWalkmod.
verbose boolean - If it is executed in verbose mode.
Default value is: false.
User property is: verbose.

Parameter Details

chains:

Chains to execute
  • Type: java.lang.String
  • Required: No
  • User Property: chains
  • Default: ${walkmod.chains}

excludes:

List of excluded files
  • Type: java.lang.String[]
  • Required: No

includes:

List of included files
  • Type: java.lang.String[]
  • Required: No

offline:

If dependencies are resolved off-line
  • Type: boolean
  • Required: No
  • User Property: offline
  • Default: false

path:

Source file directory
  • Type: java.lang.String
  • Required: No
  • User Property: path

printError:

If it prints errors
  • Type: boolean
  • Required: No
  • User Property: printError
  • Default: false

project:

Current project
  • Type: org.apache.maven.project.MavenProject
  • Required: Yes
  • User Property: project
  • Default: ${project}

properties:

Dynamic parameters to set
  • Type: java.lang.String
  • Required: No
  • User Property: properties
  • Default: ${walkmod.properties}

skipWalkmod:

If it skips walkmod
  • Type: boolean
  • Required: No
  • User Property: skipWalkmod

verbose:

If it is executed in verbose mode.
  • Type: boolean
  • Required: No
  • User Property: verbose
  • Default: false