Fork me on GitHub

gwt:run-codeserver

Full name:

org.codehaus.mojo:gwt-maven-plugin:2.8.2-SNAPSHOT:run-codeserver

Description:

Runs GWT modules with Super Dev Mode.

Attributes:

  • Requires a Maven project to be executed.
  • Executes by direct invocation only.
  • Requires dependency resolution of artifacts in scope: compile.
  • Since version: 2.5.0-rc1.
  • Invokes the execution of the lifecycle phase process-classes prior to executing itself.

Required Parameters

Name Type Since Description
generateDirectory File 2.5.0-rc1 Folder where generated-source will be created (automatically added to compile classpath).
Default value is: ${project.build.directory}/generated-sources/gwt.

Optional Parameters

Name Type Since Description
bindAddress String 2.5.0-rc1 Set SuperDevMode's bindAddress.

Can be set from command line using '-Dgwt.bindAddress=...'


User property is: gwt.bindAddress.
codeServerPort Integer 2.5.0-rc1 The port where the code server will run.
User property is: gwt.codeServerPort.
codeServerWorkDir File 2.5.0-rc1 The root of the directory tree where the code server will write compiler output. If not supplied, a temporary directory will be used.
compileSourcesArtifacts String[] 2.5.0-rc1 Deprecated. add a <classifier>sources</classifier> dependency instead
deploy File 2.3.0-1 The directory into which deployable but not servable output files will be written (defaults to 'WEB-INF/deploy' under the webappDirectory directory/jar, and may be the same as the extra directory/jar)
executedProject MavenProject 2.5.0-rc1 The MavenProject executed by the "process-classes" phase.
Default value is: ${executedProject}.
extraJvmArgs String 2.5.0-rc1 Extra JVM arguments that are passed to the GWT-Maven generated scripts (for compiler, shell, etc - typically use -Xmx512m here, or -XstartOnFirstThread, etc).

Can be set from command line using '-Dgwt.extraJvmArgs=...', defaults to setting max Heap size to be large enough for most GWT use cases.


Default value is: -Xmx512m.
User property is: gwt.extraJvmArgs.
failOnError boolean 2.7.0-rc1 Stop compiling if a module has a Java file with a compile error, even if unused.

Can be set from command line using '-Dgwt.compiler.strict=true'.


Default value is: false.
User property is: gwt.compiler.strict.
gen File 2.5.0-rc1 Location on filesystem where GWT will write generated content for review (-gen option to GWT Compiler).

Can be set from command line using '-Dgwt.gen=...'


Default value is: ${project.build.directory}/.generated.
User property is: gwt.gen.
genParam boolean 2.5.0-rc1 Whether to add -gen parameter to the compiler command line

Can be set from command line using '-Dgwt.genParam=false'. Defaults to 'true' for backwards compatibility.


Default value is: true.
User property is: gwt.genParam.
generateJsInteropExports boolean 2.8.0-rc1 Generate exports for JsInterop purposes.
Default value is: false.
User property is: gwt.compiler.generateJsInteropExports.
gwtSdkFirstInClasspath boolean 2.1.0-1 Deprecated. tweak your dependencies and/or split your project with a client-only module
Default value is: false.
User property is: gwt.gwtSdkFirstInClasspath.
incremental boolean 2.7.0-rc1 Compiles faster by reusing data from the previous compile.
Default value is: true.
User property is: gwt.compiler.incremental.
inplace boolean 2.5.0-rc1 Select the place where GWT application is built. In inplace mode, the warSourceDirectory is used to match the same use case of the war:inplace http://maven.apache.org/plugins/maven-war-plugin/inplace-mojo.html goal.
Default value is: false.
User property is: gwt.inplace.
jvm String 1.1 Option to specify the jvm (or path to the java executable) to use with the forking scripts. For the default, the jvm will be the same as the one used to run Maven.
User property is: gwt.jvm.
launcherDir File 2.7.0 An output directory where files for launching Super Dev Mode will be written. (Optional.)
User property is: gwt.codeServer.launcherDir.
logLevel String 2.5.0-rc1 GWT logging level (-logLevel ERROR, WARN, INFO, TRACE, DEBUG, SPAM, or ALL).

Can be set from command line using '-Dgwt.logLevel=...'


Default value is: INFO.
User property is: gwt.logLevel.
methodNameDisplayMode String 2.7.0-rc1 EXPERIMENTAL: Emit extra information allow chrome dev tools to display Java identifiers in many places instead of JavaScript functions.

Value can be one of NONE, ONLY_METHOD_NAME, ABBREVIATED or FULL.


