dev.jeka.plugins.nodejs

Class JkNodeJs

java.lang.Object

dev.jeka.plugins.nodejs.JkNodeJs

public class JkNodeJs
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NODE_VERSION

Method Summary

Modifier and Type	Method and Description
JkNodeJs	configure(dev.jeka.core.api.project.JkProject project, java.lang.String clientBaseDir, java.lang.String clientBuildDir, java.lang.String... buildCommands) Configures the specified project to include a nodeJs build right after main compilation.
JkNodeJs	exec(java.lang.String commandLine) Executes the specified 'npm or npx' command line.
java.lang.String	getVersion()
java.nio.file.Path	getWorkingDir()
JkNodeJs	npm(java.lang.String commandLine) Executes the specified npm command line.
JkNodeJs	npx(java.lang.String commandLine) Executes the specified npx command line.
static JkNodeJs	of(java.nio.file.Path nodeJsInstallDir) Creates a JkNodeJs wrapping on a nodeJs distribution located in the specified install dir.
static JkNodeJs	ofDefaultVersion() Creates a JkNodeJs wrapping the default version.
static JkNodeJs	ofVersion(java.lang.String version) Creates a JkNodeJs wrapping the specified version.
JkNodeJs	setWorkingDir(java.nio.file.Path workingDir) Sets the working directory from where npm(String) and npx(String) should be run.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NODE_VERSION

public static final java.lang.String DEFAULT_NODE_VERSION

See Also:

Constant Field Values

Method Detail

of

public static JkNodeJs of(java.nio.file.Path nodeJsInstallDir)

Creates a JkNodeJs wrapping on a nodeJs distribution located in the specified install dir.

Parameters:

nodeJsInstallDir - Path to nodeJs installation directory

ofVersion

public static JkNodeJs ofVersion(java.lang.String version)

Creates a JkNodeJs wrapping the specified version.

Jeka caches nodeJs distribution in a specific directory. If the specified version is not present in cache, it is downloaded automatically.

Parameters:

version - Version of nodeJs to use.

ofDefaultVersion

public static JkNodeJs ofDefaultVersion()

Creates a JkNodeJs wrapping the default version.

See Also:

ofVersion(String)

setWorkingDir

public JkNodeJs setWorkingDir(java.nio.file.Path workingDir)

Sets the working directory from where npm(String) and npx(String) should be run.

getWorkingDir

public java.nio.file.Path getWorkingDir()

getVersion

public java.lang.String getVersion()

npm

public JkNodeJs npm(java.lang.String commandLine)

Executes the specified npm command line.

Parameters:

commandLine - Command line to be executed by npm. The 'npm' command should not be included in the command line.

npx

public JkNodeJs npx(java.lang.String commandLine)

Executes the specified npx command line.

Parameters:

commandLine - Command line to be executed by npx. The 'npx' command should not be included in the command line.

exec

public JkNodeJs exec(java.lang.String commandLine)

Executes the specified 'npm or npx' command line. The command line must include the 'npm' pr 'npx' command'.

Parameters:

commandLine - mMst start with either 'npm' nor 'npx'.

configure

public JkNodeJs configure(dev.jeka.core.api.project.JkProject project,
                          java.lang.String clientBaseDir,
                          java.lang.String clientBuildDir,
                          java.lang.String... buildCommands)

Configures the specified project to include a nodeJs build right after main compilation.

Parameters:

project - The project to configure

clientBaseDir - The path, relative to project base dir, of the nodeJs subproject.

clientBuildDir - The path, relative to @clientBuildDir, of the directory containing the build result.

buildCommands - The commands (npm o npx) to execute to build the nodeJs project.