ns-scripting-core/net.democritus.scripting.npm/NpmScope

NpmScope

interface NpmScope : ScriptScope(source)

This scoping object is created by the ScriptScope.npm function. Its purpose is providing access to functionality such as execution functions that can run NPM scripts.

Properties

ctx

abstract val ctx: ScopeContext

This field contains the context object that is applicable to the scope that defines the execution. The object is inherited directly from the parent net.democritus.scripting.scope.ScriptScope without alterations.

Functions

conditional

fun ScriptScope.conditional(condition: ScopeActivationCondition = always, body: ConditionalScope.() -> Unit)

A scoping function to execute a code block conditionally based on the declarative condition argument.

dir

fun ScriptScope.dir(dirPath: Path, body: DirScope.() -> Unit)

fun ScriptScope.dir(dirPath: String, body: DirScope.() -> Unit)

A scoping function to execute a code block within the context of a DirScope instance, which adapts the path in the scope context at ScopeContext.path to the given value of dirPath. The value of dirPath is automatically resolved if it is a relative path.

exec

fun ScriptScope.exec(body: ExecExecutionTemplate.() -> Unit)

This execution function is used to run a process on the machine. The body parameter is supplied as a higher-order function that executes within the scope of a ExecExecutionTemplate object, in which the arguments for the process can be declared.

git

fun ScriptScope.git(condition: ScopeActivationCondition = always, body: GitScope.() -> Unit)

A scoping function to execute a code block within the context of an GitScope instance, which provides functionality to interact with Git source repositories.

install

fun NpmScope.install(body: NpmInstallExecutionTemplate.() -> Unit)

This execution function is used to run an NPM install operation, which installs a package/project from a package.json file. The body parameter is supplied as a higher-order function that executes within the scope of an NpmInstallExecutionTemplate object, in which the parameters for the installation process can be declared.

mvn

fun ScriptScope.mvn(condition: ScopeActivationCondition = always, body: MavenExecutionTemplate.() -> Unit)

This execution function is used to run Maven. The body parameter is supplied as a higher-order function that executes within the scope of a MavenExecutionTemplate object, in which the parameters for Maven can be declared.

npm

fun ScriptScope.npm(condition: ScopeActivationCondition = always, body: NpmScope.() -> Unit)

A scoping function to execute a code block within the context of an NpmScope instance, which provides functionality to execute NPM commands.

fun ScriptScope.ns(condition: ScopeActivationCondition = always, body: NSScope.() -> Unit)

A scoping function to execute a code block within the context of an NSScope instance, which provides utility functions specific to NSX tooling.

run

fun NpmScope.run(body: NpmRunExecutionTemplate.() -> Unit)

This execution function is used to run an NPM run operation, which runs a script as defined in a package.json file. The body parameter is supplied as a higher-order function that executes within the scope of an NpmRunExecutionTemplate object, in which the parameters for the script execution can be declared.