Fork me on GitHub
Built by Maven

scalor:scaladoc-test

Full name:

com.carrotgarden.maven:scalor-maven-plugin_2.12:1.5.0.20190502181145:scaladoc-test

Description:

Produce project Scaladoc artifact for compilation scope=test. A member of goal=scaladoc.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
<buildTestDependencyFolders> File[] - Project folders containing build classes which are dependency for compilation scope=test. Normally includes folder scope=[macro,main,test] (target/classes, target/test-classes).
Default value is: ${project.build.outputDirectory},${project.build.testOutputDirectory}.
User property is: scalor.buildTestDependencyFolders.
<buildTestDependencyScopes> String[] - Maven dependency scopes which control selection of project dependency artifacts to be included in the classpath of compilation scope=test. Scopes reference.
Default value is: compile,provided,system,test,runtime.
User property is: scalor.buildTestDependencyScopes.
<buildTestResourceFolders> Resource[] - Resource root folders to be included in compilation scope=test. Absolute path. Normally uses src/test/resources. Component reference: Resource . Example custom entry in pom.xml: 
<buildTestResourceFolders>
  <resource>
    <directory>${project.basedir}/src/test/resources</directory>
  </resource>  
  <resource>
    <directory>${project.basedir}/target/generated/test/resources</directory>
  </resource>  
</buildTestResourceFolders>

Default value is: ${project.build.testResources}.
User property is: scalor.buildTestResourceFolders.
<buildTestSourceJavaFolders> File[] - Java source root folders to be included in compilation scope=test. Absolute path. Normally uses src/test/java. Example custom entry in pom.xml: 
<buildTestSourceJavaFolders>
  <source>${project.build.testSourceDirectory}</source>
  <source>${project.basedir}/target/generated/test/java</source>
</buildTestSourceJavaFolders>

Default value is: ${project.build.testSourceDirectory}.
User property is: scalor.buildTestSourceJavaFolders.
<buildTestSourceScalaFolders> File[] - Scala source root folders to be included in compilation scope=test. Absolute path. Normally uses src/test/scala. Example custom entry in pom.xml: 
<buildTestSourceScalaFolders>
  <source>${project.build.testSourceDirectory}/../scala</source>
  <source>${project.basedir}/target/generated/test/scala</source>
</buildTestSourceScalaFolders>

Default value is: ${project.build.testSourceDirectory}/../scala.
User property is: scalor.buildTestSourceScalaFolders.
<buildTestTargetFolder> File - Build target folder with result classes of compilation scope=test. Normally uses target/test-classes.
Default value is: ${project.build.testOutputDirectory}.
User property is: scalor.buildTestTargetFolder.
<commonMappingPattern> String - Regular expression for plugin configuration map values provided in pom.xml. Extractor for pattern: key=value. Must define exactly two regex capture groups. Mapping regular expression is used as follows: 
  case commonMappingPattern.r( key, value ) => ( key, value )
Note: <![CDATA[ ... ]]> brackets can help preserve text entries in pom.xml.
Default value is: \s*([^=\s]+)\s*=\s*([^\s]+)\s*.
User property is: scalor.commonMappingPattern.
<commonSequenceSeparator> String - Separator for plugin configuration list values provided in pom.xml. Separator regular expression is used as follows: 
  string.split( commonSequenceSeparator ).map( _.trim ).filterNot( _.isEmpty )
Note: <![CDATA[ ... ]]> brackets can help preserve text entries in pom.xml. Note: to insert unicode symbol in Eclipse/GTK, type CTRL+SHIFT+U, then XXXX - a 4-hex-digit unicode value. For example, for star ★, use hex code 2605.
Default value is: [★\n]+.
User property is: scalor.commonSequenceSeparator.
<defineAuto> boolean - Enable auto-discovery of defineBridge and defineCompiler dependencies. When false, bridge and compiler definitions must be explicitly provided in pom.xml. When true, plugin will use the following bridge and compiler dependency discovery heuristic:
  1. check for bridge and compiler defined in pom.xml, if yes - use that, if not - try auto define:
  2. find scala-library on project build class path with help of regexScalaLibrary
  3. determine Scala epoch X.Y and release X.Y.Z versions of Scala Library
  4. construct compiler-bridge dependency from:
    • discovered project Scala epoch version
    • bridge artifact included with the plugin
    • with help of regexCompilerBridge
  5. construct scala-compiler dependency from:
    • discovered project Scala release version
    • compiler artifact included with the plugin
    • with help of regexScalaCompiler
