ns-scripting-core/net.democritus.scripting/NSScript

NSScript

abstract class NSScript(val ctx: ScopeContext) : ScriptScope(source)

The base class which is extended by the script engine to execute an NSScript in. This class is also the root ScriptScope and provides the ScopeContext object where ScopeContext.path is the current directory from where the script was executed.

Constructors

NSScript

constructor(ctx: ScopeContext)

Properties

ctx

open override val ctx: ScopeContext

The context data for the scope.

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.

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.