Default value is: NONE.
User property is: gwt.compiler.methodNameDisplayMode.
module String 2.5.0-rc1 A single GWT module. Shortcut for <modules> or option to specify a single module from command line
User property is: gwt.module.
modulePathPrefix String 2.5.0-rc1 Prefix to prepend to module names inside webappDirectory or in URLs in DevMode.

Could also be seen as a suffix to webappDirectory.


User property is: gwt.modulePathPrefix.
modules String[] 2.5.0-rc1 The project GWT modules. If not set, the plugin will scan the project for .gwt.xml files.
persistentunitcache Boolean 2.5.0-rc1 Whether to use the persistent unit cache or not.

Can be set from command line using '-Dgwt.persistentunitcache=...'


User property is: gwt.persistentunitcache.
persistentunitcachedir File 2.5.0-rc1 The directory where the persistent unit cache will be created if enabled.

Can be set from command line using '-Dgwt.persistentunitcachedir=...'


User property is: gwt.persistentunitcachedir.
precompile boolean 2.6.0-rc1 Precompile modules.
Default value is: true.
User property is: gwt.codeServer.precompile.
sourceLevel String 2.6.0-rc1 Specifies Java source level.
Default value is: auto.
User property is: maven.compiler.source.
style String 2.5.0-rc1 GWT JavaScript compiler output style (-style OBF[USCATED], PRETTY, or DETAILED).

Can be set from command line using '-Dgwt.style=...'


User property is: gwt.style.
timeOut int 2.5.0-rc1 Forked process execution timeOut. Usefull to avoid maven to hang in continuous integration server.
warSourceDirectory File 2.5.0-rc1 Location of the web application static resources (same as maven-war-plugin parameter)
Default value is: ${basedir}/src/main/webapp.
webappDirectory File 2.5.0-rc1 Location on filesystem where GWT will write output files (-out option to GWTCompiler).
Default value is: ${project.build.directory}/${project.build.finalName}.
User property is: gwt.war.

Parameter Details

bindAddress:

Set SuperDevMode's bindAddress.

Can be set from command line using '-Dgwt.bindAddress=...'

  • Type: java.lang.String
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.bindAddress

codeServerPort:

The port where the code server will run.
  • Type: java.lang.Integer
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.codeServerPort

codeServerWorkDir:

The root of the directory tree where the code server will write compiler output. If not supplied, a temporary directory will be used.
  • Type: java.io.File
  • Since: 2.5.0-rc1
  • Required: No

compileSourcesArtifacts:

Deprecated. add a <classifier>sources</classifier> dependency instead
Artifacts to be included as source-jars in GWTCompiler Classpath. Removes the restriction that source code must be bundled inside of the final JAR when dealing with external utility libraries not designed exclusivelly for GWT. The plugin will download the source.jar if necessary. This option is a workaround to avoid packaging sources inside the same JAR when splitting and application into modules. A smaller JAR can then be used on server classpath and distributed without sources (that may not be desirable).
  • Type: java.lang.String[]
  • Since: 2.5.0-rc1
  • Required: No

deploy:

The directory into which deployable but not servable output files will be written (defaults to 'WEB-INF/deploy' under the webappDirectory directory/jar, and may be the same as the extra directory/jar)
  • Type: java.io.File
  • Since: 2.3.0-1
  • Required: No

executedProject:

The MavenProject executed by the "process-classes" phase.
  • Type: org.apache.maven.project.MavenProject
  • Since: 2.5.0-rc1
  • Required: No
  • Default: ${executedProject}

extraJvmArgs:

Extra JVM arguments that are passed to the GWT-Maven generated scripts (for compiler, shell, etc - typically use -Xmx512m here, or -XstartOnFirstThread, etc).

Can be set from command line using '-Dgwt.extraJvmArgs=...', defaults to setting max Heap size to be large enough for most GWT use cases.

  • Type: java.lang.String
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.extraJvmArgs
  • Default: -Xmx512m

failOnError:

Stop compiling if a module has a Java file with a compile error, even if unused.

Can be set from command line using '-Dgwt.compiler.strict=true'.

  • Type: boolean
  • Since: 2.7.0-rc1
  • Required: No
  • User Property: gwt.compiler.strict
  • Default: false

gen:

Location on filesystem where GWT will write generated content for review (-gen option to GWT Compiler).

Can be set from command line using '-Dgwt.gen=...'

  • Type: java.io.File
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.gen
  • Default: ${project.build.directory}/.generated

genParam:

Whether to add -gen parameter to the compiler command line

Can be set from command line using '-Dgwt.genParam=false'. Defaults to 'true' for backwards compatibility.

  • Type: boolean
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.genParam
  • Default: true

