JavaScript Zip Maven Plugin

jszip:run

Full name:

org.jszip.maven:jszip-maven-plugin:0.1-alpha-9:run

Description:

Starts a Jetty servlet container with resources resolved from the reactor projects to enable live editing of those resources and pom and classpath scanning to restart the servlet container when the classpath is modified. Note that if the poms are modified in such a way that the reactor build plan is modified, we have no choice but to stop the servlet container and require the maven session to be restarted, but best effort is made to ensure that restart is only when required.

Attributes:

Requires a Maven project to be executed.
Requires dependency resolution of artifacts in scope: compile+runtime.
Binds by default to the lifecycle phase: test-compile.

Required Parameters

Name	Type	Since	Description
classesDirectory	`File`	`-`	The directory containing generated classes. User property is: `project.build.outputDirectory`.
testClassesDirectory	`File`	`-`	The directory containing generated test classes. User property is: `project.build.testOutputDirectory`.
warSourceDirectory	`File`	`-`	Root directory for all html/jsp etc files Default value is: `${basedir}/src/main/webapp`.

Optional Parameters

Name	Type	Since	Description
connectors	`Connector[]`	`-`	List of connectors to use. If none are configured then the default is a single SelectChannelConnector at port 8080. You can override this default port number by using the system property jetty.port on the command line, eg: mvn -Djetty.port=9999 jszip:run. Consider using instead the <jettyXml> element to specify external jetty xml config file.
customLessScript	`File`	`-`	Directory containing the less processor. Default value is: `src/build/js/less-rhino.js`.
encoding	`String`	`-`	The character encoding scheme to be applied when reading SASS files. Default value is: `${project.build.sourceEncoding}`.
lessCompress	`boolean`	`-`	Compress CSS. Default value is: `true`. User property is: `jszip.less.compress`.
lessExcludes	`List`	`-`	A list of <exclude> elements specifying the less files (by pattern) that should be excluded from processing.
lessFailOnError	`boolean`	`-`	Indicates whether the build will continue even if there are compilation errors. Default value is: `true`. User property is: `jszip.less.failOnError`.
lessForceIfOlder	`boolean`	`-`	Force compilation even if the source LESS file is older than the destination CSS file. Default value is: `false`. User property is: `jszip.less.forceIfOlder`.
lessIncludes	`List`	`-`	A list of <include> elements specifying the less files (by pattern) that should be included in processing.
lessSkip	`boolean`	`-`	Skip compilation. Default value is: `false`. User property is: `jszip.less.skip`.
mappings	`Mapping[]`	`-`	The artifact path mappings for unpacking. User property is: `mappings`.
pluginDescriptor	`PluginDescriptor`	`-`	This plugin's descriptor User property is: `plugin`.
runModule	`String`	`-`	The module that the goal should apply to. Specify either groupId:artifactId or just plain artifactId. User property is: `jszip.run.module`.
runPackages	`String[]`	`-`	List of the packaging types will be considered for executing this goal. Normally you do not need to configure this parameter unless you have a custom war packaging type. Defaults to `war`
sassExcludes	`List`	`-`	A list of <exclude> elements specifying the sass files (by pattern) that should be excluded from processing.
sassFailOnError	`boolean`	`-`	Indicates whether the build will continue even if there are compilation errors. Default value is: `true`. User property is: `jszip.sass.failOnError`.
sassForceIfOlder	`boolean`	`-`	Force compilation even if the source Sass file is older than the destination CSS file. Default value is: `false`. User property is: `jszip.sass.forceIfOlder`.
sassIncludes	`List`	`-`	A list of <include> elements specifying the sass files (by pattern) that should be included in processing.
sassSkip	`boolean`	`-`	Skip compilation. Default value is: `false`. User property is: `jszip.sass.skip`.
showErrorExtracts	`boolean`	`-`	Indicates whether to show extracts of the code where errors occur. Default value is: `false`. User property is: `jszip.less.showErrorExtracts`.
systemProperties	`SystemProperties`	`-`	System properties to set before execution. Note that these properties will NOT override System properties that have been set on the command line or by the JVM. They WILL override System properties that have been set via systemPropertiesFile. Optional.
useTestScope	`boolean`	`-`	If true, the <testOutputDirectory> and the dependencies of <scope>test<scope> will be put first on the runtime classpath. Default value is: `false`.

