scoverage:pre-compile

Full name:

org.scoverage:scoverage-maven-plugin:1.4.1:pre-compile

Description:

Configures project for compilation with SCoverage instrumentation.

Supported compiler plugins:
This is internal mojo, executed in forked scoverage life cycle.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.0.0.
  • Binds by default to the lifecycle phase: generate-resources.

Optional Parameters

Name Type Since Description
<additionalForkedProjectProperties> String 1.4.0 Semicolon-separated list of project properties set in forked scoverage life cycle.

Example:
prop1=val1;prop2=val2;prop3=val3

User property is: scoverage.additionalForkedProjectProperties.
<excludedFiles> String 1.0.0 Semicolon-separated list of regular expressions for source paths to exclude.

User property is: scoverage.excludedFiles.
<excludedPackages> String 1.0.0 Semicolon-separated list of regular expressions for packages to exclude, "(empty)" for default package.

Example:
(empty);Reverse.*;.*AuthService.*;models\.data\..*

See https://github.com/scoverage/sbt-scoverage#exclude-classes-and-packages for additional documentation.

User property is: scoverage.excludedPackages.
<highlighting> boolean 1.0.0 See https://github.com/scoverage/sbt-scoverage#highlighting.

Default value is: true.
User property is: scoverage.highlighting.
<scalaVersion> String 1.0.0 Scala version used for compiler plugin artifact resolution.
  • if specified, and equals 2.10 or starts with 2.10. - scalac-scoverage-plugin_2.10 will be used
  • if specified, and equals 2.11 or starts with 2.11. - scalac-scoverage-plugin_2.11 will be used
  • if specified, and equals 2.12 or starts with 2.12. - scalac-scoverage-plugin_2.12 will be used
  • if specified, and equals 2.13 or starts with 2.13. - scalac-scoverage-plugin_2.13 will be used
  • if specified, but does not meet any of the above conditions or if not specified - plugin execution will be skipped

User property is: scala.version.
<scalacPluginVersion> String 1.0.0 Force scalac-scoverage-plugin version used.

User property is: scoverage.scalacPluginVersion.
<skip> boolean 1.0.0 Allows SCoverage to be skipped.

Default value is: false.
User property is: scoverage.skip.

Parameter Details

<additionalForkedProjectProperties>

Semicolon-separated list of project properties set in forked scoverage life cycle.

Example:
prop1=val1;prop2=val2;prop3=val3
  • Type: java.lang.String
  • Since: 1.4.0
  • Required: No
  • User Property: scoverage.additionalForkedProjectProperties

<excludedFiles>

Semicolon-separated list of regular expressions for source paths to exclude.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: scoverage.excludedFiles

<excludedPackages>

Semicolon-separated list of regular expressions for packages to exclude, "(empty)" for default package.

Example:
(empty);Reverse.*;.*AuthService.*;models\.data\..*

See https://github.com/scoverage/sbt-scoverage#exclude-classes-and-packages for additional documentation.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: scoverage.excludedPackages

<highlighting>

  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: scoverage.highlighting
  • Default: true

<scalaVersion>

Scala version used for compiler plugin artifact resolution.
  • if specified, and equals 2.10 or starts with 2.10. - scalac-scoverage-plugin_2.10 will be used
  • if specified, and equals 2.11 or starts with 2.11. - scalac-scoverage-plugin_2.11 will be used
  • if specified, and equals 2.12 or starts with 2.12. - scalac-scoverage-plugin_2.12 will be used
  • if specified, and equals 2.13 or starts with 2.13. - scalac-scoverage-plugin_2.13 will be used
  • if specified, but does not meet any of the above conditions or if not specified - plugin execution will be skipped
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: scala.version

<scalacPluginVersion>

Force scalac-scoverage-plugin version used.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: scoverage.scalacPluginVersion

<skip>

Allows SCoverage to be skipped.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: scoverage.skip
  • Default: false