Movatterモバイル変換

[0]ホーム
URL:

scala-maven-plugin

Scala-lang

Build with Maven

scala:compile

Full name:

net.alchim31.maven:scala-maven-plugin:4.9.3:compile

Description:

Compiles a directory of Scala source. Corresponds roughly to the compile goal of the maven-compiler-plugin

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope:compile.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to thelifecycle phase:compile.

Required Parameters

NameTypeSinceDescription
<displayCmd>boolean-Display the command line called ? (property 'maven.scala.displayCmd' replaced by 'displayCmd')
Default:false
User Property:displayCmd

Optional Parameters

NameTypeSinceDescription
<addJavacArgs>String-Alternative method for specifying javac arguments (when using incremental compiler). Can be used from command line with -DaddJavacArgs=arg1|arg2|arg3|... rather than in pom.xml.
User Property:addJavacArgs
<addScalacArgs>String-Additional parameter to use to call the main class. Use this parameter only from command line ("-DaddScalacArgs=arg1|arg2|arg3|..."), not from pom.xml. To define compiler arguments in pom.xml see the "args" parameter.
User Property:addScalacArgs
<additionalDependencies>Dependency[]-Additional dependencies to be added to the classpath. This can be useful in situations where a dependency is needed at compile time, but should not be treated as a dependency in the published POM.
User Property:additionalDependencies
<analysisCacheFile>File-Analysis cache file for incremental recompilation.
Default:${project.build.directory}/analysis/compile
User Property:analysisCacheFile
<args>String[]-compiler additional arguments
<checkMultipleScalaVersions>boolean-Check if every dependencies use the same version of scala-library or scala.compat.version.
Default:true
User Property:maven.scala.checkConsistency
<classpath>Classpath-
Deprecated.
No reason given

List of directories or jars to add to the classpath. @Deprecated UseadditionalDependencies instead.
User Property:classpath
<compileOrder>CompileOrder-Compile order for Scala and Java sources for sbt incremental compile.

Can be Mixed, JavaThenScala, or ScalaThenJava.


Default:Mixed
User Property:compileOrder
<compilerPlugins>BasicArtifact[]-Compiler plugin dependencies to use when compiling. ex:
<compilerPlugins>  <compilerPlugin>    <groupId>my.scala.plugin</groupId>    <artifactId>amazingPlugin</artifactId>    <version>1.0-SNAPSHOT</version>  </compilerPlugin></compilerPlugins>
<dependencies>BasicArtifact[]-Additional dependencies/jar to add to classpath to run "scalaClassName" (scope and optional field not supported) ex :
   <dependencies>     <dependency>       <groupId>org.scala-tools</groupId>       <artifactId>scala-compiler-addon</artifactId>       <version>1.0-SNAPSHOT</version>     </dependency>   </dependencies>
<encoding>String-The -encoding argument for the Java compiler. (when using incremental compiler).
Default:UTF-8
User Property:project.build.sourceEncoding
<excludes>Set<String>-A list of exclusion filters for the compiler. ex :
   <excludes>     <exclude>SomeBadFile.scala</exclude>   </excludes>
<failOnMultipleScalaVersions>boolean-Determines if a detection of multiple scala versions in the dependencies will cause the build to fail.
Default:false
<forceUseArgFile>boolean-Force the use of an external ArgFile to run any forked process.
Default:false
<fork>boolean-Forks the execution of scalac into a separate process.
Default:true
<includes>Set<String>-A list of inclusion filters for the compiler. ex :
   <includes>     <include>SomeFile.scala</include>   </includes>
