Fork me on GitHub

rbc:check

Full name:

net.metacube.maven:maven-rbc-plugin:0.6-SNAPSHOT:check

Description:

Runs the bundle checks. Check out rscbundlecheck.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • The goal is thread-safe and supports parallel builds.

Optional Parameters

Name Type Since Description
disabledChecks List - Checks disabled. See enabledChecks
enabledChecks List - Checks enabled. By default, all checks are enabled. 

<enabledChecks>
  <param>*</param>
</enabledChecks>
<disabledChecks>
  <!-- param>allowed char key check</param -->
  <!-- param>unicode check</param -->
  <param>cross bundle check</param>
  <!-- param>duplicate key check</param -->
  <!-- param>empty key check</param -->
  <!-- param>empty value check</param -->
  <!-- param>messageformat check</param -->
  <!-- param>invalid char check</param -->
  <!-- param>line end check</param -->
  <!-- param>upper lower check</param -->
  <!-- param>invalid char check</param -->
</disabledChecks>

failOnError boolean - Fail on error, such as missing resource key.
Default value is: false.
fileset FileSet - Fileset for scanning. Example: 

<fileset>
  <directory>src/main/resources</directory>
  <includes>
    <include>net/metacube/example/project/**/*.properties</include>
  </includes>
</fileset>
Note: Same rules as for includes apply for excludes
sortResult boolean - Sort results when reporting.
Default value is: true.
verbose boolean - Be verbose. Automatically enabled when running mvn in debug mode.
Default value is: false.
warnOnIncompleteBundle boolean - Autodetects locales and warns in a resource file for a locale is missing.
Default value is: true.

Parameter Details

disabledChecks:

Checks disabled. See enabledChecks
  • Type: java.util.List
  • Required: No

enabledChecks:

Checks enabled. By default, all checks are enabled. 

<enabledChecks>
  <param>*</param>
</enabledChecks>
<disabledChecks>
  <!-- param>allowed char key check</param -->
  <!-- param>unicode check</param -->
  <param>cross bundle check</param>
  <!-- param>duplicate key check</param -->
  <!-- param>empty key check</param -->
  <!-- param>empty value check</param -->
  <!-- param>messageformat check</param -->
  <!-- param>invalid char check</param -->
  <!-- param>line end check</param -->
  <!-- param>upper lower check</param -->
  <!-- param>invalid char check</param -->
</disabledChecks>
  • Type: java.util.List
  • Required: No

failOnError:

Fail on error, such as missing resource key.
  • Type: boolean
  • Required: No
  • Default: false

fileset:

Fileset for scanning. Example: 

<fileset>
  <directory>src/main/resources</directory>
  <includes>
    <include>net/metacube/example/project/**/*.properties</include>
  </includes>
</fileset>
Note: Same rules as for includes apply for excludes
  • Type: org.apache.maven.model.FileSet
  • Required: No

sortResult:

Sort results when reporting.
  • Type: boolean
  • Required: No
  • Default: true

verbose:

Be verbose. Automatically enabled when running mvn in debug mode.
  • Type: boolean
  • Required: No
  • Default: false

warnOnIncompleteBundle:

Autodetects locales and warns in a resource file for a locale is missing.
  • Type: boolean
  • Required: No
  • Default: true