Parameter Details

classesDirectory:

The directory containing generated classes.

Type: java.io.File
Required: Yes
User Property: project.build.outputDirectory

connectors:

List of connectors to use. If none are configured then the default is a single SelectChannelConnector at port 8080. You can override this default port number by using the system property jetty.port on the command line, eg: mvn -Djetty.port=9999 jszip:run. Consider using instead the <jettyXml> element to specify external jetty xml config file.

Type: org.eclipse.jetty.server.Connector[]
Required: No

customLessScript:

Directory containing the less processor.

Type: java.io.File
Required: No
Default: src/build/js/less-rhino.js

encoding:

The character encoding scheme to be applied when reading SASS files.

Type: java.lang.String
Required: No
Default: ${project.build.sourceEncoding}

lessCompress:

Compress CSS.

Type: boolean
Required: No
User Property: jszip.less.compress
Default: true

lessExcludes:

A list of <exclude> elements specifying the less files (by pattern) that should be excluded from processing.

Type: java.util.List
Required: No

lessFailOnError:

Indicates whether the build will continue even if there are compilation errors.

Type: boolean
Required: No
User Property: jszip.less.failOnError
Default: true

lessForceIfOlder:

Force compilation even if the source LESS file is older than the destination CSS file.

Type: boolean
Required: No
User Property: jszip.less.forceIfOlder
Default: false

lessIncludes:

A list of <include> elements specifying the less files (by pattern) that should be included in processing.

Type: java.util.List
Required: No

lessSkip:

Skip compilation.

Type: boolean
Required: No
User Property: jszip.less.skip
Default: false

mappings:

The artifact path mappings for unpacking.

Type: org.jszip.maven.Mapping[]
Required: No
User Property: mappings

pluginDescriptor:

This plugin's descriptor

Type: org.apache.maven.plugin.descriptor.PluginDescriptor
Required: No
User Property: plugin

runModule:

The module that the goal should apply to. Specify either groupId:artifactId or just plain artifactId.

Type: java.lang.String
Required: No
User Property: jszip.run.module

runPackages:

List of the packaging types will be considered for executing this goal. Normally you do not need to configure this parameter unless you have a custom war packaging type. Defaults to war

Type: java.lang.String[]
Required: No

sassExcludes:

A list of <exclude> elements specifying the sass files (by pattern) that should be excluded from processing.

Type: java.util.List
Required: No

sassFailOnError:

Indicates whether the build will continue even if there are compilation errors.

Type: boolean
Required: No
User Property: jszip.sass.failOnError
Default: true

sassForceIfOlder:

Force compilation even if the source Sass file is older than the destination CSS file.

Type: boolean
Required: No
User Property: jszip.sass.forceIfOlder
Default: false

sassIncludes:

A list of <include> elements specifying the sass files (by pattern) that should be included in processing.

Type: java.util.List
Required: No

sassSkip:

Skip compilation.

Type: boolean
Required: No
User Property: jszip.sass.skip
Default: false

showErrorExtracts:

Indicates whether to show extracts of the code where errors occur.

Type: boolean
Required: No
User Property: jszip.less.showErrorExtracts
Default: false

systemProperties:

System properties to set before execution. Note that these properties will NOT override System properties that have been set on the command line or by the JVM. They WILL override System properties that have been set via systemPropertiesFile. Optional.

Type: org.jszip.jetty.SystemProperties
Required: No

testClassesDirectory:

The directory containing generated test classes.

Type: java.io.File
Required: Yes
User Property: project.build.testOutputDirectory

useTestScope:

If true, the <testOutputDirectory> and the dependencies of <scope>test<scope> will be put first on the runtime classpath.

Type: boolean
Required: No
Default: false

warSourceDirectory:

Root directory for all html/jsp etc files

Type: java.io.File
Required: Yes
Default: ${basedir}/src/main/webapp