Scalor Maven Plugin 2.12 – scalor:register

scalor:register

Full name:

com.carrotgarden.maven:scalor-maven-plugin_2.12:1.5.0.20190502181145:register

Description:

Attributes:

Requires a Maven project to be executed.
Binds by default to the lifecycle phase: initialize.

Optional Parameters

Name	Type	Since	Description
`<buildEnsureFolders>`	`boolean`	`-`	Create build source root and target root folders when missing. Default value is: `true`. User property is: `scalor.buildEnsureFolders`.
`<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`.
`<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`.
`<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`.
`<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`.
`<skipRegister>`	`boolean`	`-`	Flag to skip goal execution: `register-`. Default value is: `false`. User property is*: `scalor.skipRegister`.

Parameter Details

<buildEnsureFolders>

Create build source root and target root folders when missing.

Type: boolean
Required: No
User Property: scalor.buildEnsureFolders
Default: true

<buildMacroResourceFolders>

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>

Type: org.apache.maven.model.Resource[]
Required: No
User Property: scalor.buildMacroResourceFolders

<buildMacroSourceJavaFolders>

Java source root folders to be included in compilation scope=macro. Normally uses src/macro/java.

Type: java.io.File[]
Required: No
User Property: scalor.buildMacroSourceJavaFolders
Default: ${project.build.sourceDirectory}/../../macro/java

<buildMacroSourceScalaFolders>

Scala source root folders to be included in compilation scope=macro. Normally uses src/macro/scala.

Type: java.io.File[]
Required: No
User Property: scalor.buildMacroSourceScalaFolders
Default: ${project.build.sourceDirectory}/../../macro/scala

<buildMainResourceFolders>

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>

Type: org.apache.maven.model.Resource[]
Required: No
User Property: scalor.buildMainResourceFolders
Default: ${project.build.resources}

<buildMainSourceJavaFolders>

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>

Type: java.io.File[]
Required: No
User Property: scalor.buildMainSourceJavaFolders
Default: ${project.build.sourceDirectory}

<buildMainSourceScalaFolders>

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>

Type: java.io.File[]
Required: No
User Property: scalor.buildMainSourceScalaFolders
Default: ${project.build.sourceDirectory}/../scala

<buildMainTargetFolder>

Build target folder with result classes of compilation scope=[macro,main]. Normally uses target/classes.

Type: java.io.File
Required: No
User Property: scalor.buildMainTargetFolder
Default: ${project.build.outputDirectory}

<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}

<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

<skipRegister>

Flag to skip goal execution: register-*.

Type: boolean
Required: No
User Property: scalor.skipRegister
Default: false