Full name:
com.carrotgarden.maven:scalor-maven-plugin_2.12:1.5.0.20190502181145:eclipse-config
Description:
Attributes:
Name | Type | Since | Description |
---|---|---|---|
<buildMacroDependencyFolders> | File[] | - | Project folders containing build classes which are dependency for
compilation scope=macro. Normally is empty. User property is: scalor.buildMacroDependencyFolders. |
<buildMacroDependencyScopes> | String[] | - | Maven dependency scopes which control selection of project
dependency artifacts to be included in the classpath of compilation
scope=macro. Scopes reference. Default value is: compile,provided,system. User property is: scalor.buildMacroDependencyScopes. |
<buildMacroResourceFolders> | Resource[] | - | Resource root folders to be included in compilation scope=macro.
There are no macro resource folders by default. Component
reference: Resource .
Example entry in pom.xml:
<buildMacroResourceFolders> <resource> <directory>${project.basedir}/src/macro/resources</directory> </resource> </buildMacroResourceFolders> User property is: scalor.buildMacroResourceFolders. |
<buildMacroSourceJavaFolders> | File[] | - | Java source root folders to be included in compilation scope=macro.
Normally uses src/macro/java. Default value is: ${project.build.sourceDirectory}/../../macro/java. User property is: scalor.buildMacroSourceJavaFolders. |
<buildMacroSourceScalaFolders> | File[] | - | Scala source root folders to be included in compilation
scope=macro. Normally uses src/macro/scala. Default value is: ${project.build.sourceDirectory}/../../macro/scala. User property is: scalor.buildMacroSourceScalaFolders. |
<buildMainDependencyFolders> | File[] | - | Project folders containing build classes which are dependency for
compilation scope=main. Normally includes folder scope=[macro,main]
(target/classes). Default value is: ${project.build.outputDirectory}. User property is: scalor.buildMainDependencyFolders. |
<buildMainDependencyScopes> | String[] | - | Maven dependency scopes which control selection of project
dependency artifacts to be included in the classpath of compilation
scope=main. Scopes reference. Default value is: compile,provided,system. User property is: scalor.buildMainDependencyScopes. |
<buildMainResourceFolders> | Resource[] | - | Resource root folders to be included in compilation scope=main.
Normally uses src/main/resources. Absolute path.
Component reference: Resource .
Example custom entry in pom.xml:
<buildMainResourceFolders> <resource> <directory>${project.basedir}/src/main/resources</directory> </resource> <resource> <directory>${project.basedir}/target/generated/main/resources</directory> </resource> </buildMainResourceFolders> Default value is: ${project.build.resources}. User property is: scalor.buildMainResourceFolders. |
<buildMainSourceJavaFolders> | File[] | - | Java source root folders to be included in compilation scope=main.
Absolute path. Normally uses src/main/java. Example
custom entry in pom.xml:
<buildMainSourceJavaFolders> <source>${project.build.sourceDirectory}</source> <source>${project.basedir}/target/generated/main/java</source> </buildMainSourceJavaFolders> Default value is: ${project.build.sourceDirectory}. User property is: scalor.buildMainSourceJavaFolders. |
<buildMainSourceScalaFolders> | File[] | - | Scala source root folders to be included in compilation scope=main.
Absolute path. Normally uses src/main/scala. Example
custom entry in pom.xml:
<buildMainSourceScalaFolders> <source>${project.build.sourceDirectory}/../scala</source> <source>${project.basedir}/target/generated/main/scala</source> </buildMainSourceScalaFolders> Default value is: ${project.build.sourceDirectory}/../scala. User property is: scalor.buildMainSourceScalaFolders. |
<buildMainTargetFolder> | File | - | Build target folder with result classes of compilation
scope=[macro,main]. Normally uses target/classes. Default value is: ${project.build.outputDirectory}. User property is: scalor.buildMainTargetFolder. |
<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 ) 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 ) 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:
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> |
<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> |
<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> |
<eclipseBuilderOrdering> | String | - | Order Eclipse .project descriptor builder entries
according to these rules. Rule format:
item = path where: item - relative sort order index, path - regular expression to match against 'projectDescription/buildSpec/buildCommand/name', Default value is: 11 = org.eclipse.wst.+ ★ 12 = org.eclipse.dltk.+ ★ 41 = org.eclipse.jdt.+ ★ 42 = org.scala-ide.sdt.+ ★ 71 = org.eclipse.pde.+ ★ 72 = org.eclipse.m2e.+ ★ . User property is: scalor.eclipseBuilderOrdering. |
<eclipseBuilderReorder> | boolean | - | Enable to re-order Eclipse .project descriptor by
projectDescription/buildSpec/buildCommand/name Default value is: true. User property is: scalor.eclipseBuilderReorder. |
<eclipseClasspathOrdering> | String | - | Re-order Eclipse top level .classpath descriptor
entries according to these rules. Class path entry order controls
visual presentation in Eclipse UI. Rule format:
item = path where: item - relative sort order index, path - regular expression to match against 'classpath/classpathentry/@path', Default value is: 11 = .*src/macr.*/java ★ 12 = .*src/macr.*/scala ★ 13 = .*src/macr.*/groovy ★ 14 = .*src/macr.*/res.* ★ 21 = .*src/main.*/java ★ 22 = .*src/main.*/scala ★ 23 = .*src/main.*/groovy ★ 24 = .*src/main.*/res.* ★ 31 = .*src/test.*/java ★ 32 = .*src/test.*/scala ★ 33 = .*src/test.*/groovy ★ 34 = .*src/test.*/res.* ★ 51 = .*target/gen[a-z-]*sources.* ★ 52 = .*target/gen[a-z-]*test-.* ★ 53 = .*target/gen[a-z-]*.* ★ 81 = org.scala-ide.sdt.* ★ 82 = org.eclipse.jdt.* ★ 83 = org.eclipse.m2e.* ★ 84 = GROOVY_SUPPORT ★ 85 = GROOVY_DSL_SUPPORT ★ 91 = .*target/clas.* ★ 92 = .*target/test-clas.* ★ 93 = .*target/scalor/clas.*/macr.* ★ 94 = .*target/scalor/clas.*/main.* ★ 95 = .*target/scalor/clas.*/test.* ★ . User property is: scalor.eclipseClasspathOrdering. |
<eclipseClasspathReorder> | boolean | - | Enable to re-order Eclipse .classpath descriptor by
classpath/classpathentry/@path Default value is: true. User property is: scalor.eclipseClasspathReorder. |
<eclipseDetectPresent> | boolean | - | Invoke Eclipse executions only when runnting inside Eclipse/M2E.
When false, force executions regardless of the Eclipse
detection state. Default value is: true. User property is: scalor.eclipseDetectPresent. |
<eclipseHackSymbolicLinks> | boolean | - | Work around Scala IDE mishandling of symbolic link paths.
Specifically, discover project folders which are symbolic links,
and explicitly declare them in the .project
descriptor. Example result entry in the descriptor:
<linkedResources> <link> <name>src</name> <type>2</type> <location>/home/work/source/git/scalor-maven-plugin/src</location> </link> </linkedResources> Default value is: false. User property is: scalor.eclipseHackSymbolicLinks. |
<eclipseInstallReportFile> | File | - | Report all available custom Scala installations persisted by Scala
IDE. Provides titles, dependencies, etc., for every custom Scala
installation. Enablement parameter: eclipseLogInstallReport. Default value is: ${project.build.directory}/scalor/scala-install-report.txt. User property is: scalor.eclipseInstallReportFile. |
<eclipseLogBuildParticipant> | boolean | - | Enable to log M2E build participant executions of Eclipse companion
plugin. Use to review actual build actions delegated from Eclipse
to Maven plugin goals. Default value is: false. User property is: scalor.eclipseLogBuildParticipant. |
<eclipseLogClasspathOrder> | boolean | - | Enable to log class path re-ordering result entries. Use to review
actual full class path dump. Default value is: false. User property is: scalor.eclipseLogClasspathOrder. |
<eclipseLogInstallReport> | boolean | - | Report all available custom Scala installations persisted by
Eclipse Scala IDE plugin. Provides titles, dependencies, etc., for
every custom Scala installation. Generated report output file
parameter: eclipseInstallReportFile. Default value is: false. User property is: scalor.eclipseLogInstallReport. |
<eclipseLogParamsConfig> | boolean | - | Enable to log effective configuration parameters of Eclipse
companion plugin. Use to review full dump of settings transferred
from Maven to Eclipse. Default value is: false. User property is: scalor.eclipseLogParamsConfig. |
<eclipseLogPersistCompiler> | boolean | - | Enable to log persisting of selected project Scala compiler. Use to
review complier title with MD5. Default value is: false. User property is: scalor.eclipseLogPersistCompiler. |
<eclipseLogPersistInstall> | boolean | - | Enable to log persisting of custom Scala installation. Use to
review complier configuration for given project. Default value is: false. User property is: scalor.eclipseLogPersistInstall. |
<eclipseLogPersistSettings> | boolean | - | Enable to log persisting of configured project Scala IDE settings.
Use to review actual stored per-project key=value. Default value is: false. User property is: scalor.eclipseLogPersistSettings. |
<eclipseMavenOrdering> | String | - | Re-order class path entires inside the.classpathMaven
container acording to these rules. Available rules are:
artifactId = ascending Default value is: artifactId = ascending . User property is: scalor.eclipseMavenOrdering. |
<eclipseMavenPluginVersionCheck> | boolean | - | Enable to verify version of Eclipse M2E plugin when
running companion Eclipse plugin. Version range parameter: eclipseMavenPluginVersionRange. Default value is: true. User property is: scalor.eclipseMavenPluginVersionCheck. |
<eclipseMavenPluginVersionError> | boolean | - | Reaction of companion Eclipse plugin on Maven M2E version out of
range error:
true -> fail with error false -> only log an error Default value is: true. User property is: scalor.eclipseMavenPluginVersionError. |
<eclipseMavenPluginVersionRange> | String | - | Version range of Eclipse M2E plugin known to work with this release
of companion Eclipse plugin. To verify Eclipse Platform M2E plugin
version, navigate:
Eclipse -> Help -> About Eclipse -> Installation Details -> Installed Software -> M2E Default value is: [1.8.0,1.12.0). User property is: scalor.eclipseMavenPluginVersionRange. |
<eclipseMavenReorder> | boolean | - | Enable to re-order class path entires inside
the.classpathMaven container. Class path entry order
controls visual presentation in Eclipse UI. Ordering parameter: eclipseMavenOrdering. Default value is: true. User property is: scalor.eclipseMavenReorder. |
<eclipseNatureOrdering> | String | - | Re-order nature entires in .project descriptor
according to these rules. Nature order controls project
presentation in Eclipse UI. In order to see [S] icon
for Scala project, Scala nature must come first. Rule format:
item = path where: item - relative sort order index, path - regular expression to match against 'projectDescription/natures/nature', Default value is: 11 = org.scala-ide.sdt.+ ★ 21 = org.eclipse.jdt.+ ★ 31 = org.eclipse.pde.+ ★ 41 = org.eclipse.m2e.+ ★ 51 = org.eclipse.wst.+ ★ 61 = org.eclipse.dltk.+ ★ . User property is: scalor.eclipseNatureOrdering. |
<eclipseNatureReorder> | boolean | - | Enable to re-order nature entires in .project
descriptor. Nature order controls project presentation in Eclipse
UI. Ordering parameter: eclipseNatureOrdering. Default value is: true. User property is: scalor.eclipseNatureReorder. |
<eclipseProjectCommentApply> | boolean | - | Enable to apply comment in Eclipse .project
descriptor. Default value is: true. User property is: scalor.eclipseProjectCommentApply. |
<eclipseProjectCommentString> | String | - | Content of the comment in eclipse .project descriptor. Default value is: scalor-maven-plugin @ ${project.properties(release.stamp)}. User property is: scalor.eclipseProjectCommentString. |
<eclipseRemoveLibraryContainer> | boolean | - | Enable to remove Scala Library container from Eclipse build class
path. Normally, Scala Library container is provided by default by
Scala IDE plugin. Normally, scala-library artifact must also be
provided as pom.xml dependency. That results in
scala-library dependency listed twice on Eclipse build class path.
To avoid "duplicate library on class path" warning, use this
parameter to remove Scala IDE provided container. Custom Scala
installation configured by this plugin will use scala-library
resolved from defineCompiler,
which normally should be configured as identical to the
scala-library provided as pom.xml project dependency. Default value is: true. User property is: scalor.eclipseRemoveLibraryContainer. |
<eclipseRenameLibraryContainer> | boolean | - | Enable to rename Scala Library container in Eclipse UI. Container
description will reflect title of the custom Scala installation.
Only effective when not removing scala-library container via
parameter: eclipseRemoveLibraryContainer. Default value is: true. User property is: scalor.eclipseRenameLibraryContainer. |
<eclipseResetPreferences> | boolean | - | Reset Eclipse Scala IDE project preferences to their default values
before applying Maven provided configuration. Use this feature to
remove extraneous user-provided Eclipse UI configuration settings
for Scala IDE. Default value is: true. User property is: scalor.eclipseResetPreferences. |
<eclipseScalaPluginVersionCheck> | boolean | - | Enable to verify version of Scala
IDE plugin when running companion Eclipse plugin. Version range
parameter: eclipseScalaPluginVersionRange. Default value is: true. User property is: scalor.eclipseScalaPluginVersionCheck. |
<eclipseScalaPluginVersionError> | boolean | - | Reaction of companion Eclipse plugin on Scala IDE version out of
range error:
true -> fail with error false -> only log an error Default value is: true. User property is: scalor.eclipseScalaPluginVersionError. |
<eclipseScalaPluginVersionRange> | String | - | Version range of Scala IDE known to work with this release of
companion Eclipse plugin. To verify Eclipse Platform Scala IDE
plugin version, navigate:
Eclipse -> Help -> About Eclipse -> Installation Details -> Installed Software -> Scala IDE Default value is: [4.7.0,4.7.2). User property is: scalor.eclipseScalaPluginVersionRange. |
<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. |
<skip> | boolean | - | Force to skip all executions of this plugin. Default value is: false. User property is: scalor.skip. |
<skipEclipse> | boolean | - | Flag to skip goal execution: eclipse-*. Default value is: false. User property is: scalor.skipEclipse. |
<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. |
<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.
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:
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. |
<buildMacroResourceFolders> <resource> <directory>${project.basedir}/src/macro/resources</directory> </resource> </buildMacroResourceFolders>
<buildMainResourceFolders> <resource> <directory>${project.basedir}/src/main/resources</directory> </resource> <resource> <directory>${project.basedir}/target/generated/main/resources</directory> </resource> </buildMainResourceFolders>
<buildMainSourceJavaFolders> <source>${project.build.sourceDirectory}</source> <source>${project.basedir}/target/generated/main/java</source> </buildMainSourceJavaFolders>
<buildMainSourceScalaFolders> <source>${project.build.sourceDirectory}/../scala</source> <source>${project.basedir}/target/generated/main/scala</source> </buildMainSourceScalaFolders>
<buildTestResourceFolders> <resource> <directory>${project.basedir}/src/test/resources</directory> </resource> <resource> <directory>${project.basedir}/target/generated/test/resources</directory> </resource> </buildTestResourceFolders>
<buildTestSourceJavaFolders> <source>${project.build.testSourceDirectory}</source> <source>${project.basedir}/target/generated/test/java</source> </buildTestSourceJavaFolders>
<buildTestSourceScalaFolders> <source>${project.build.testSourceDirectory}/../scala</source> <source>${project.basedir}/target/generated/test/scala</source> </buildTestSourceScalaFolders>
case commonMappingPattern.r( key, value ) => ( key, value )
string.split( commonSequenceSeparator ).map( _.trim ).filterNot( _.isEmpty )
<defineBridge> <dependency> <groupId>org.scala-sbt</groupId> <artifactId>compiler-bridge_${version.scala.epoch}</artifactId> <version>${version.scala.zinc}</version> </dependency> </defineBridge>
<defineCompiler> <dependency> <groupId>org.scala-lang</groupId> <artifactId>scala-compiler</artifactId> <version>${version.scala.release}</version> </dependency> </defineCompiler>
<definePluginList> <dependency> <groupId>org.scala-js</groupId> <artifactId>scalajs-compiler_${version.scala.release}</artifactId> <version>${version.sjs.release}</version> </dependency> </definePluginList>
item = path where: item - relative sort order index, path - regular expression to match against 'projectDescription/buildSpec/buildCommand/name',
projectDescription/buildSpec/buildCommand/name
item = path where: item - relative sort order index, path - regular expression to match against 'classpath/classpathentry/@path',
classpath/classpathentry/@path
<linkedResources> <link> <name>src</name> <type>2</type> <location>/home/work/source/git/scalor-maven-plugin/src</location> </link> </linkedResources>
artifactId = ascending
true -> fail with error false -> only log an error
Eclipse -> Help -> About Eclipse -> Installation Details -> Installed Software -> M2E
item = path where: item - relative sort order index, path - regular expression to match against 'projectDescription/natures/nature',
true -> fail with error false -> only log an error
Eclipse -> Help -> About Eclipse -> Installation Details -> Installed Software -> Scala IDE