<javacArgs>String[]-Arguments for javac (when using incremental compiler).
User Property:javacArgs
<javacGenerateDebugSymbols>boolean-Whether to instruct javac to generate debug symbols (when using incremental compiler)
See also:://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#debug
Default:true
User Property:javacGenerateDebugSymbols
<jvmArgs>String[]-Jvm Arguments.
<notifyCompilation>boolean-notifyCompilation if true then print a message "path: compiling" for each root directory or files that will be compiled. Useful for debug, and for integration with Editor/IDE to reset markers only for compiled files.
Default:true
User Property:notifyCompilation
<outputDir>File-The directory in which to place compilation output
Default:${project.build.outputDirectory}
User Property:outputDir
<pluginArtifacts>List<Artifact>-List of artifacts to run plugin
Default:${plugin.artifacts}
<recompileMode>ScalaCompilerSupport$RecompileMode-Recompile mode to use when sources were previously compiled and there is at least one change, seeRecompileMode.
Default:incremental
User Property:recompileMode
<release>String-The --release argument for the Java compiler (when using incremental compiler), supported since Java9.
User Property:maven.compiler.release
<scalaClassName>String-override the className (FQN) of the scala tool
User Property:maven.scala.className
<scalaCompatVersion>String-Scala 's version to use to check binary compatibility (like suffix in artifactId of dependency). If it is defined then it is used to checkMultipleScalaVersions
User Property:scala.compat.version
<scalaHome>String-Path to Scala installation to use instead of the artifact (define as dependencies).
User Property:scala.home
<scalaOrganization>String-Organization/group ID of the Scala used in the project. Default value is 'org.scala-lang'. This is an advanced setting used for clones of the Scala Language. It should be disregarded in standard use cases.
Default:org.scala-lang
User Property:scala.organization
<scalaVersion>String-Scala 's version to use. (property 'maven.scala.version' replaced by 'scala.version')
User Property:scala.version
<secondaryCacheDir>File-Location of the incremental compile will install compiled compiler bridge jars. Default is sbt's "~/.sbt/1.0/zinc/org.scala-sbt".
User Property:secondaryCacheDir
<sendJavaToScalac>boolean-Enables/Disables sending java source to the scala compiler.
Default:true
<skipMain>boolean-Set this to 'true' to bypass compilation of main sources. Its use is NOT RECOMMENDED, but quite convenient on occasion.
User Property:maven.main.skip
<source>String-The -source argument for the Java compiler (when using incremental compiler).
User Property:maven.compiler.source
<sourceDir>File-The directory which contains scala/java source files
Default:${project.build.sourceDirectory}/../scala
<target>String-The -target argument for the Java compiler (when using incremental compiler).
User Property:maven.compiler.target
<useCanonicalPath>boolean-Should use CanonicalPath to normalize path (true => getCanonicalPath, false => getAbsolutePath)
See also:https://github.com/davidB/scala-maven-plugin/issues/50
Default:true
User Property:maven.scala.useCanonicalPath

Parameter Details

<addJavacArgs>

Alternative method for specifying javac arguments (when using incremental compiler). Can be used from command line with -DaddJavacArgs=arg1|arg2|arg3|... rather than in pom.xml.
  • Type:java.lang.String
  • Required:No
  • User Property:addJavacArgs

<addScalacArgs>

Additional parameter to use to call the main class. Use this parameter only from command line ("-DaddScalacArgs=arg1|arg2|arg3|..."), not from pom.xml. To define compiler arguments in pom.xml see the "args" parameter.
  • Type:java.lang.String
  • Required:No
  • User Property:addScalacArgs

<additionalDependencies>

Additional dependencies to be added to the classpath. This can be useful in situations where a dependency is needed at compile time, but should not be treated as a dependency in the published POM.
  • Type:org.apache.maven.model.Dependency[]
  • Required:No
  • User Property:additionalDependencies

<analysisCacheFile>

Analysis cache file for incremental recompilation.
  • Type:java.io.File
  • Required:No
  • User Property:analysisCacheFile
  • Default:${project.build.directory}/analysis/compile

<args>

compiler additional arguments
  • Type:java.lang.String[]
  • Required:No

<checkMultipleScalaVersions>

Check if every dependencies use the same version of scala-library or scala.compat.version.
  • Type:boolean
  • Required:No
  • User Property:maven.scala.checkConsistency
  • Default:true

<classpath>

Deprecated.
No reason given

List of directories or jars to add to the classpath. @Deprecated UseadditionalDependencies instead.
  • Type:scala_maven.Classpath
  • Required:No
  • User Property:classpath

<compileOrder>

Compile order for Scala and Java sources for sbt incremental compile.

Can be Mixed, JavaThenScala, or ScalaThenJava.

  • Type:xsbti.compile.CompileOrder
  • Required:No
  • User Property:compileOrder
  • Default:Mixed

<compilerPlugins>

Compiler plugin dependencies to use when compiling. ex:
<compilerPlugins>  <compilerPlugin>    <groupId>my.scala.plugin</groupId>    <artifactId>amazingPlugin</artifactId>    <version>1.0-SNAPSHOT</version>  </compilerPlugin></compilerPlugins>
  • Type:scala_maven.BasicArtifact[]
  • Required:No

<dependencies>

Additional dependencies/jar to add to classpath to run "scalaClassName" (scope and optional field not supported) ex :
   <dependencies>     <dependency>       <groupId>org.scala-tools</groupId>       <artifactId>scala-compiler-addon</artifactId>       <version>1.0-SNAPSHOT</version>     </dependency>   </dependencies>
  • Type:scala_maven.BasicArtifact[]
  • Required:No

<displayCmd>

Display the command line called ? (property 'maven.scala.displayCmd' replaced by 'displayCmd')
  • Type:boolean
  • Required:Yes
  • User Property:displayCmd
  • Default:false

<encoding>

The -encoding argument for the Java compiler. (when using incremental compiler).
  • Type:java.lang.String
  • Required:No
  • User Property:project.build.sourceEncoding
  • Default:UTF-8

<excludes>

