dev.jeka.plugins.nodejs

Class JkNodeJsProject

java.lang.Object

dev.jeka.plugins.nodejs.JkNodeJsProject

public class JkNodeJsProject
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
JkNodeJsProject	build() Executes the build phase for the Node.js project using the specified build commands.
java.nio.file.Path	getBaseJsDir() Retrieves the base directory for the Node.js project.
java.util.List<java.lang.String>	getBuildCommands()
java.nio.file.Path	getBuildDir() Retrieves the build directory for the Node.js project.
JkNodeJs	getNodeJs()
java.util.function.Consumer<java.nio.file.Path>	getPackAction()
java.util.List<java.lang.String>	getTestCommands()
static JkNodeJsProject	of(JkNodeJs nodeJs, java.nio.file.Path baseJsDir, java.lang.String buildDir)
static JkNodeJsProject	of(JkNodeJs nodeJs, java.nio.file.Path baseJsDir, java.lang.String buildDir, java.util.List<java.lang.String> buildCommands)
JkNodeJsProject	pack() Executes the packaging phase for the Node.js project.
JkNodeJsProject	setBaseJsDir(java.nio.file.Path baseJsDir)
JkNodeJsProject	setBuildCommands(java.lang.String... buildCommands) Sets the build commands to be executed during the build phase of the Node.js project.
JkNodeJsProject	setBuildDir(java.lang.String buildDir)
JkNodeJsProject	setCopyToResourcesPackAction(dev.jeka.core.api.project.JkProject project, java.lang.String relPath) Sets an action to copy the build directory contents of the Node.js project to the specified relative path within the given JkProject's class output directory.
JkNodeJsProject	setPackAction(java.util.function.Consumer<java.nio.file.Path> packAction) Sets the packaging action for the Node.js project.
JkNodeJsProject	setTestCommands(java.lang.String... testCommands) Sets the test commands to be executed during the test phase of the Node.js project.
JkNodeJsProject	test() Executes the test phase for the Node.js project.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static JkNodeJsProject of(JkNodeJs nodeJs,
                                 java.nio.file.Path baseJsDir,
                                 java.lang.String buildDir,
                                 java.util.List<java.lang.String> buildCommands)

of

public static JkNodeJsProject of(JkNodeJs nodeJs,
                                 java.nio.file.Path baseJsDir,
                                 java.lang.String buildDir)

getNodeJs

public JkNodeJs getNodeJs()

getBuildCommands

public java.util.List<java.lang.String> getBuildCommands()

getTestCommands

public java.util.List<java.lang.String> getTestCommands()

getPackAction

public java.util.function.Consumer<java.nio.file.Path> getPackAction()

build

public JkNodeJsProject build()

Executes the build phase for the Node.js project using the specified build commands.

Throws:

dev.jeka.core.tool.JkException - if no build commands are defined or there is a misconfiguration.

test

public JkNodeJsProject test()

Executes the test phase for the Node.js project.

pack

public JkNodeJsProject pack()

Executes the packaging phase for the Node.js project. If a packaging action has been defined, it will be applied to the build directory of the project.

setBuildCommands

public JkNodeJsProject setBuildCommands(java.lang.String... buildCommands)

Sets the build commands to be executed during the build phase of the Node.js project. The provided commands will replace any previously set build commands.

setTestCommands

public JkNodeJsProject setTestCommands(java.lang.String... testCommands)

Sets the test commands to be executed during the test phase of the Node.js project. The provided commands will replace any previously set test commands.

setPackAction

public JkNodeJsProject setPackAction(java.util.function.Consumer<java.nio.file.Path> packAction)

Sets the packaging action for the Node.js project. This defines what happens during the packaging phase, working on the build directory of the project.

Parameters:

packAction - a Consumer that specifies the packaging logic for the build directory

setCopyToResourcesPackAction

public JkNodeJsProject setCopyToResourcesPackAction(dev.jeka.core.api.project.JkProject project,
                                                    java.lang.String relPath)

Sets an action to copy the build directory contents of the Node.js project to the specified relative path within the given JkProject's class output directory.

Parameters:

project - the JkProject instance whose class output directory is the target for the copy

relPath - the relative path within the class output directory where the build contents will be copied

Returns:

this JkNodeJsProject instance for further configurations

getBaseJsDir

public java.nio.file.Path getBaseJsDir()

Retrieves the base directory for the Node.js project.

setBaseJsDir

public JkNodeJsProject setBaseJsDir(java.nio.file.Path baseJsDir)

setBuildDir

public JkNodeJsProject setBuildDir(java.lang.String buildDir)

getBuildDir

public java.nio.file.Path getBuildDir()

Retrieves the build directory for the Node.js project.