Use zincLogBridgeClassPath to review actual resolved bridge artifact in Maven. Use zincLogCompilerClassPath to review actual resolved compiler artifact in Maven. Use eclipseLogPersistInstall to review actual resolved compiler artifact in Eclipse (bridge is managed by Scala IDE).
Default value is: true.
User property is: scalor.defineAuto.
<defineBridge> Dependency[] - Provide Scala compiler bridge dependency. Can declare here additional dependencies for the bridge. Bridge artifact must match expected regular expression in regexCompilerBridge. Example entry in pom.xml: 
<defineBridge>
  <dependency>
      <groupId>org.scala-sbt</groupId>
      <artifactId>compiler-bridge_${version.scala.epoch}</artifactId>
      <version>${version.scala.zinc}</version>
  </dependency>
</defineBridge>
This dependency list is empty by default.
<defineCompiler> Dependency[] - Provide Scala compiler dependency. Can declare here additional dependencies for the compiler. Compiler artifact must match expected regular expression in regexScalaCompiler. Example entry in pom.xml: 
<defineCompiler>
  <dependency>
      <groupId>org.scala-lang</groupId>
      <artifactId>scala-compiler</artifactId>
      <version>${version.scala.release}</version>
  </dependency>
</defineCompiler>
This dependency list is empty by default.
<definePluginList> Dependency[] - Provide Scala plugins dependency. Can declare mulitiple scala compiler plugins. Plugin artifact jar must contain expected descriptor resource in resourcePluginDescriptor. Example entry in pom.xml: 
<definePluginList>
  <dependency>
      <groupId>org.scala-js</groupId>
      <artifactId>scalajs-compiler_${version.scala.release}</artifactId>
      <version>${version.sjs.release}</version>
  </dependency>
</definePluginList>
This dependency list is empty by default.
<regexCompilerBridge> String - Maven identity of Scala bridge artifact. Regular expression in the form: ${groupId}:${artifactId}. Used for auto discovery of compiler-bridge from defineBridge.
Default value is: org.scala-sbt:compiler-bridge_.+.
User property is: scalor.regexCompilerBridge.
<regexScalaCompiler> String - Maven identity of Scala compiler artifact. Regular expression in the form: ${groupId}:${artifactId}. Used for auto discovery of scala-compiler from defineCompiler.
Default value is: org.scala-lang:scala-compiler.
User property is: scalor.regexScalaCompiler.
<regexScalaLibrary> String - Maven identity of Scala library artifact. Regular expression in the form: ${groupId}:${artifactId}. Used for auto discovery of scala-library from defineCompiler.
Default value is: org.scala-lang:scala-library.
User property is: scalor.regexScalaLibrary.
<resourcePluginDescriptor> String - Scala compiler plugin descriptor file name, stored inside compiler plugin jar. Used for auto discovery of Scala compiler plugins form definePluginList. Plain file name, not a regex.
Default value is: scalac-plugin.xml.
User property is: scalor.resourcePluginDescriptor.
<scaladocArchiveConfig> MavenArchiveConfiguration - Configuration of Scaladoc archive jar. Normally used with provided default values. Component reference: MavenArchiveConfiguration
<scaladocFinalName> String - Root name for the generated Scaladoc jar file. Full name will include classifier suffix.
Default value is: ${project.build.finalName}.
User property is: scalor.scaladocFinalName.
<scaladocRegexJavaExclude> String - Regular expression for Java source file discovery via exclusion by match against full-path (not just file name). File match is defined as: include.hasMatch && ! exclude.hasMatch. Matches no files when empty by default.
User property is: scalor.scaladocRegexJavaExclude.
<scaladocRegexJavaInclude> String - Regular expression for Java source file discovery via inclusion by match against full-path (not just file name). File match is defined as: include.hasMatch && ! exclude.hasMatch. Matches files with java extension by default.
Default value is: .+[.]java.
User property is: scalor.scaladocRegexJavaInclude.
<scaladocRegexScalaExclude> String - Regular expression for Scala source file discovery via exclusion by match against full-path (not just file name). File match is defined as: include.hasMatch && ! exclude.hasMatch. Matches no files when empty by default.
User property is: scalor.scaladocRegexScalaExclude.
<scaladocRegexScalaInclude> String - Regular expression for Scala source file discovery via inclusion by match against full-path (not just file name). File match is defined as: include.hasMatch && ! exclude.hasMatch. Matches files with scala extension by default.
Default value is: .+[.]scala.
User property is: scalor.scaladocRegexScalaInclude.
<scaladocTestAttach> boolean - Enable to attach generated Scaladoc to the project as deployment artifact with scope=test.
Default value is: true.
User property is: scalor.scaladocTestAttach.
<scaladocTestClassifier> String - Artifact classifier for Scaladoc with scope=test. Using Java convension by default. Appended to scaladocFinalName.
Default value is: test-javadoc.
User property is: scalor.scaladocTestClassifier.
<scaladocTestOutputFolder> File - Folder with generated Scaladoc content with scope=test.
Default value is: ${project.reporting.outputDirectory}/scaladoc-test.
User property is: scalor.scaladocTestOutputFolder.
<skip> boolean - Force to skip all executions of this plugin.
Default value is: false.
User property is: scalor.skip.
<skipLogReason> boolean - Enable logging of reason for skipping an execution.
Default value is: true.
User property is: scalor.skipLogReason.
<skipPackagingList> String[] - List of packaging types, which are skipped by this plugin.
Default value is: pom.
User property is: scalor.skipPackagingList.
<skipScaladoc> boolean - Flag to skip document execution: scaladoc-*.
Default value is: false.
User property is: scalor.skipScaladoc.
<skipScaladocTest> boolean - Flag to skip goal execution: scaladoc-test.
Default value is: false.
User property is: scalor.skipScaladocTest.
<zincCacheTest> File - Location of Zinc incremental compiler state file for scope=test.
Default value is: ${project.build.directory}/scalor/cache/test.zip.
User property is: scalor.zincCacheTest.
<zincCompilerOptionsReport> File - Report available/effective compiler options with help description to the report file. Enablement parameter: zincLogCompilerOptions
Default value is: ${project.build.directory}/scalor/scala-options-report.txt.
User property is: scalor.zincCompilerOptionsReport.
<zincLogActiveLevel> String - Enable Zinc compiler logger output at a given Zinc level. Uses Maven logger at Maven INFO level. Available Zinc logger levels: 
  debug
  info
  warn
  error

