Fork me on GitHub
Built by Maven

scalor:register-macro

Full name:

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

Description:

Register Java, Scala, resource root folders for compilation scope=macro. A member of goal=register.

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.
<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.
<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.
<skipRegisterMacro> boolean - Flag to skip goal execution: register-macro.
Default value is: false.
User property is: scalor.skipRegisterMacro.

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

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

<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

<skipRegisterMacro>

Flag to skip goal execution: register-macro.
  • Type: boolean
  • Required: No
  • User Property: scalor.skipRegisterMacro
  • Default: false