erlang:dialyzer

Full name:

eu.lindenbaum:maven-erlang-plugin:1.0.0-beta:dialyzer

Description:

This Mojo runs the erlang dialyzer tool on the project sources found in AbstractErlangMojo.srcMainErlang as well as the project includes in AbstractErlangMojo.srcMainInclude. This means dialyzer will run over the complete project code (excluding test modules).

The dialyzer can be skipped using the useDialyzer parameter in the projects pom. Additionally, the user can choose to run dialyzer also on the projects dependencies using the dialyzerWithDependencies pom parameter. This is disabled by default for the erlang-otp application packaging.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Binds by default to the lifecycle phase: process-test-classes.

Optional Parameters

Name Type Since Description
dialyzerOptions String[] - Additional dialyzer options.
dialyzerWarningsAreErrors boolean - Setting this to true will break the build when a dialyzer run returns warnings.
Default value is: false.
dialyzerWithDependencies boolean - Setting this to true will include the projects dependencies into the dialyzer run. Note: This may take very long.
Default value is: false.
skipDialyzer boolean - Setting this to true will skip the dialyzer analysis.
Default value is: false.

Parameter Details

dialyzerOptions:

Additional dialyzer options.
  • Type: java.lang.String[]
  • Required: No

dialyzerWarningsAreErrors:

Setting this to true will break the build when a dialyzer run returns warnings.
  • Type: boolean
  • Required: No
  • Expression: ${dialyzerWarningsAreErrors}
  • Default: false

dialyzerWithDependencies:

Setting this to true will include the projects dependencies into the dialyzer run. Note: This may take very long.
  • Type: boolean
  • Required: No
  • Expression: ${dialyzerWithDependencies}
  • Default: false

skipDialyzer:

Setting this to true will skip the dialyzer analysis.
  • Type: boolean
  • Required: No
  • Expression: ${skipDialyzer}
  • Default: false