Default value is: debug.
User property is: scalor.zincLogActiveLevel.
<zincLogBridgeClassPath> boolean - Enable logging of Zinc compiler-bridge class path discovered from defineBridge. Includes transitive dependency jars.
Default value is: false.
User property is: scalor.zincLogBridgeClassPath.
<zincLogCompilerClassPath> boolean - Enable logging of Zinc scala-compiler class path discovered from defineCompiler. Includes transitive dependency jars.
Default value is: false.
User property is: scalor.zincLogCompilerClassPath.
<zincLogCompilerOptions> boolean - Enable logging of available/effective compiler options with help description. Report output location: zincCompilerOptionsReport
Default value is: false.
User property is: scalor.zincLogCompilerOptions.
<zincLogCompilerPluginList> boolean - Enable logging of Zinc compiler plugins discovered from definePluginList. Includes only plugin jars.
Default value is: false.
User property is: scalor.zincLogCompilerPluginList.
<zincLogProgressRate> boolean - Enable logging of Zinc incremental compiler progress.
Default value is: false.
User property is: scalor.zincLogProgressRate.
<zincLogProgressUnit> boolean - Enable logging of Zinc incremental compiler units.
Default value is: false.
User property is: scalor.zincLogProgressUnit.
<zincLogProjectClassPath> boolean - Enable logging of current project build class path. Includes scope dependency folders and dependency jars.
Default value is: false.
User property is: scalor.zincLogProjectClassPath.
<zincLogSourcesList> boolean - Enable logging of source Java and Scala files.
Default value is: false.
User property is: scalor.zincLogSourcesList.
<zincOptionsJava> String - Options for JavaC compiler used by Zinc invocation. Separator parameter: commonSequenceSeparator.
Default value is: -deprecation ★ -encoding ★ UTF-8 ★ -source ★ 1.8 ★ -target ★ 1.8 ★ .
User property is: scalor.zincOptionsJava.
<zincOptionsScala> String - Combined options for ScalaC compiler, Scalor Plugin Zinc compiler, Scala IDE Plugin Zinc compiler.
  • ScalaC compiler uses [ standard ] options in Maven/Eclipse.
  • Scalor Zinc compiler uses [ standard, compile-order ] options in Maven.
  • Scala IDE Zinc compiler uses [ standard, compile-order, eclipse-builder ] options in Eclipse.