generateDirectory:

Folder where generated-source will be created (automatically added to compile classpath).
  • Type: java.io.File
  • Since: 2.5.0-rc1
  • Required: Yes
  • Default: ${project.build.directory}/generated-sources/gwt

generateJsInteropExports:

Generate exports for JsInterop purposes.
  • Type: boolean
  • Since: 2.8.0-rc1
  • Required: No
  • User Property: gwt.compiler.generateJsInteropExports
  • Default: false

gwtSdkFirstInClasspath:

Deprecated. tweak your dependencies and/or split your project with a client-only module
The forked command line will use gwt sdk jars first in classpath. see issue http://code.google.com/p/google-web-toolkit/issues/detail?id=5290
  • Type: boolean
  • Since: 2.1.0-1
  • Required: No
  • User Property: gwt.gwtSdkFirstInClasspath
  • Default: false

incremental:

Compiles faster by reusing data from the previous compile.
  • Type: boolean
  • Since: 2.7.0-rc1
  • Required: No
  • User Property: gwt.compiler.incremental
  • Default: true

inplace:

Select the place where GWT application is built. In inplace mode, the warSourceDirectory is used to match the same use case of the war:inplace http://maven.apache.org/plugins/maven-war-plugin/inplace-mojo.html goal.
  • Type: boolean
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.inplace
  • Default: false

jvm:

Option to specify the jvm (or path to the java executable) to use with the forking scripts. For the default, the jvm will be the same as the one used to run Maven.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: gwt.jvm

launcherDir:

An output directory where files for launching Super Dev Mode will be written. (Optional.)
  • Type: java.io.File
  • Since: 2.7.0
  • Required: No
  • User Property: gwt.codeServer.launcherDir

logLevel:

GWT logging level (-logLevel ERROR, WARN, INFO, TRACE, DEBUG, SPAM, or ALL).

Can be set from command line using '-Dgwt.logLevel=...'

  • Type: java.lang.String
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.logLevel
  • Default: INFO

methodNameDisplayMode:

EXPERIMENTAL: Emit extra information allow chrome dev tools to display Java identifiers in many places instead of JavaScript functions.

Value can be one of NONE, ONLY_METHOD_NAME, ABBREVIATED or FULL.

  • Type: java.lang.String
  • Since: 2.7.0-rc1
  • Required: No
  • User Property: gwt.compiler.methodNameDisplayMode
  • Default: NONE

module:

A single GWT module. Shortcut for <modules> or option to specify a single module from command line
  • Type: java.lang.String
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.module

modulePathPrefix:

Prefix to prepend to module names inside webappDirectory or in URLs in DevMode.

Could also be seen as a suffix to webappDirectory.

  • Type: java.lang.String
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.modulePathPrefix

modules:

The project GWT modules. If not set, the plugin will scan the project for .gwt.xml files.
  • Type: java.lang.String[]
  • Since: 2.5.0-rc1
  • Required: No

persistentunitcache:

Whether to use the persistent unit cache or not.

Can be set from command line using '-Dgwt.persistentunitcache=...'

  • Type: java.lang.Boolean
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.persistentunitcache

persistentunitcachedir:

The directory where the persistent unit cache will be created if enabled.

Can be set from command line using '-Dgwt.persistentunitcachedir=...'

  • Type: java.io.File
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.persistentunitcachedir

precompile:

Precompile modules.
  • Type: boolean
  • Since: 2.6.0-rc1
  • Required: No
  • User Property: gwt.codeServer.precompile
  • Default: true

sourceLevel:

Specifies Java source level.
  • Type: java.lang.String
  • Since: 2.6.0-rc1
  • Required: No
  • User Property: maven.compiler.source
  • Default: auto

style:

GWT JavaScript compiler output style (-style OBF[USCATED], PRETTY, or DETAILED).

Can be set from command line using '-Dgwt.style=...'

  • Type: java.lang.String
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.style

timeOut:

Forked process execution timeOut. Usefull to avoid maven to hang in continuous integration server.
  • Type: int
  • Since: 2.5.0-rc1
  • Required: No

warSourceDirectory:

Location of the web application static resources (same as maven-war-plugin parameter)
  • Type: java.io.File
  • Since: 2.5.0-rc1
  • Required: No
  • Default: ${basedir}/src/main/webapp

webappDirectory:

Location on filesystem where GWT will write output files (-out option to GWTCompiler).
  • Type: java.io.File
  • Since: 2.5.0-rc1
  • Required: No
  • User Property: gwt.war
  • Default: ${project.build.directory}/${project.build.finalName}