sbt-compiler:compile

Full name:

com.google.code.sbt-compiler-maven-plugin:sbt-compiler-maven-plugin:1.0.0-beta9:compile

Description:

Compile Scala and Java main sources.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Since version: 1.0.0.
  • Binds by default to the lifecycle phase: compile.

Optional Parameters

Name Type Since Description
excludes Set 1.0.0 Source exclusion filters for the compiler.
includes Set 1.0.0 Source inclusion filters for the compiler.
javacOptions String 1.0.0 Additional parameters for Java compiler.

Space-separated list of parameters. Parameters containing spaces can be enclosed in apostrophes or quotes.
Default value is: -g.
User property is: sbt.javacOptions.
playVersion String 1.0.0 Forced Play! Framework version.

Used to select SBT version in Play! Framework projects based on framework version used. See sbtVersion for more details.
User property is: play2.version.
sbtVersion String 1.0.0 Forced SBT version.

Used to automatically select one of the "well known" SBT compilers if no compiler added explicitly as plugin's dependency. There are three cases possible:
  • If sbtVersion is specified, compatible Compiler implementation is selected and configured to use sbtVersion SBT version for compilation.
  • If sbtVersion is not specified, and playVersion is specified playVersion parameter value is used to indirectly select compatible Compiler implementation and it's Compiler.getDefaultSbtVersion() SBT version used for compilation.
  • If both sbtVersion and playVersion are not specified the most recent Compiler implementation is selected and it's Compiler.getDefaultSbtVersion() SBT version used for compilation.

User property is: sbt.version.
scalaVersion String 1.0.0 Forced Scala version.

If specified, this version of Scala compiler is used for compilation.
If not specified, version of project's org.scala-lang:scala-library dependency is used.
If there is no org.scala-lang:scala-library dependency in the project (in Java only projects), selected compiler's Compiler.getDefaultScalaVersion() is used.
User property is: scala.version.
scalacOptions String 1.0.0 Additional parameters for Scala compiler.

Space-separated list of parameters. Parameters containing spaces can be enclosed in apostrophes or quotes.
Default value is: -deprecation -unchecked.
User property is: sbt.scalacOptions.
scalacPlugins String 1.0.0 Scala compiler plugins.

Space-separated list of plugin definitions in groupId:artifactId:version format.
User property is: sbt.scalacPlugins.
skipMain boolean 1.0.0 Set this to true to bypass compilation of main sources.
User property is: maven.main.skip.
sourceEncoding String 1.0.0 Scala and Java source files encoding.

If not specified, the encoding value will be the value of the file.encoding system property.

-encoding option in scalacOptions or javacOptions overrides this parameter for Scala or Java compiler respectively.
User property is: project.build.sourceEncoding.

Parameter Details

excludes:

Source exclusion filters for the compiler.
  • Type: java.util.Set
  • Since: 1.0.0
  • Required: No

includes:

Source inclusion filters for the compiler.
  • Type: java.util.Set
  • Since: 1.0.0
  • Required: No

javacOptions:

Additional parameters for Java compiler.

Space-separated list of parameters. Parameters containing spaces can be enclosed in apostrophes or quotes.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: sbt.javacOptions
  • Default: -g

playVersion:

Forced Play! Framework version.

Used to select SBT version in Play! Framework projects based on framework version used. See sbtVersion for more details.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: play2.version

sbtVersion:

Forced SBT version.

Used to automatically select one of the "well known" SBT compilers if no compiler added explicitly as plugin's dependency. There are three cases possible:
  • If sbtVersion is specified, compatible Compiler implementation is selected and configured to use sbtVersion SBT version for compilation.
  • If sbtVersion is not specified, and playVersion is specified playVersion parameter value is used to indirectly select compatible Compiler implementation and it's Compiler.getDefaultSbtVersion() SBT version used for compilation.
  • If both sbtVersion and playVersion are not specified the most recent Compiler implementation is selected and it's Compiler.getDefaultSbtVersion() SBT version used for compilation.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: sbt.version

scalaVersion:

Forced Scala version.

If specified, this version of Scala compiler is used for compilation.
If not specified, version of project's org.scala-lang:scala-library dependency is used.
If there is no org.scala-lang:scala-library dependency in the project (in Java only projects), selected compiler's Compiler.getDefaultScalaVersion() is used.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: scala.version

scalacOptions:

Additional parameters for Scala compiler.

Space-separated list of parameters. Parameters containing spaces can be enclosed in apostrophes or quotes.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: sbt.scalacOptions
  • Default: -deprecation -unchecked

scalacPlugins:

Scala compiler plugins.

Space-separated list of plugin definitions in groupId:artifactId:version format.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: sbt.scalacPlugins

skipMain:

Set this to true to bypass compilation of main sources.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: maven.main.skip

sourceEncoding:

Scala and Java source files encoding.

If not specified, the encoding value will be the value of the file.encoding system property.

-encoding option in scalacOptions or javacOptions overrides this parameter for Scala or Java compiler respectively.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: project.build.sourceEncoding