Fork me on GitHub

scalor:register-main

Full name:

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

Description:

Register Java, Scala, resource root folders for compilation scope=main. 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.
<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.
<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.
<skipRegisterMain> boolean - Flag to skip goal execution: register-main.
Default value is: false.
User property is: scalor.skipRegisterMain.

Parameter Details

<buildEnsureFolders>

Create build source root and target root folders when missing.
  • Type: boolean
  • Required: No
  • User Property: scalor.buildEnsureFolders
  • Default: true

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

<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

<skipRegisterMain>

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