Documentation on vaadin-maven-plugin

Hello all,

Where can I find documentation on vaadin-maven-plugin? I would like more info on available parameters () and available goals. Also, I believe this plugin is very close to, or event extends gwt-maven-plugin, so knowing what parameters and goals are specific to vaadin and those general to gwt would be good to know too.

Thanks,
ng

I don’t know how the plugin actually relates to
gwt-maven-plugin
, but by typing
mvn help:describe -Dplugin=vaadin
you get following info:

Name:
Vaadin Plug-in for Maven

Description: Maven plugin for Vaadin.
Group Id: com.vaadin
Artifact Id: vaadin-maven-plugin
Version: 7.6.0.alpha2
Goal Prefix: vaadin

This plugin has 22 goals:


vaadin:browser

Description: (no description available)


vaadin:clean

Description: Cleanup the webapp directory for GWT module compilation output


vaadin:compile

Description: Invokes the GWTCompiler for the project source. See compiler
options :
http://code.google.com/intl/fr-FR/webtoolkit/doc/latest/DevGuideCompilingAndDebugging.html#DevGuideCompilerOptions


vaadin:compile-report

Description: see
http://code.google.com/webtoolkit/doc/latest/DevGuideCompileReport.html#Usage


vaadin:compile-theme

Description: Updates Vaadin themes based on addons containing themes on the
classpath.


vaadin:css

Description: Creates CSS interfaces for css files. Will use the utility
tool provided in gwt sdk which create a corresponding Java interface for
accessing the classnames used in the file.


vaadin:debug

Description: Extends the gwt goal and runs the project in the GWT Hosted
mode with a debugger port hook (optionally suspended).


vaadin:eclipse

Description: Goal which creates Eclipse lauch configurations for GWT
modules.


vaadin:eclipseTest

Description: Goal which creates Eclipse lauch configurations for
GWTTestCases.
Deprecated. use google eclipse plugin
http://code.google.com/intl/fr-FR/eclipse/docs/users_guide.html


vaadin:generateAsync

Description: Goal which generate Asyn interface.


vaadin:help

Description: Display help information on vaadin-maven-plugin.
Call
mvn vaadin:help -Ddetail=true -Dgoal=
to display parameter details.


vaadin:i18n

Description: Creates I18N interfaces for constants and messages files.


vaadin:mergewebxml

Description: Merges GWT servlet elements into deployment descriptor (and
non GWT servlets into shell).
If you use scanRemoteServiceRelativePathAnnotation you must bind this mojo
to at least compile phase Because the classpath scanner need to see compile
classes


vaadin:resources

Description: Copy GWT java source code and module descriptor as resources
in the build outputDirectory. Alternative to declaring a in the
POM with finer filtering as the module descriptor is read to detect sources
to be copied.


vaadin:run

Description: Goal which run a GWT module in the GWT Hosted mode.


vaadin:run-codeserver

Description: EXPERIMENTAL: Runs GWT modules with Super Dev Mode.


vaadin:sdkInstall

Description: Install a GWT (home built) SDK in local repository


vaadin:source-jar

Description: Add GWT java source code and module descriptor as resources to
project jar. Alternative to gwt:resources for better Eclipse projects
synchronization.


vaadin:soyc

Description: (no description available)
Deprecated. You must now use the CompileReport, SoycDashboard is not anymore
supported will be removed in 2.1.2


vaadin:test

Description: Mimic surefire to run GWTTestCases during integration-test
phase, until SUREFIRE-508 is fixed


vaadin:update-theme

Description: Updates Vaadin themes based on addons containing themes on the
classpath. This goal is linked to phase generate-sources to make sure it is
executed before compile-theme.


vaadin:update-widgetset

Description: Updates Vaadin widgetsets based on other widgetset packages on
the classpath. It is assumed that the project does not directly contain
other GWT modules. In part adapted from gwt-maven-plugin CompileMojo.

For more information, run ‘mvn help:describe […]
-Ddetail’

Excellent!
mvn help:describe -Dplugin=vaadin -Ddetail
gives me all the goals and all the parameters for each goal!
Thanks!

This is insane. There should be a page documenting all goals and mojos of the vaadin-maven-plugin.

The plugin sources are here: https://github.com/vaadin/maven-plugin but it only links a gwt-maven-plugin and the link is broken. There is no documentation on how to compile a theme and how to compile a theme from src/main/resources for Vaadin 7.6.5. The documentation is lacking in this area.

Still found nothing on the internet…

FYI: for the newer vaadin versions the source for the plugins can be found here: [https://github.com/vaadin/flow/blob/master/flow-maven-plugin/src/main/java/com/vaadin/flow/plugin/maven/PrepareFrontendMojo.java]
(https://github.com/vaadin/flow/blob/master/flow-maven-plugin/src/main/java/com/vaadin/flow/plugin/maven/PrepareFrontendMojo.java)