scala:console

Full name:

org.scala-tools:maven-scala-plugin:2.15.1:console

Description:

Run the Scala console with all the classes of the projects (dependencies and builded)

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Executes by direct invocation only.
  • Requires dependency resolution of artifacts in scope: test.
  • Is NOT inherited by default in multi-project builds.

Required Parameters

Name Type Since Description
displayCmd boolean - Display the command line called ? (property 'maven.scala.displayCmd' replaced by 'displayCmd')
Default value is: false.
mainConsole String - The console to run.
Default value is: scala.tools.nsc.MainGenericRunner.
scalaClassName String - className (FQN) of the scala tool to provide as
Default value is: scala.tools.nsc.Main.
useRuntimeClasspath boolean - Add the runtime classpath, to the console's classpath ?
Default value is: true.
useTestClasspath boolean - Add the test classpath (include classes from test directory), to the console's classpath ?
Default value is: true.

Optional Parameters

Name Type Since Description
args String[] - compiler additionnals arguments
checkMultipleScalaVersions boolean - Check if every dependencies use the same version of scala-library.
Default value is: true.
compilerPlugins BasicArtifact[] - Compiler plugin dependencies to use when compiling. ex:
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>

failOnMultipleScalaVersions boolean - Determines if a detection of multiple scala versions in the dependencies will cause the build to fail.
Default value is: false.
forceUseArgFile boolean - Force the use of an external ArgFile to run any forked process.
Default value is: false.
fork boolean - Forks the execution of scalac into a separate process.
Default value is: true.
javaRebelPath File - Path of the javaRebel jar. If this option is set then the console run with javarebel enabled.
jvmArgs String[] - Jvm Arguments.
scalaVersion String - Scala 's version to use. (property 'maven.scala.version' replaced by 'scala.version')

Parameter Details

args:

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

checkMultipleScalaVersions:

Check if every dependencies use the same version of scala-library.
  • Type: boolean
  • Required: No
  • Expression: ${maven.scala.checkConsistency}
  • Default: true

compilerPlugins:

Compiler plugin dependencies to use when compiling. ex:
  • Type: org_scala_tools_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: org_scala_tools_maven.BasicArtifact[]
  • Required: No

displayCmd:

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

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

javaRebelPath:

Path of the javaRebel jar. If this option is set then the console run with javarebel enabled.
  • Type: java.io.File
  • Required: No
  • Expression: ${javarebel.jar.path}

jvmArgs:

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

mainConsole:

The console to run.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${mainConsole}
  • Default: scala.tools.nsc.MainGenericRunner

scalaClassName:

className (FQN) of the scala tool to provide as
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${maven.scala.className}
  • Default: scala.tools.nsc.Main

scalaVersion:

Scala 's version to use. (property 'maven.scala.version' replaced by 'scala.version')
  • Type: java.lang.String
  • Required: No
  • Expression: ${scala.version}

useRuntimeClasspath:

Add the runtime classpath, to the console's classpath ?
  • Type: boolean
  • Required: Yes
  • Expression: ${maven.scala.console.useRuntimeClasspath}
  • Default: true

useTestClasspath:

Add the test classpath (include classes from test directory), to the console's classpath ?
  • Type: boolean
  • Required: Yes
  • Expression: ${maven.scala.console.useTestClasspath}
  • Default: true