Fork me on GitHub

phantomjs:install

Full name:

com.github.klieber:phantomjs-maven-plugin:0.8-SNAPSHOT:install

Description:

Maven plugin for downloading and installing phantomjs binaries.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 0.1.
  • Binds by default to the lifecycle phase: process-test-sources.

Required Parameters

Name Type Since Description
checkSystemPath boolean 0.1 Check the system path for an existing phantomjs installation.
Default value is: true.
User property is: phantomjs.checkSystemPath.
outputDirectory File 0.1 The directory the phantomjs binary should be installed.
Default value is: ${project.build.directory}/phantomjs-maven-plugin.
User property is: phantomjs.outputDir.
propertyName String 0.1 The name of the property that will contains the path to the binary.
Default value is: phantomjs.binary.
User property is: phantomjs.propertyName.
skip boolean 0.1 Skip the phantomjs-maven-plugin execution.
Default value is: false.
User property is: phantomjs.skip.
source PhantomJsLocatorOptions$Source 0.1

The download source for the phantomjs binary.

Valid values:

  • REPOSITORY : download a copy from the maven central repository.
  • URL : download directly from a url

Default value is: REPOSITORY.
User property is: phantomjs.source.
version String 0.1 The version of phantomjs to install.
User property is: phantomjs.version.

Optional Parameters

Name Type Since Description
baseUrl String 0.1 The base url the phantomjs binary can be downloaded from.
User property is: phantomjs.baseUrl.
enforceVersion String 0.1 Require that the correct version of phantomjs is on the system path. You may either specify a boolean value or starting with version 0.7 of the plugin you can also specify a version range following the same syntax as the Maven Enforcer Plugin.
Default value is: true.
User property is: phantomjs.enforceVersion.
phantomJsBinary String 0.1 The path to the phantomjs binary
User property is: phantomjs.binary.

Parameter Details

baseUrl:

The base url the phantomjs binary can be downloaded from.
  • Type: java.lang.String
  • Since: 0.1
  • Required: No
  • User Property: phantomjs.baseUrl

checkSystemPath:

Check the system path for an existing phantomjs installation.
  • Type: boolean
  • Since: 0.1
  • Required: Yes
  • User Property: phantomjs.checkSystemPath
  • Default: true

enforceVersion:

Require that the correct version of phantomjs is on the system path. You may either specify a boolean value or starting with version 0.7 of the plugin you can also specify a version range following the same syntax as the Maven Enforcer Plugin.
  • Type: java.lang.String
  • Since: 0.1
  • Required: No
  • User Property: phantomjs.enforceVersion
  • Default: true

outputDirectory:

The directory the phantomjs binary should be installed.
  • Type: java.io.File
  • Since: 0.1
  • Required: Yes
  • User Property: phantomjs.outputDir
  • Default: ${project.build.directory}/phantomjs-maven-plugin

phantomJsBinary:

The path to the phantomjs binary
  • Type: java.lang.String
  • Since: 0.1
  • Required: No
  • User Property: phantomjs.binary

propertyName:

The name of the property that will contains the path to the binary.
  • Type: java.lang.String
  • Since: 0.1
  • Required: Yes
  • User Property: phantomjs.propertyName
  • Default: phantomjs.binary

skip:

Skip the phantomjs-maven-plugin execution.
  • Type: boolean
  • Since: 0.1
  • Required: Yes
  • User Property: phantomjs.skip
  • Default: false

source:

The download source for the phantomjs binary.

Valid values:

  • REPOSITORY : download a copy from the maven central repository.
  • URL : download directly from a url
  • Type: com.github.klieber.phantomjs.locate.PhantomJsLocatorOptions$Source
  • Since: 0.1
  • Required: Yes
  • User Property: phantomjs.source
  • Default: REPOSITORY

version:

The version of phantomjs to install.
  • Type: java.lang.String
  • Since: 0.1
  • Required: Yes
  • User Property: phantomjs.version