Package com.vaadin.flow.plugin.maven

Class BuildDevBundleMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.vaadin.flow.plugin.maven.BuildDevBundleMojo

All Implemented Interfaces:

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

@Mojo(name="build-dev-bundle",
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      defaultPhase=PROCESS_CLASSES)
public class BuildDevBundleMojo
extends org.apache.maven.plugin.AbstractMojo
implements PluginAdapterBuild, PluginAdapterBase

Goal that builds the dev frontend bundle to be used in Express Build mode. 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.VITE_CONFIG file.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCLUDE_FROM_COMPILE_DEPS_REGEX	Additionally include compile-time-only dependencies matching the pattern.

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

ROLE

Constructor Summary

Constructors

Constructor	Description
BuildDevBundleMojo()

Method Summary

Modifier and Type	Method	Description
String	applicationIdentifier()
File	applicationProperties()
String	buildFolder()
boolean	bunEnable()
boolean	checkRuntimeDependency(String groupId, String artifactId, Consumer<String> missingDependencyMessageConsumer)
boolean	ciBuild()
boolean	compressBundle()
boolean	eagerServerLoad()
void	execute()
void	executeInternal()
boolean	forceProductionBuild()
File	frontendDirectory()
List<String>	frontendExtraFileExtensions()
File	frontendOutputDirectory()
File	frontendResourcesDirectory()
boolean	generateBundle()
File	generatedTsFolder()
boolean	generateEmbeddableWebComponents()
com.vaadin.flow.server.frontend.scanner.ClassFinder	getClassFinder()
Set<File>	getJarFiles()
boolean	isDebugEnabled()
boolean	isFrontendHotdeploy()
boolean	isFrontendIgnoreVersionChecks()
boolean	isJarProject()
boolean	isNpmExcludeWebComponents()
boolean	isPrepareFrontendCacheDisabled()
boolean	isReactEnabled()
File	javaResourceFolder()
File	javaSourceFolder()
void	logDebug(CharSequence debugMessage)
void	logDebug(CharSequence debugMessage, Throwable e)
void	logError(CharSequence error)
void	logError(CharSequence error, Throwable e)
void	logInfo(CharSequence infoMessage)
void	logWarn(CharSequence warning)
void	logWarn(CharSequence warning, Throwable e)
boolean	nodeAutoUpdate()
URI	nodeDownloadRoot()
String	nodeVersion()
File	npmFolder()
File	openApiJsonFile()
boolean	optimizeBundle()
boolean	pnpmEnable()
List<String>	postinstallPackages()
Path	projectBaseDirectory()
boolean	requireHomeNodeExec()
boolean	runNpmInstall()
File	servletResourceOutputDirectory()
boolean	skipDevBundleBuild()
boolean	useGlobalPnpm()
File	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, isCommercialBannerEnabled

Field Details

INCLUDE_FROM_COMPILE_DEPS_REGEX

public static final String INCLUDE_FROM_COMPILE_DEPS_REGEX

Additionally include compile-time-only dependencies matching the pattern.

See Also:

• Constant Field Values

Constructor Details

BuildDevBundleMojo

public BuildDevBundleMojo()

Method Details

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeInternal

public void executeInternal()
                     throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

frontendResourcesDirectory

public File frontendResourcesDirectory()

Specified by:

frontendResourcesDirectory in interface PluginAdapterBuild

generateBundle

public boolean generateBundle()

Specified by:

generateBundle in interface PluginAdapterBuild

generateEmbeddableWebComponents

public boolean generateEmbeddableWebComponents()

Specified by:

generateEmbeddableWebComponents in interface PluginAdapterBuild

optimizeBundle

public boolean optimizeBundle()

Specified by:

optimizeBundle in interface PluginAdapterBuild

runNpmInstall

public boolean runNpmInstall()

Specified by:

runNpmInstall in interface PluginAdapterBuild

ciBuild

public boolean ciBuild()

Specified by:

ciBuild in interface PluginAdapterBuild

forceProductionBuild

public boolean forceProductionBuild()

Specified by:

forceProductionBuild in interface PluginAdapterBuild

compressBundle

public boolean compressBundle()

Specified by:

compressBundle in interface PluginAdapterBuild

applicationProperties

public File applicationProperties()

Specified by:

applicationProperties in interface PluginAdapterBase

eagerServerLoad

public boolean eagerServerLoad()

Specified by:

eagerServerLoad in interface PluginAdapterBase

frontendDirectory

public File frontendDirectory()

Specified by:

frontendDirectory in interface PluginAdapterBase

generatedTsFolder

public File generatedTsFolder()

Specified by:

generatedTsFolder in interface PluginAdapterBase

getClassFinder

public com.vaadin.flow.server.frontend.scanner.ClassFinder getClassFinder()

