com.vaadin.flow.plugin.common

Class FrontendToolsManager

java.lang.Object

com.vaadin.flow.plugin.common.FrontendToolsManager

public class FrontendToolsManager
extends Object

Entity to operate frontend tools to transpile files.

Transpilation is based on gulp and polymer-build.

Polymer tools are used since they are the only ones capable of bundling html files along with css and js ones and providing helper method for processing web components.

Apart from gulp and polymer-build, yarn and node are used to get and launch the tools required.

Since:

1.0.

Author:

Vaadin Ltd

Constructor Summary

Constructors

Constructor and Description
FrontendToolsManager(File workingDirectory, String es5OutputDirectoryName, String es6OutputDirectoryName, FrontendDataProvider frontendDataProvider, RunnerManager runnerManager) Prepares the manager.

Method Summary

Modifier and Type	Method and Description
void	installFrontendTools(int networkConcurrency) Installs tools required for transpilation.
Map<String,File>	transpileFiles(File es6SourceDirectory, File outputDirectory, boolean skipEs5) Transpiles files in the directory provided, copying them to the working directory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FrontendToolsManager

public FrontendToolsManager(File workingDirectory,
                            String es5OutputDirectoryName,
                            String es6OutputDirectoryName,
                            FrontendDataProvider frontendDataProvider,
                            RunnerManager runnerManager)

Prepares the manager.

Parameters:

workingDirectory - the directory to install and process files in, not null

es5OutputDirectoryName - the name for the directory to put transpiled ES5 files into, not null

es6OutputDirectoryName - the name for the directory to put minified ES6 files into, not null

frontendDataProvider - the source of the files required by the FrontendToolsManager, not null

runnerManager - node, gulp and yarn runner

Method Detail

installFrontendTools

public void installFrontendTools(int networkConcurrency)

Installs tools required for transpilation. Tools installed are specified in the package.json file in the plugin project's resources directory. Additionally, copies numerous files required for transpilation into the working directory.

Parameters:

networkConcurrency - maximum number of concurrent network requests

Throws:

IllegalStateException - if dependency installation fails

UncheckedIOException - if supplementary file creation fails

transpileFiles

public Map<String,File> transpileFiles(File es6SourceDirectory,
                                       File outputDirectory,
                                       boolean skipEs5)

Transpiles files in the directory provided, copying them to the working directory. Creates a new output directory, in working directory, with two separate directories for ES5 (transpiled) and ES6 (optimized) files. Additionally, creates supplementary files, used by transpilation process.

Parameters:

es6SourceDirectory - the directory to get ES6 files from, not null

outputDirectory - the directory to put transpiled files into, created if absent

skipEs5 - whether to skip the transpilation step or not

Returns:

generated output directory path

Throws:

IllegalStateException - if transpilation fails

IllegalArgumentException - if es6SourceDirectory is not a directory or does not exist

UncheckedIOException - if output directory creation fails or other IOException occurs