ScalaC compiler options reference: ScalaSettings.scala StandardScalaSettings.scala
Scalor Zinc compiler options reference: IncrementalCompilerImpl.scala
Scala IDE Zinc compiler options reference: IDESettings$ScalaPluginSettings.scala

For consistent Maven vs Eclipse builds, use non-interfering eclipse-builder options. Separator parameter: commonSequenceSeparator. Examine available/effective options via zincLogCompilerOptions.

Options processing steps:
  • options are validated
  • default options are silently removed
  • invalid options are reported and errored
  • -Xplugin options are discovered from definePluginList

Default value is: -feature ★ -unchecked ★ -deprecation ★ -encoding ★ UTF-8 ★ -target:jvm-1.8 ★ -Xmaxerrs ★ 10 ★ -compileorder:Mixed ★ -useScopesCompiler:true ★ -withVersionClasspathValidator:true ★ .
User property is: scalor.zincOptionsScala.
<zincScalaInstallTitle> String - Scala installation title prefix used for Scala installtions generated by this plugin. Actual generated Scala installation will also include a summary, i.e.: Scalor [MD5], where [MD5] is MD5 digest of combined artifact paths included in the installation. Prefix allows to distinguish installations in Scala IDE UI, Scalor plugin reports, Eclipse Maven Console. Review available Scala installation details with: eclipseLogInstallReport.
Default value is: Scalor.
User property is: scalor.zincScalaInstallTitle.
<zincStateStoreType> String - Incremental compiler file analysis store type for the state cache. Available types: 
  text   - compatible with Scala IDE
  binary - high performance serializer

Default value is: text.
User property is: scalor.zincStateStoreType.
<zincVerifyVersion> boolean - Flag to force version constistency check among dependency artifacts discovered from defineBridge, defineCompiler, definePluginList.
Default value is: true.
User property is: scalor.zincVerifyVersion.

Parameter Details

<buildTestDependencyFolders>

Project folders containing build classes which are dependency for compilation scope=test. Normally includes folder scope=[macro,main,test] (target/classes, target/test-classes).
  • Type: java.io.File[]
  • Required: No
  • User Property: scalor.buildTestDependencyFolders
  • Default: ${project.build.outputDirectory},${project.build.testOutputDirectory}

<buildTestDependencyScopes>

Maven dependency scopes which control selection of project dependency artifacts to be included in the classpath of compilation scope=test. Scopes reference.
  • Type: java.lang.String[]
  • Required: No
  • User Property: scalor.buildTestDependencyScopes
  • Default: compile,provided,system,test,runtime

<buildTestResourceFolders>

Resource root folders to be included in compilation scope=test. Absolute path. Normally uses src/test/resources. Component reference: Resource . Example custom entry in pom.xml: 
<buildTestResourceFolders>
  <resource>
    <directory>${project.basedir}/src/test/resources</directory>
  </resource>  
  <resource>
    <directory>${project.basedir}/target/generated/test/resources</directory>
  </resource>  
</buildTestResourceFolders>
  • Type: org.apache.maven.model.Resource[]
  • Required: No
  • User Property: scalor.buildTestResourceFolders
  • Default: ${project.build.testResources}

<buildTestSourceJavaFolders>

Java source root folders to be included in compilation scope=test. Absolute path. Normally uses src/test/java. Example custom entry in pom.xml: 
<buildTestSourceJavaFolders>
  <source>${project.build.testSourceDirectory}</source>
  <source>${project.basedir}/target/generated/test/java</source>
</buildTestSourceJavaFolders>
  • Type: java.io.File[]
  • Required: No
  • User Property: scalor.buildTestSourceJavaFolders
  • Default: ${project.build.testSourceDirectory}

<buildTestSourceScalaFolders>

Scala source root folders to be included in compilation scope=test. Absolute path. Normally uses src/test/scala. Example custom entry in pom.xml: 
<buildTestSourceScalaFolders>
  <source>${project.build.testSourceDirectory}/../scala</source>
  <source>${project.basedir}/target/generated/test/scala</source>
</buildTestSourceScalaFolders>
  • Type: java.io.File[]
  • Required: No
  • User Property: scalor.buildTestSourceScalaFolders
  • Default: ${project.build.testSourceDirectory}/../scala