Specified by:

getClassFinder in interface PluginAdapterBase

getJarFiles

public Set<File> getJarFiles()

Specified by:

getJarFiles in interface PluginAdapterBase

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface PluginAdapterBase

javaSourceFolder

public File javaSourceFolder()

Specified by:

javaSourceFolder in interface PluginAdapterBase

javaResourceFolder

public File javaResourceFolder()

Specified by:

javaResourceFolder in interface PluginAdapterBase

logDebug

public void logDebug(CharSequence debugMessage)

Specified by:

logDebug in interface PluginAdapterBase

logDebug

public void logDebug(CharSequence debugMessage,
 Throwable e)

Specified by:

logDebug in interface PluginAdapterBase

logInfo

public void logInfo(CharSequence infoMessage)

Specified by:

logInfo in interface PluginAdapterBase

logWarn

public void logWarn(CharSequence warning)

Specified by:

logWarn in interface PluginAdapterBase

logError

public void logError(CharSequence error)

Specified by:

logError in interface PluginAdapterBase

logWarn

public void logWarn(CharSequence warning,
 Throwable e)

Specified by:

logWarn in interface PluginAdapterBase

logError

public void logError(CharSequence error,
 Throwable e)

Specified by:

logError in interface PluginAdapterBase

nodeDownloadRoot

public URI nodeDownloadRoot()
                     throws URISyntaxException

Specified by:

nodeDownloadRoot in interface PluginAdapterBase

Throws:

URISyntaxException

nodeAutoUpdate

public boolean nodeAutoUpdate()

Specified by:

nodeAutoUpdate in interface PluginAdapterBase

nodeVersion

public String nodeVersion()

Specified by:

nodeVersion in interface PluginAdapterBase

npmFolder

public File npmFolder()

Specified by:

npmFolder in interface PluginAdapterBase

openApiJsonFile

public File openApiJsonFile()

Specified by:

openApiJsonFile in interface PluginAdapterBase

pnpmEnable

public boolean pnpmEnable()

Specified by:

pnpmEnable in interface PluginAdapterBase

bunEnable

public boolean bunEnable()

Specified by:

bunEnable in interface PluginAdapterBase

useGlobalPnpm

public boolean useGlobalPnpm()

Specified by:

useGlobalPnpm in interface PluginAdapterBase

projectBaseDirectory

public Path projectBaseDirectory()

Specified by:

projectBaseDirectory in interface PluginAdapterBase

requireHomeNodeExec

public boolean requireHomeNodeExec()

Specified by:

requireHomeNodeExec in interface PluginAdapterBase

servletResourceOutputDirectory

public File servletResourceOutputDirectory()

Specified by:

servletResourceOutputDirectory in interface PluginAdapterBase

webpackOutputDirectory

public File webpackOutputDirectory()

Specified by:

webpackOutputDirectory in interface PluginAdapterBase

frontendOutputDirectory

public File frontendOutputDirectory()

Specified by:

frontendOutputDirectory in interface PluginAdapterBase

isJarProject

public boolean isJarProject()

Specified by:

isJarProject in interface PluginAdapterBase

buildFolder

public String buildFolder()

Specified by:

buildFolder in interface PluginAdapterBase

postinstallPackages

public List<String> postinstallPackages()

Specified by:

postinstallPackages in interface PluginAdapterBase

isFrontendHotdeploy

public boolean isFrontendHotdeploy()

Specified by:

isFrontendHotdeploy in interface PluginAdapterBase

skipDevBundleBuild

public boolean skipDevBundleBuild()

Specified by:

skipDevBundleBuild in interface PluginAdapterBase

isPrepareFrontendCacheDisabled

public boolean isPrepareFrontendCacheDisabled()

Specified by:

isPrepareFrontendCacheDisabled in interface PluginAdapterBase

isReactEnabled

public boolean isReactEnabled()

Specified by:

isReactEnabled in interface PluginAdapterBase

applicationIdentifier

public String applicationIdentifier()

Specified by:

applicationIdentifier in interface PluginAdapterBase

frontendExtraFileExtensions

public List<String> frontendExtraFileExtensions()

Specified by:

frontendExtraFileExtensions in interface PluginAdapterBase

checkRuntimeDependency

public boolean checkRuntimeDependency(String groupId,
 String artifactId,
 Consumer<String> missingDependencyMessageConsumer)

Specified by:

checkRuntimeDependency in interface PluginAdapterBuild

isNpmExcludeWebComponents

public boolean isNpmExcludeWebComponents()

Specified by:

isNpmExcludeWebComponents in interface PluginAdapterBase

isFrontendIgnoreVersionChecks

public boolean isFrontendIgnoreVersionChecks()

Specified by:

isFrontendIgnoreVersionChecks in interface PluginAdapterBase