Package com.vaadin.flow.plugin.maven

Class PrepareFrontendMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

com.vaadin.flow.plugin.maven.PrepareFrontendMojo

All Implemented Interfaces:

com.vaadin.flow.plugin.base.PluginAdapterBase, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="prepare-frontend",
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      defaultPhase=PROCESS_RESOURCES)
public class PrepareFrontendMojo
extends FlowModeAbstractMojo

This goal checks that node and npm tools are installed and creates or updates `package.json` and the frontend build tool configuration files.

Copies frontend resources available inside `.jar` dependencies to `node_modules` when building a jar package.

Since:

2.0

Field Summary

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

INCLUDE_FROM_COMPILE_DEPS_REGEX, productionMode

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

ROLE

Constructor Summary

Constructors

Constructor	Description
PrepareFrontendMojo()

Method Summary

Modifier and Type	Method	Description
protected void	executeInternal()	Perform whatever build-process behavior this Mojo implements. This is the main trigger for the Mojo inside the Maven system, and allows the Mojo to communicate errors.

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

applicationIdentifier, applicationProperties, buildFolder, bunEnable, eagerServerLoad, execute, frontendDirectory, frontendExtraFileExtensions, frontendOutputDirectory, generatedTsFolder, getClassFinder, getJarFiles, isCommercialBannerEnabled, isDebugEnabled, isFrontendHotdeploy, isFrontendIgnoreVersionChecks, isHillaAvailable, isHillaAvailable, isHillaUsed, isHillaUsed, isJarProject, isNpmExcludeWebComponents, isPrepareFrontendCacheDisabled, isReactEnabled, javaResourceFolder, javaSourceFolder, logDebug, logDebug, logError, logError, logInfo, logWarn, logWarn, nodeDownloadRoot, nodeFolder, nodeVersion, npmFolder, openApiJsonFile, pnpmEnable, postinstallPackages, projectBaseDirectory, requireHomeNodeExec, servletResourceOutputDirectory, skipDevBundleBuild, triggerRefresh, useGlobalPnpm, webpackOutputDirectory

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

Methods inherited from interface com.vaadin.flow.plugin.base.PluginAdapterBase

createLookup

Constructor Details

PrepareFrontendMojo

public PrepareFrontendMojo()

Method Details

executeInternal

protected void executeInternal()
                        throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Description copied from class: FlowModeAbstractMojo

Perform whatever build-process behavior this Mojo implements.
This is the main trigger for the Mojo inside the Maven system, and allows the Mojo to communicate errors.

Specified by:

executeInternal in class FlowModeAbstractMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - if an unexpected problem occurs. Throwing this exception causes a "BUILD ERROR" message to be displayed.

org.apache.maven.plugin.MojoFailureException - if an expected problem (such as a compilation failure) occurs. Throwing this exception causes a "BUILD FAILURE" message to be displayed.