com.vaadin.flow.plugin.maven

Class FlowModeAbstractMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.vaadin.flow.plugin.maven.FlowModeAbstractMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

BuildFrontendMojo, CleanFrontendMojo, CopyProductionFilesMojo, PackageForProductionMojo, PrepareFrontendMojo

public abstract class FlowModeAbstractMojo
extends org.apache.maven.plugin.AbstractMojo

The base class of Flow Mojos in order to compute correctly the modes.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	ciBuild Setting this to true will run npm ci instead of npm install when using npm.
protected File	frontendDirectory A directory with project's frontend source files.
protected String	nodeDownloadRoot Download node.js from this URL.
protected String	nodeVersion The node.js version to be used when node.js is installed automatically by Vaadin, for example `"v14.15.4"`.
protected boolean	pnpmEnable Instructs to use pnpm for installing npm frontend resources.
boolean	productionMode Whether or not we are running in productionMode.
protected boolean	requireHomeNodeExec Whether vaadin home node executable usage is forced.
protected File	webpackOutputDirectory The folder where webpack should output index.js and other generated files.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
FlowModeAbstractMojo()

Method Summary

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 org.apache.maven.plugin.Mojo

execute

Field Detail

productionMode

@Parameter(defaultValue="${vaadin.productionMode}")
public boolean productionMode

Whether or not we are running in productionMode.

webpackOutputDirectory

@Parameter(defaultValue="${project.build.outputDirectory}/META-INF/VAADIN/")
protected File webpackOutputDirectory

The folder where webpack should output index.js and other generated files.

pnpmEnable

@Parameter(property="pnpm.enable",
           defaultValue="false")
protected boolean pnpmEnable

Instructs to use pnpm for installing npm frontend resources.

requireHomeNodeExec

@Parameter(property="require.home.node",
           defaultValue="false")
protected boolean requireHomeNodeExec

Whether vaadin home node executable usage is forced. If it's set to true then vaadin home 'node' is checked and installed if it's absent. Then it will be used instead of globally 'node' or locally installed installed 'node'.

nodeVersion

@Parameter(property="node.version",
           defaultValue="v22.14.0")
protected String nodeVersion

The node.js version to be used when node.js is installed automatically by Vaadin, for example `"v14.15.4"`. Defaults to null which uses the Vaadin-default node version - see FrontendTools for details.

nodeDownloadRoot

@Parameter(property="node.download.root")
protected String nodeDownloadRoot

Download node.js from this URL. Handy in heavily firewalled corporate environments where the node.js download can be provided from an intranet mirror. Defaults to null which will cause the downloader to use NodeInstaller.DEFAULT_NODEJS_DOWNLOAD_ROOT.

Example: "https://nodejs.org/dist/".

frontendDirectory

@Parameter(defaultValue="${project.basedir}/frontend/")
protected File frontendDirectory

A directory with project's frontend source files.

ciBuild

@Parameter(property="ci.build",
           defaultValue="false")
protected boolean ciBuild

Setting this to true will run npm ci instead of npm install when using npm. If using pnpm, the install will be run with --frozen-lockfile parameter. This makes sure that the versions in package lock file will not be overwritten and production builds are reproducible.

Constructor Detail

FlowModeAbstractMojo

public FlowModeAbstractMojo()