Package com.vaadin.hilla.maven

Class BuildFrontendMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
com.vaadin.flow.plugin.maven.FlowModeAbstractMojo
com.vaadin.flow.plugin.maven.BuildFrontendMojo
com.vaadin.hilla.maven.BuildFrontendMojo
All Implemented Interfaces:
com.vaadin.flow.plugin.base.PluginAdapterBase, com.vaadin.flow.plugin.base.PluginAdapterBuild, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
@Mojo(name="build-frontend", requiresDependencyResolution=COMPILE_PLUS_RUNTIME, defaultPhase=PROCESS_CLASSES) public class BuildFrontendMojo extends com.vaadin.flow.plugin.maven.BuildFrontendMojo
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.VITE_CONFIG file.
Since:
Flow 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
    BuildFrontendMojo()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default EngineAutoConfiguration
    configure()
     
    protected void
    executeInternal()
     
    File
    getFrontend()
     
    File
    getGenerated()
     
    String
    getMainClass()
     
    String
    getNode()
     
    Map
    getPluginContext()
     

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

    checkRuntimeDependency, ciBuild, cleanFrontendFiles, compressBundle, forceProductionBuild, frontendResourcesDirectory, generateBundle, generateEmbeddableWebComponents, optimizeBundle, runNpmInstall

    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, nodeAutoUpdate, nodeDownloadRoot, 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

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

  • Constructor Details

    • BuildFrontendMojo

      public BuildFrontendMojo()

  • Method Details

    • executeInternal

      protected void executeInternal() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
      Overrides:
      executeInternal in class com.vaadin.flow.plugin.maven.BuildFrontendMojo
      Throws:
      org.apache.maven.plugin.MojoExecutionException
      org.apache.maven.plugin.MojoFailureException

    • getNode

      public String getNode()

    • getMainClass

      public String getMainClass()

    • getFrontend

      public File getFrontend()

    • getGenerated

      public File getGenerated()

    • getPluginContext

      Map getPluginContext()

    • configure

      default EngineAutoConfiguration configure() throws org.apache.maven.artifact.DependencyResolutionRequiredException
      Throws:
      org.apache.maven.artifact.DependencyResolutionRequiredException