erlang:dialyzer

Full name:

net.sf.maven-erlang:erlang-plugin:1.0-SNAPSHOT:dialyzer

Description:

Run dialyzer on the generated beam files.

Attributes:

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

Optional Parameters

Name Type Since Description
beamDirectory File - Directory where the beam files are created.
debugInfo boolean - If debugging information should be included. Default value is: false.
dialyzerOptions String[] - Additional dialyzer options.
dialyzerWarningsAreErrors boolean - If dialyzer warnings are to be considered as errors. Default value is: false.
dialyzerWithDependencies boolean - If dialyzer should be run with the dependencies. This is *much* slower. Default value is: false.
erlPath String - Path to the erlang installation directory.
erlcOptions String[] - Additional compilation options.
forceDialyzer boolean - Set this to 'true' to force running dialyzer, i.e. even if beams are not newer than latest run.
libDirectory File - Directories where dependencies are unpacked. This directory contains OTP applications (name-version directories, with include and ebin sub directories).
maven_test_skip boolean - Set this to 'true' to skip running tests. This also skips dialyzer.
skipDialyzer boolean - Set this to 'true' to skip dialyzer.
useDialyzer boolean - If we should run dialyzer on the generated binaries. Default value is: false.

Parameter Details

beamDirectory :

Directory where the beam files are created.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/ebin/

debugInfo :

If debugging information should be included.
  • Type: boolean
  • Required: No
  • Default: false

dialyzerOptions :

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

dialyzerWarningsAreErrors :

If dialyzer warnings are to be considered as errors.
  • Type: boolean
  • Required: No
  • Default: false

dialyzerWithDependencies :

If dialyzer should be run with the dependencies. This is *much* slower.
  • Type: boolean
  • Required: No
  • Default: false

erlPath :

Path to the erlang installation directory.
  • Type: java.lang.String
  • Required: No

erlcOptions :

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

forceDialyzer :

Set this to 'true' to force running dialyzer, i.e. even if beams are not newer than latest run.
  • Type: boolean
  • Required: No
  • Expression: ${forceDialyzer}

libDirectory :

Directories where dependencies are unpacked. This directory contains OTP applications (name-version directories, with include and ebin sub directories).
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/lib/

maven_test_skip :

Set this to 'true' to skip running tests. This also skips dialyzer.
  • Type: boolean
  • Required: No
  • Expression: ${maven.test.skip}

skipDialyzer :

Set this to 'true' to skip dialyzer.
  • Type: boolean
  • Required: No
  • Expression: ${skipDialyzer}

useDialyzer :

If we should run dialyzer on the generated binaries.
  • Type: boolean
  • Required: No
  • Default: false