erlang:dialyzer

Full name:

eu.lindenbaum:maven-erlang-plugin:2.2.0:dialyzer

Description:

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

The dialyzer can be skipped using the skipDialyzer parameter. Additionally, the user can choose to run dialyzer also on the projects dependencies using the dialyzerWithDependencies parameter. This will be done by default.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: prepare-package.

Optional Parameters

Name Type Since Description
cookie String - The cookie to use for the java and the backend node.
dialyzerOptions String - Additional dialyzer warning options. This must be a comma separated list with valid warning atoms that will be included when calling dialyzer:run([{warnings,[...]}, ...]).
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: true.
erlCommand String - The erlang command used to start an erlang backend node. The path must exist and the destination must be executable. If the given command does not fullfill these requirements erl is used (assuming the command is part of the hosts PATH). The path must not contain any arguments.
skipDialyzer boolean - Setting this to true will skip the dialyzer analysis.
Default value is: false.

Parameter Details

cookie:

The cookie to use for the java and the backend node.
  • Type: java.lang.String
  • Required: No
  • Expression: ${cookie}

dialyzerOptions:

Additional dialyzer warning options. This must be a comma separated list with valid warning atoms that will be included when calling dialyzer:run([{warnings,[...]}, ...]).
  • Type: java.lang.String
  • Required: No
  • Expression: ${dialyzerOptions}

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: true

erlCommand:

The erlang command used to start an erlang backend node. The path must exist and the destination must be executable. If the given command does not fullfill these requirements erl is used (assuming the command is part of the hosts PATH). The path must not contain any arguments.
  • Type: java.lang.String
  • Required: No
  • Expression: ${erlCommand}

skipDialyzer:

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