<buildTestTargetFolder>

Build target folder with result classes of compilation scope=test. Normally uses target/test-classes.
  • Type: java.io.File
  • Required: No
  • User Property: scalor.buildTestTargetFolder
  • Default: ${project.build.testOutputDirectory}

<commonMappingPattern>

Regular expression for plugin configuration map values provided in pom.xml. Extractor for pattern: key=value. Must define exactly two regex capture groups. Mapping regular expression is used as follows: 
  case commonMappingPattern.r( key, value ) => ( key, value )
Note: <![CDATA[ ... ]]> brackets can help preserve text entries in pom.xml.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.commonMappingPattern
  • Default: \s*([^=\s]+)\s*=\s*([^\s]+)\s*

<commonSequenceSeparator>

Separator for plugin configuration list values provided in pom.xml. Separator regular expression is used as follows: 
  string.split( commonSequenceSeparator ).map( _.trim ).filterNot( _.isEmpty )
Note: <![CDATA[ ... ]]> brackets can help preserve text entries in pom.xml. Note: to insert unicode symbol in Eclipse/GTK, type CTRL+SHIFT+U, then XXXX - a 4-hex-digit unicode value. For example, for star ★, use hex code 2605.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.commonSequenceSeparator
  • Default: [★\n]+

<defineAuto>

Enable auto-discovery of defineBridge and defineCompiler dependencies. When false, bridge and compiler definitions must be explicitly provided in pom.xml. When true, plugin will use the following bridge and compiler dependency discovery heuristic:
  1. check for bridge and compiler defined in pom.xml, if yes - use that, if not - try auto define:
  2. find scala-library on project build class path with help of regexScalaLibrary
  3. determine Scala epoch X.Y and release X.Y.Z versions of Scala Library
  4. construct compiler-bridge dependency from:
    • discovered project Scala epoch version
    • bridge artifact included with the plugin
    • with help of regexCompilerBridge
  5. construct scala-compiler dependency from:
    • discovered project Scala release version
    • compiler artifact included with the plugin
    • with help of regexScalaCompiler
Use zincLogBridgeClassPath to review actual resolved bridge artifact in Maven. Use zincLogCompilerClassPath to review actual resolved compiler artifact in Maven. Use eclipseLogPersistInstall to review actual resolved compiler artifact in Eclipse (bridge is managed by Scala IDE).
  • Type: boolean
  • Required: No
  • User Property: scalor.defineAuto
  • Default: true

<defineBridge>

Provide Scala compiler bridge dependency. Can declare here additional dependencies for the bridge. Bridge artifact must match expected regular expression in regexCompilerBridge. Example entry in pom.xml: 
<defineBridge>
  <dependency>
      <groupId>org.scala-sbt</groupId>
      <artifactId>compiler-bridge_${version.scala.epoch}</artifactId>
      <version>${version.scala.zinc}</version>
  </dependency>
</defineBridge>
This dependency list is empty by default.
  • Type: org.apache.maven.model.Dependency[]
  • Required: No

<defineCompiler>

Provide Scala compiler dependency. Can declare here additional dependencies for the compiler. Compiler artifact must match expected regular expression in regexScalaCompiler. Example entry in pom.xml: 
<defineCompiler>
  <dependency>
      <groupId>org.scala-lang</groupId>
      <artifactId>scala-compiler</artifactId>
      <version>${version.scala.release}</version>
  </dependency>
</defineCompiler>
This dependency list is empty by default.
  • Type: org.apache.maven.model.Dependency[]
  • Required: No

<definePluginList>

Provide Scala plugins dependency. Can declare mulitiple scala compiler plugins. Plugin artifact jar must contain expected descriptor resource in resourcePluginDescriptor. Example entry in pom.xml: 
<definePluginList>
  <dependency>
      <groupId>org.scala-js</groupId>
      <artifactId>scalajs-compiler_${version.scala.release}</artifactId>
      <version>${version.sjs.release}</version>
  </dependency>
</definePluginList>
This dependency list is empty by default.
  • Type: org.apache.maven.model.Dependency[]
  • Required: No

<regexCompilerBridge>

Maven identity of Scala bridge artifact. Regular expression in the form: ${groupId}:${artifactId}. Used for auto discovery of compiler-bridge from defineBridge.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.regexCompilerBridge
  • Default: org.scala-sbt:compiler-bridge_.+

<regexScalaCompiler>

