Fork me on GitHub

scalor:setup-cross

Full name:

com.carrotgarden.maven:scalor-maven-plugin_2.12:1.5.0.20190502181145:setup-cross

Description:

Setup module structure for Scala cross version build. Produce folders and symbolic links.

Attributes:

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

Optional Parameters

Name Type Since Description
<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.
<setupCrossModuleList> String - List of folders for cross-version modules. Placed inside parent project ${project.basedir}. Normally represents several current Scala versions. Module names must correspond to module names configured in parent pom.xml. Module names present in this list but missing from pom.xml are ignored. Relative path. Separator parameter: commonSequenceSeparator. Example matching pom.xml configuration entry:
    <modules>
        <module>cross/2.11</module>
        <module>cross/2.12</module>
        <module>cross/2.13</module>
    </modules>

Default value is: cross/2.11 ★ cross/2.12 ★ cross/2.13 ★ .
User property is: scalor.setupCrossModuleList.
<setupCrossPackagingList> String[] - List of packaging types, which activate this goal: setup-cross. Overrides effects of skipPackagingList.
Default value is: pom.
User property is: scalor.setupCrossPackagingList.
<setupCrossResourceList> String - List of resources for parent/module linking. Resources are linked from each cross-version module into parent. Normally includes project source root folder src. Relative path. Separator parameter: commonSequenceSeparator. Example linking result:
  # symlink: 'source' -> 'target'
  ${parent}/cross/2.11/src -> ${parent}/src
  ${parent}/cross/2.12/src -> ${parent}/src
  ${parent}/cross/2.13/src -> ${parent}/src

Default value is: src ★ .
User property is: scalor.setupCrossResourceList.
<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.
<skipSetupCross> boolean - Flag to skip this execution: setup-cross.
Default value is: false.
User property is: scalor.skipSetupCross.

Parameter Details

<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]+

<setupCrossModuleList>

List of folders for cross-version modules. Placed inside parent project ${project.basedir}. Normally represents several current Scala versions. Module names must correspond to module names configured in parent pom.xml. Module names present in this list but missing from pom.xml are ignored. Relative path. Separator parameter: commonSequenceSeparator. Example matching pom.xml configuration entry:
    <modules>
        <module>cross/2.11</module>
        <module>cross/2.12</module>
        <module>cross/2.13</module>
    </modules>
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.setupCrossModuleList
  • Default: cross/2.11 ★ cross/2.12 ★ cross/2.13 ★

<setupCrossPackagingList>

List of packaging types, which activate this goal: setup-cross. Overrides effects of skipPackagingList.
  • Type: java.lang.String[]
  • Required: No
  • User Property: scalor.setupCrossPackagingList
  • Default: pom

<setupCrossResourceList>

List of resources for parent/module linking. Resources are linked from each cross-version module into parent. Normally includes project source root folder src. Relative path. Separator parameter: commonSequenceSeparator. Example linking result:
  # symlink: 'source' -> 'target'
  ${parent}/cross/2.11/src -> ${parent}/src
  ${parent}/cross/2.12/src -> ${parent}/src
  ${parent}/cross/2.13/src -> ${parent}/src
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.setupCrossResourceList
  • Default: src ★

<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

<skipSetupCross>

Flag to skip this execution: setup-cross.
  • Type: boolean
  • Required: No
  • User Property: scalor.skipSetupCross
  • Default: false