com.vaadin.flow.plugin.maven

Class BuildFrontendMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

com.vaadin.flow.plugin.maven.BuildFrontendMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="build-frontend",
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      defaultPhase=PREPARE_PACKAGE)
public class BuildFrontendMojo
extends FlowModeAbstractMojo

Goal that builds the frontend bundle. It performs the following actions when creating a package:

• Update Constants.PACKAGE_JSON file with the NpmPackage annotations defined in the classpath,
• Copy resource files used by flow from `.jar` files to the `node_modules` folder
• Install dependencies by running npm install
• Update the FrontendUtils.IMPORTS_NAME file imports with the JsModule Theme and JavaScript annotations defined in the classpath,
• Update FrontendUtils.WEBPACK_CONFIG file.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected File	frontendResourcesDirectory Defines the project frontend directory from where resources should be copied from for use with webpack.
boolean	oldLicenseChecker Whether to use old JavaScript license checker and disable server-side and offline features of the new license checker.

Fields inherited from class com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

compatibility, compatibilityMode, frontendDirectory, nodeDownloadRoot, nodeVersion, pnpmEnable, productionMode, requireHomeNodeExec, webpackOutputDirectory

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
BuildFrontendMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

frontendResourcesDirectory

@Parameter(defaultValue="${project.basedir}/src/main/resources/META-INF/resources/frontend")
protected File frontendResourcesDirectory

Defines the project frontend directory from where resources should be copied from for use with webpack.

oldLicenseChecker

@Parameter(defaultValue="false")
public boolean oldLicenseChecker

Whether to use old JavaScript license checker and disable server-side and offline features of the new license checker.

Compatibility/Bower mode always uses old license checking.

Constructor Detail

BuildFrontendMojo

public BuildFrontendMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class FlowModeAbstractMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException