Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal Report? Description
scala:add-source No Add more source directories to the POM.
scala:cc No Compile the main and test scala source directory in continuous (infinite loop). !! This is an util goal for commandline usage only (Do not use or call it in a pom) !!!
scala:cctest No Compile the main and test scala source directory then run unit test cases in continuous (infinite loop). This is an utility goal for command line usage only (Do not use or call it in a pom) !!!
scala:compile No Compiles a directory of Scala source. Corresponds roughly to the compile goal of the maven-compiler-plugin
scala:console No Run the Scala console with all the classes of the projects (dependencies and built)
scala:doc Yes Produces Scala API documentation.
scala:doc-jar Yes Creates a jar of the non-aggregated scaladoc and attaches it to the project for distribution.
scala:help No Display the Scala Compiler help
scala:run No Run a Scala class using the Scala runtime
scala:script No Run a scala script.
scala:testCompile No Compile Scala test source into test-classes. Corresponds roughly to testCompile in maven-compiler-plugin

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.3.9
JDK 1.8

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version Maven JDK
from 4.0.0 to 4.9.2 3.3.9 8
from 3.4.4 to 3.4.6 3.3.9 6
3.4.2 3.5.4 6
from 3.3.3 to 3.4.1 3.5.3 6
from 3.1.1 to 3.3.2 3.0.4 6
from 3.0.2 to 3.1.0 3.0 5
from 3.0.0 to 3.0.1 2.2.1 5

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>net.alchim31.maven</groupId>
          <artifactId>scala-maven-plugin</artifactId>
          <version>4.9.2</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>net.alchim31.maven</groupId>
        <artifactId>scala-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>net.alchim31.maven</groupId>
        <artifactId>scala-maven-plugin</artifactId>
        <version>4.9.2</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"