Maven identity of Scala compiler artifact. Regular expression in the form: ${groupId}:${artifactId}. Used for auto discovery of scala-compiler from defineCompiler.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.regexScalaCompiler
  • Default: org.scala-lang:scala-compiler

<regexScalaLibrary>

Maven identity of Scala library artifact. Regular expression in the form: ${groupId}:${artifactId}. Used for auto discovery of scala-library from defineCompiler.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.regexScalaLibrary
  • Default: org.scala-lang:scala-library

<resourcePluginDescriptor>

Scala compiler plugin descriptor file name, stored inside compiler plugin jar. Used for auto discovery of Scala compiler plugins form definePluginList. Plain file name, not a regex.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.resourcePluginDescriptor
  • Default: scalac-plugin.xml

<scaladocArchiveConfig>

Configuration of Scaladoc archive jar. Normally used with provided default values. Component reference: MavenArchiveConfiguration
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

<scaladocFinalName>

Root name for the generated Scaladoc jar file. Full name will include classifier suffix.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.scaladocFinalName
  • Default: ${project.build.finalName}

<scaladocRegexJavaExclude>

Regular expression for Java source file discovery via exclusion by match against full-path (not just file name). File match is defined as: include.hasMatch && ! exclude.hasMatch. Matches no files when empty by default.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.scaladocRegexJavaExclude

<scaladocRegexJavaInclude>

Regular expression for Java source file discovery via inclusion by match against full-path (not just file name). File match is defined as: include.hasMatch && ! exclude.hasMatch. Matches files with java extension by default.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.scaladocRegexJavaInclude
  • Default: .+[.]java

<scaladocRegexScalaExclude>

Regular expression for Scala source file discovery via exclusion by match against full-path (not just file name). File match is defined as: include.hasMatch && ! exclude.hasMatch. Matches no files when empty by default.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.scaladocRegexScalaExclude

<scaladocRegexScalaInclude>

Regular expression for Scala source file discovery via inclusion by match against full-path (not just file name). File match is defined as: include.hasMatch && ! exclude.hasMatch. Matches files with scala extension by default.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.scaladocRegexScalaInclude
  • Default: .+[.]scala

<scaladocTestAttach>

Enable to attach generated Scaladoc to the project as deployment artifact with scope=test.
  • Type: boolean
  • Required: No
  • User Property: scalor.scaladocTestAttach
  • Default: true

<scaladocTestClassifier>

Artifact classifier for Scaladoc with scope=test. Using Java convension by default. Appended to scaladocFinalName.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.scaladocTestClassifier
  • Default: test-javadoc

<scaladocTestOutputFolder>

Folder with generated Scaladoc content with scope=test.
  • Type: java.io.File
  • Required: No
  • User Property: scalor.scaladocTestOutputFolder
  • Default: ${project.reporting.outputDirectory}/scaladoc-test

<skip>

Force to skip all executions of this plugin.
  • Type: boolean
  • Required: No
  • User Property: scalor.skip
  • Default: false

<skipLogReason>

Enable logging of reason for skipping an execution.
  • Type: boolean
  • Required: No
  • User Property: scalor.skipLogReason
  • Default: true

<skipPackagingList>

List of packaging types, which are skipped by this plugin.
  • Type: java.lang.String[]
  • Required: No
  • User Property: scalor.skipPackagingList
  • Default: pom

<skipScaladoc>

Flag to skip document execution: scaladoc-*.
  • Type: boolean
  • Required: No
  • User Property: scalor.skipScaladoc
  • Default: false

<skipScaladocTest>

Flag to skip goal execution: scaladoc-test.
  • Type: boolean
  • Required: No
  • User Property: scalor.skipScaladocTest
  • Default: false

<zincCacheTest>

Location of Zinc incremental compiler state file for scope=test.
  • Type: java.io.File
  • Required: No
  • User Property: scalor.zincCacheTest
  • Default: ${project.build.directory}/scalor/cache/test.zip

<zincCompilerOptionsReport>

Report available/effective compiler options with help description to the report file. Enablement parameter: zincLogCompilerOptions
  • Type: java.io.File
  • Required: No
  • User Property: scalor.zincCompilerOptionsReport
  • Default: ${project.build.directory}/scalor/scala-options-report.txt

<zincLogActiveLevel>

Enable Zinc compiler logger output at a given Zinc level. Uses Maven logger at Maven INFO level. Available Zinc logger levels: 
  debug
  info
  warn
  error
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.zincLogActiveLevel
  • Default: debug

