AbstractCmdlineTask (nodejs-gradle-plugin 4.0.4 API)

org.ysb33r.gradle.nodejs.tasks.AbstractCmdlineTask

@groovy.transform.CompileStatic
class AbstractCmdlineTask
extends org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask

A base class for creating command-line tasks.

Authors:: Schalk W. Cronjé

Inherited fields
Fields inherited from class	Fields
`class org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask`	`__$stMC, TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`boolean`	`canBeUpToDate` By default, this task is never up to date.

Constructor Summary

Constructors
Constructor and description
`protected AbstractCmdlineTask ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`addArgs(Object[] args)` Allows the derived task to push additional arguments that will usually precede any arguments derived from command-line.
	`void`	`exec()`
	`java.util.List<String>`	`getFinalArgs()`
	`protected NodeJSExtension`	`getNodejs()`
	`protected NpmExtension`	`getNpm()`
	`void`	`setArgs(java.util.List<Object> args)`
	`void`	`setArgsLine(String args)`
	`void`	`setCommandProvider(Object cmdProvider)`
	`void`	`setConsoleOutput(String flag)` Ability to turn output on or off.
	`void`	`setEnvironmentProvider(Provider<java.util.Map<String, String>> env)`
	`void`	`setWorkingDir(Object dir)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask`	org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#stringTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#fsOperations(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#providerTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#jvmTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#execTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#projectTools(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getMetaClass(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setMetaClass(groovy.lang.MetaClass), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getName(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#compareTo(org.gradle.api.Task), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#compareTo(java.lang.Object), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setProperty(java.lang.String, java.lang.Object), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLogger(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#property(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getPath(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getExtensions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#configure(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#configure(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setDescription(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setActions(java.util.List), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setDependsOn(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#dependsOn([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#onlyIf(java.lang.String, org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#onlyIf(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#onlyIf(org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setOnlyIf(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setOnlyIf(org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setOnlyIf(java.lang.String, org.gradle.api.specs.Spec), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setDidWork(boolean), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDidWork(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getGroup(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setGroup(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getProject(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getAnt(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLogging(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doFirst(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doFirst(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doFirst(java.lang.String, org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doLast(groovy.lang.Closure), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doLast(java.lang.String, org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doLast(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getEnabled(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getOutputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getOutputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDestroyables(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLocalState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTemporaryDir(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#mustRunAfter([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setMustRunAfter(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getMustRunAfter(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#finalizedBy([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setFinalizedBy(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getFinalizedBy(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#shouldRunAfter([Ljava.lang.Object;), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setShouldRunAfter(java.lang.Iterable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getShouldRunAfter(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTimeout(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#usesService(org.gradle.api.provider.Provider), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDependsOn(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getDescription(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setEnabled(boolean), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#hasProperty(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getInputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getInputs(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#isEnabled(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getAsDynamicObject(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getConvention(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#doNotTrackState(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#notCompatibleWithConfigurationCache(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getIdentityPath(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getSharedResources(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getStandardOutputCapture(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLifecycleDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getLifecycleDependencies(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#acceptServiceReferences(java.util.Set), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskIdentity(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTaskActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#hasTaskActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getOnlyIf(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getReasonNotToTrackState(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#isCompatibleWithConfigurationCache(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getReasonTaskIsIncompatibleWithConfigurationCache(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getImpliesSubProjects(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#setImpliesSubProjects(boolean), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getTemporaryDirFactory(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#prependParallelSafeAction(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#appendParallelSafeAction(org.gradle.api.Action), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#isHasCustomActions(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getRequiredServices(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#equals(java.lang.Object), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#toString(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#hashCode(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getClass(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#notify(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#notifyAll(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#wait(long), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#wait(long, int), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#wait(), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#getProperty(java.lang.String), org.ysb33r.grolifant5.api.core.runnable.GrolifantDefaultTask#invokeMethod(java.lang.String, java.lang.Object)

- Property Detail
  - @Internal boolean canBeUpToDate
    
    By default, this task is never up to date. Setting this value to true gives it the option to be up to date.
- Constructor Detail
  - protected AbstractCmdlineTask()
- Method Detail
  - protected void addArgs(Object[] args)
    
    Allows the derived task to push additional arguments that will usually precede any arguments derived from command-line.
    Parameters:
    args - One or more args.
  - @TaskAction void exec()
  - @Input java.util.List<String> getFinalArgs()
  - @Internal protected NodeJSExtension getNodejs()
  - @Internal protected NpmExtension getNpm()
  - @Option(option: arg, description: Command-line option (Can be repeated)) void setArgs(java.util.List<Object> args)
  - @Option(option: args, description: Command-line options (space separated). Applied before single arguments.) void setArgsLine(String args)
  - void setCommandProvider(Object cmdProvider)
  - @Option(option: output, description: Turn output on or off) void setConsoleOutput(String flag)
    
    Ability to turn output on or off.
    By default output is displayed when logging level is INFO. Error output is always displayed if there is an error.
    
    Parameters:
    flag - true to turn output on, or false to turn it off.
    Since:
    4.0
  - void setEnvironmentProvider(Provider<java.util.Map<String, String>> env)
  - void setWorkingDir(Object dir)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractCmdlineTask

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

@Internal boolean canBeUpToDate

Constructor Detail

protected AbstractCmdlineTask()

Method Detail

protected void addArgs(Object[] args)

@TaskAction void exec()

@Input java.util.List<String> getFinalArgs()

@Internal protected NodeJSExtension getNodejs()

@Internal protected NpmExtension getNpm()

@Option(option: arg, description: Command-line option (Can be repeated)) void setArgs(java.util.List<Object> args)

@Option(option: args, description: Command-line options (space separated). Applied before single arguments.) void setArgsLine(String args)

void setCommandProvider(Object cmdProvider)

@Option(option: output, description: Turn output on or off) void setConsoleOutput(String flag)

void setEnvironmentProvider(Provider<java.util.Map<String, String>> env)

void setWorkingDir(Object dir)