Package com.vaadin.flow.server.frontend
Class NodeUpdater
- java.lang.Object
-
- com.vaadin.flow.server.frontend.NodeUpdater
-
- All Implemented Interfaces:
FallibleCommand
- Direct Known Subclasses:
TaskGeneratePackageJson
,TaskUpdateImports
,TaskUpdatePackages
public abstract class NodeUpdater extends Object implements FallibleCommand
Base abstract class for frontend updaters that needs to be run when in dev-mode or from the flow maven plugin.For internal use only. May be renamed or removed in a future release.
- Since:
- 2.0
-
-
Field Summary
Fields Modifier and Type Field Description protected String
buildDir
protected static String
DEP_NAME_FLOW_DEPS
Deprecated.protected static String
DEP_NAME_FLOW_JARS
Deprecated.protected FrontendDependenciesScanner
frontDeps
TheFrontendDependencies
object representing the application dependencies.static String
GENERATED_PREFIX
Relative paths of generated should be prefixed with this value, so they can be correctly separated from {projectDir}/frontend files.protected File
generatedFolder
Base directory for flow generated files.protected File
nodeModulesFolder
The path to theFrontendUtils.NODE_MODULES
directory.protected File
npmFolder
Base directory forConstants.PACKAGE_JSON
,FrontendUtils.WEBPACK_CONFIG
,FrontendUtils.NODE_MODULES
.
-
Constructor Summary
Constructors Modifier Constructor Description protected
NodeUpdater(ClassFinder finder, FrontendDependenciesScanner frontendDependencies, File npmFolder, File generatedPath, String buildDir, FeatureFlags featureFlags)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected String
generateVersionsJson(elemental.json.JsonObject packageJson)
Generate versions json file for version locking.protected File
getPackageJsonFile()
protected File
getPackageLockFile()
-
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.server.frontend.FallibleCommand
execute
-
-
-
-
Field Detail
-
GENERATED_PREFIX
public static final String GENERATED_PREFIX
Relative paths of generated should be prefixed with this value, so they can be correctly separated from {projectDir}/frontend files.- See Also:
- Constant Field Values
-
DEP_NAME_FLOW_DEPS
@Deprecated protected static final String DEP_NAME_FLOW_DEPS
Deprecated.- See Also:
- Constant Field Values
-
DEP_NAME_FLOW_JARS
@Deprecated protected static final String DEP_NAME_FLOW_JARS
Deprecated.- See Also:
- Constant Field Values
-
npmFolder
protected final File npmFolder
Base directory forConstants.PACKAGE_JSON
,FrontendUtils.WEBPACK_CONFIG
,FrontendUtils.NODE_MODULES
.
-
nodeModulesFolder
protected final File nodeModulesFolder
The path to theFrontendUtils.NODE_MODULES
directory.
-
generatedFolder
protected final File generatedFolder
Base directory for flow generated files.
-
frontDeps
protected final FrontendDependenciesScanner frontDeps
TheFrontendDependencies
object representing the application dependencies.
-
buildDir
protected String buildDir
-
-
Constructor Detail
-
NodeUpdater
protected NodeUpdater(ClassFinder finder, FrontendDependenciesScanner frontendDependencies, File npmFolder, File generatedPath, String buildDir, FeatureFlags featureFlags)
Constructor.- Parameters:
finder
- a reusable class finderfrontendDependencies
- a reusable frontend dependenciesnpmFolder
- folder with the `package.json` filegeneratedPath
- folder where flow generated files will be placed.buildDir
- the used build directoryfeatureFlags
- FeatureFlags for this build
-
-
Method Detail
-
getPackageJsonFile
protected File getPackageJsonFile()
-
getPackageLockFile
protected File getPackageLockFile()
-
generateVersionsJson
protected String generateVersionsJson(elemental.json.JsonObject packageJson) throws IOException
Generate versions json file for version locking.- Returns:
- generated versions json file path
- Throws:
IOException
- when file IO fails
-
-