A list of exclusion filters for the compiler. ex :
   <excludes>     <exclude>SomeBadFile.scala</exclude>   </excludes>
  • Type:java.util.Set<java.lang.String>
  • Required:No

<failOnMultipleScalaVersions>

Determines if a detection of multiple scala versions in the dependencies will cause the build to fail.
  • Type:boolean
  • Required:No
  • Default:false

<forceUseArgFile>

Force the use of an external ArgFile to run any forked process.
  • Type:boolean
  • Required:No
  • Default:false

<fork>

Forks the execution of scalac into a separate process.
  • Type:boolean
  • Required:No
  • Default:true

<includes>

A list of inclusion filters for the compiler. ex :
   <includes>     <include>SomeFile.scala</include>   </includes>
  • Type:java.util.Set<java.lang.String>
  • Required:No

<javacArgs>

Arguments for javac (when using incremental compiler).
  • Type:java.lang.String[]
  • Required:No
  • User Property:javacArgs

<javacGenerateDebugSymbols>

Whether to instruct javac to generate debug symbols (when using incremental compiler)
See also:://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#debug
  • Type:boolean
  • Required:No
  • User Property:javacGenerateDebugSymbols
  • Default:true

<jvmArgs>

Jvm Arguments.
  • Type:java.lang.String[]
  • Required:No

<notifyCompilation>

notifyCompilation if true then print a message "path: compiling" for each root directory or files that will be compiled. Useful for debug, and for integration with Editor/IDE to reset markers only for compiled files.
  • Type:boolean
  • Required:No
  • User Property:notifyCompilation
  • Default:true

<outputDir>

The directory in which to place compilation output
  • Type:java.io.File
  • Required:No
  • User Property:outputDir
  • Default:${project.build.outputDirectory}

<pluginArtifacts>

List of artifacts to run plugin
  • Type:java.util.List<org.apache.maven.artifact.Artifact>
  • Required:No
  • Default:${plugin.artifacts}

<recompileMode>

Recompile mode to use when sources were previously compiled and there is at least one change, seeRecompileMode.
  • Type:scala_maven.ScalaCompilerSupport$RecompileMode
  • Required:No
  • User Property:recompileMode
  • Default:incremental

<release>

The --release argument for the Java compiler (when using incremental compiler), supported since Java9.
  • Type:java.lang.String
  • Required:No
  • User Property:maven.compiler.release

<scalaClassName>

override the className (FQN) of the scala tool
  • Type:java.lang.String
  • Required:No
  • User Property:maven.scala.className

<scalaCompatVersion>

Scala 's version to use to check binary compatibility (like suffix in artifactId of dependency). If it is defined then it is used to checkMultipleScalaVersions
  • Type:java.lang.String
  • Required:No
  • User Property:scala.compat.version

<scalaHome>

Path to Scala installation to use instead of the artifact (define as dependencies).
  • Type:java.lang.String
  • Required:No
  • User Property:scala.home

<scalaOrganization>

Organization/group ID of the Scala used in the project. Default value is 'org.scala-lang'. This is an advanced setting used for clones of the Scala Language. It should be disregarded in standard use cases.
  • Type:java.lang.String
  • Required:No
  • User Property:scala.organization
  • Default:org.scala-lang

<scalaVersion>

Scala 's version to use. (property 'maven.scala.version' replaced by 'scala.version')
  • Type:java.lang.String
  • Required:No
  • User Property:scala.version

<secondaryCacheDir>

Location of the incremental compile will install compiled compiler bridge jars. Default is sbt's "~/.sbt/1.0/zinc/org.scala-sbt".
  • Type:java.io.File
  • Required:No
  • User Property:secondaryCacheDir

<sendJavaToScalac>

Enables/Disables sending java source to the scala compiler.
  • Type:boolean
  • Required:No
  • Default:true

<skipMain>

Set this to 'true' to bypass compilation of main sources. Its use is NOT RECOMMENDED, but quite convenient on occasion.
  • Type:boolean
  • Required:No
  • User Property:maven.main.skip

<source>

The -source argument for the Java compiler (when using incremental compiler).
  • Type:java.lang.String
  • Required:No
  • User Property:maven.compiler.source

<sourceDir>

The directory which contains scala/java source files
  • Type:java.io.File
  • Required:No
  • Default:${project.build.sourceDirectory}/../scala

<target>

The -target argument for the Java compiler (when using incremental compiler).
  • Type:java.lang.String
  • Required:No
  • User Property:maven.compiler.target

<useCanonicalPath>

Should use CanonicalPath to normalize path (true => getCanonicalPath, false => getAbsolutePath)
See also:https://github.com/davidB/scala-maven-plugin/issues/50
  • Type:boolean
  • Required:No
  • User Property:maven.scala.useCanonicalPath
  • Default:true
[8]ページ先頭
©2009-2025 Movatter.jp