<zincLogBridgeClassPath>

Enable logging of Zinc compiler-bridge class path discovered from defineBridge. Includes transitive dependency jars.
  • Type: boolean
  • Required: No
  • User Property: scalor.zincLogBridgeClassPath
  • Default: false

<zincLogCompilerClassPath>

Enable logging of Zinc scala-compiler class path discovered from defineCompiler. Includes transitive dependency jars.
  • Type: boolean
  • Required: No
  • User Property: scalor.zincLogCompilerClassPath
  • Default: false

<zincLogCompilerOptions>

Enable logging of available/effective compiler options with help description. Report output location: zincCompilerOptionsReport
  • Type: boolean
  • Required: No
  • User Property: scalor.zincLogCompilerOptions
  • Default: false

<zincLogCompilerPluginList>

Enable logging of Zinc compiler plugins discovered from definePluginList. Includes only plugin jars.
  • Type: boolean
  • Required: No
  • User Property: scalor.zincLogCompilerPluginList
  • Default: false

<zincLogProgressRate>

Enable logging of Zinc incremental compiler progress.
  • Type: boolean
  • Required: No
  • User Property: scalor.zincLogProgressRate
  • Default: false

<zincLogProgressUnit>

Enable logging of Zinc incremental compiler units.
  • Type: boolean
  • Required: No
  • User Property: scalor.zincLogProgressUnit
  • Default: false

<zincLogProjectClassPath>

Enable logging of current project build class path. Includes scope dependency folders and dependency jars.
  • Type: boolean
  • Required: No
  • User Property: scalor.zincLogProjectClassPath
  • Default: false

<zincLogSourcesList>

Enable logging of source Java and Scala files.
  • Type: boolean
  • Required: No
  • User Property: scalor.zincLogSourcesList
  • Default: false

<zincOptionsJava>

Options for JavaC compiler used by Zinc invocation. Separator parameter: commonSequenceSeparator.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.zincOptionsJava
  • Default: -deprecation ★ -encoding ★ UTF-8 ★ -source ★ 1.8 ★ -target ★ 1.8 ★

<zincOptionsScala>

Combined options for ScalaC compiler, Scalor Plugin Zinc compiler, Scala IDE Plugin Zinc compiler.
  • ScalaC compiler uses [ standard ] options in Maven/Eclipse.
  • Scalor Zinc compiler uses [ standard, compile-order ] options in Maven.
  • Scala IDE Zinc compiler uses [ standard, compile-order, eclipse-builder ] options in Eclipse.
ScalaC compiler options reference: ScalaSettings.scala StandardScalaSettings.scala
Scalor Zinc compiler options reference: IncrementalCompilerImpl.scala
Scala IDE Zinc compiler options reference: IDESettings$ScalaPluginSettings.scala

For consistent Maven vs Eclipse builds, use non-interfering eclipse-builder options. Separator parameter: commonSequenceSeparator. Examine available/effective options via zincLogCompilerOptions.

Options processing steps:
  • options are validated
  • default options are silently removed
  • invalid options are reported and errored
  • -Xplugin options are discovered from definePluginList
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.zincOptionsScala
  • Default: -feature ★ -unchecked ★ -deprecation ★ -encoding ★ UTF-8 ★ -target:jvm-1.8 ★ -Xmaxerrs ★ 10 ★ -compileorder:Mixed ★ -useScopesCompiler:true ★ -withVersionClasspathValidator:true ★

<zincScalaInstallTitle>

Scala installation title prefix used for Scala installtions generated by this plugin. Actual generated Scala installation will also include a summary, i.e.: Scalor [MD5], where [MD5] is MD5 digest of combined artifact paths included in the installation. Prefix allows to distinguish installations in Scala IDE UI, Scalor plugin reports, Eclipse Maven Console. Review available Scala installation details with: eclipseLogInstallReport.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.zincScalaInstallTitle
  • Default: Scalor

<zincStateStoreType>

Incremental compiler file analysis store type for the state cache. Available types: 
  text   - compatible with Scala IDE
  binary - high performance serializer
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.zincStateStoreType
  • Default: text

<zincVerifyVersion>

Flag to force version constistency check among dependency artifacts discovered from defineBridge, defineCompiler, definePluginList.
  • Type: boolean
  • Required: No
  • User Property: scalor.zincVerifyVersion
  • Default: true