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, LockDevDepVersionsMojo, 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 File	applicationProperties Application properties file in Spring project.
boolean	eagerServerLoad Whether or not insert the initial Uidl object in the bootstrap index.html
File	frontendDirectory A directory with project's frontend source files.
File	generatedFolder The folder where flow will put generated files that will be used by webpack.
protected File	generatedTsFolder The folder where flow will put TS API files for client projects.
protected File	javaSourceFolder Java source folders for scanning.
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"`.
File	npmFolder The folder where `package.json` file is located.
protected File	openApiJsonFile Default generated path of the OpenAPI json.
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	resourceOutputDirectory Defines the output directory for generated non-served resources, such as the token file.
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

Modifier and Type	Method and Description
protected Lookup	createLookup(ClassFinder classFinder)
boolean	useDeprecatedV14Bootstrapping() Check if the plugin is running in legacy V14 bootstrap mode or not.

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

npmFolder

@Parameter(defaultValue="${project.basedir}")
public File npmFolder

The folder where `package.json` file is located. Default is project root dir.

generatedFolder

@Parameter(defaultValue="${project.build.directory}/frontend/")
public File generatedFolder

The folder where flow will put generated files that will be used by webpack.

frontendDirectory

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

A directory with project's frontend source files.

productionMode

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

Whether or not we are running in productionMode.

eagerServerLoad

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

Whether or not insert the initial Uidl object in the bootstrap index.html

webpackOutputDirectory

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

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

applicationProperties

@Parameter(defaultValue="${project.basedir}/src/main/resources/application.properties")
protected File applicationProperties

Application properties file in Spring project.

openApiJsonFile

@Parameter(defaultValue="${project.build.directory}/generated-resources/openapi.json")
protected File openApiJsonFile

Default generated path of the OpenAPI json.

javaSourceFolder

@Parameter(defaultValue="${project.basedir}/src/main/java")
protected File javaSourceFolder

Java source folders for scanning.

generatedTsFolder

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

The folder where flow will put TS API files for client projects.

resourceOutputDirectory

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

Defines the output directory for generated non-served resources, such as the token file.

pnpmEnable

@Parameter(property="pnpm.enable",
           defaultValue="true")
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="v14.15.4")
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",
           defaultValue="https://nodejs.org/dist/")
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/".

Constructor Detail

FlowModeAbstractMojo

public FlowModeAbstractMojo()

Method Detail

useDeprecatedV14Bootstrapping

public boolean useDeprecatedV14Bootstrapping()

Check if the plugin is running in legacy V14 bootstrap mode or not. Default: false.

Returns:

true if the `useDeprecatedV14Bootstrapping` is empty or true.

createLookup

protected Lookup createLookup(ClassFinder classFinder)