Fork me on GitHub
Built by Maven

scalor:scala-js-env-prov-nodejs

Full name:

com.carrotgarden.maven:scalor-maven-plugin_2.12:1.5.0.20190502181145:scala-js-env-prov-nodejs

Description:

Provision Scala.js JavaScript VM environment for testing: install Node.js binary and NPM modules.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: generate-test-resources.

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.
<envprovForce> boolean - Flag to force environment provisioning. 
false - use auto-detection
true  - skip detection of installed resources

Default value is: false.
User property is: scalor.envprovForce.
<envprovNodejsFolder> String - A folder inside envprovTestToolFolder which contains extracted Node.js. Relative path.
Default value is: node.
User property is: scalor.envprovNodejsFolder.
<envprovNodejsURL> String - URL of the Node.js distribution download.
Default value is: http://nodejs.org/dist.
User property is: scalor.envprovNodejsURL.
<envprovNodejsVersion> String - Node.js version used to provision node installation. Select from availabe versions.
Default value is: 10.0.0.
User property is: scalor.envprovNodejsVersion.
<envprovRnpmjsModules> String - List of Node.js NPM modules configured for provisioning. Uses format: module@version. Separator parameter: commonSequenceSeparator. Used by npm install.
Default value is: npm@5.6.0 ★ jsdom@11.9.0 ★ source-map-support@0.5.5 ★ .
User property is: scalor.envprovRnpmjsModules.
<envprovRnpmjsOptions> String - List of additional NPM invocation options. Separator parameter: commonSequenceSeparator. Used by npm install.
Default value is: --save ★ --silent ★ .
User property is: scalor.envprovRnpmjsOptions.
<envprovRnpmjsURL> String - URL of the Node.js NPM module registry. Used by npm install.
Default value is: http://registry.npmjs.org.
User property is: scalor.envprovRnpmjsURL.
<envprovTestToolFolder> File - Scala.js test-tool installaton folder used for testing. Contains provisioned Node.js, Phantom.js, Webjars, etc. Normally this folder should be excluded from source control and should not be a part of any clean execution. Absolute path. When changing, make sure to replace test-tool references elsewhere.
Default value is: ${project.basedir}/test-tool.
User property is: scalor.envprovTestToolFolder.
<skip> boolean - Force to skip all executions of this plugin.
Default value is: false.
User property is: scalor.skip.
<skipEnvProv> boolean - Flag to skip environment provisioning.
Default value is: false.
User property is: scalor.skipEnvProv.
<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.

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

<envprovForce>

Flag to force environment provisioning. 
false - use auto-detection
true  - skip detection of installed resources
  • Type: boolean
  • Required: No
  • User Property: scalor.envprovForce
  • Default: false

<envprovNodejsFolder>

A folder inside envprovTestToolFolder which contains extracted Node.js. Relative path.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.envprovNodejsFolder
  • Default: node

<envprovNodejsURL>

URL of the Node.js distribution download.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.envprovNodejsURL
  • Default: http://nodejs.org/dist

<envprovNodejsVersion>

Node.js version used to provision node installation. Select from availabe versions.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.envprovNodejsVersion
  • Default: 10.0.0

<envprovRnpmjsModules>

List of Node.js NPM modules configured for provisioning. Uses format: module@version. Separator parameter: commonSequenceSeparator. Used by npm install.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.envprovRnpmjsModules
  • Default: npm@5.6.0 ★ jsdom@11.9.0 ★ source-map-support@0.5.5 ★

<envprovRnpmjsOptions>

List of additional NPM invocation options. Separator parameter: commonSequenceSeparator. Used by npm install.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.envprovRnpmjsOptions
  • Default: --save ★ --silent ★

<envprovRnpmjsURL>

URL of the Node.js NPM module registry. Used by npm install.
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.envprovRnpmjsURL
  • Default: http://registry.npmjs.org

<envprovTestToolFolder>

Scala.js test-tool installaton folder used for testing. Contains provisioned Node.js, Phantom.js, Webjars, etc. Normally this folder should be excluded from source control and should not be a part of any clean execution. Absolute path. When changing, make sure to replace test-tool references elsewhere.
  • Type: java.io.File
  • Required: No
  • User Property: scalor.envprovTestToolFolder
  • Default: ${project.basedir}/test-tool

<skip>

Force to skip all executions of this plugin.
  • Type: boolean
  • Required: No
  • User Property: scalor.skip
  • Default: false

<skipEnvProv>

Flag to skip environment provisioning.
  • Type: boolean
  • Required: No
  • User Property: scalor.skipEnvProv
  • 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