-
- All Implemented Interfaces:
-
kotlin.Comparable
,org.gradle.api.Task
,org.gradle.api.internal.DynamicObjectAware
,org.gradle.api.internal.TaskInternal
,org.gradle.api.plugins.ExtensionAware
,org.gradle.util.Configurable
public abstract class NodeTask extends BaseTask
Gradle task for running a Node.js script
-
-
Field Summary
Fields Modifier and Type Field Description private final ObjectFactory
objects
private final ProviderFactory
providers
private final RegularFileProperty
script
private final ListProperty<String>
options
private final ListProperty<String>
args
private final Property<Boolean>
ignoreExitValue
private final DirectoryProperty
workingDir
private final MapProperty<String, String>
environment
private final Property<Action<ExecSpec>>
execOverrides
private final DefaultProjectApiHelper
projectHelper
private final NodeExtension
extension
private ExecResult
result
private Boolean
enabled
private final Property<Duration>
timeout
private final TaskStateInternal
state
private Boolean
impliesSubProjects
private final Boolean
hasCustomActions
private final Set<Provider<out BuildService<?>>>
requiredServices
-
Constructor Summary
Constructors Constructor Description NodeTask()
-
Method Summary
Modifier and Type Method Description abstract ObjectFactory
getObjects()
abstract ProviderFactory
getProviders()
final RegularFileProperty
getScript()
Node.js script to run. final ListProperty<String>
getOptions()
Arguments to be passed to Node. final ListProperty<String>
getArgs()
Additional arguments for the script being run. final Property<Boolean>
getIgnoreExitValue()
If enabled prevents the task from failing if the exit code is not 0. final DirectoryProperty
getWorkingDir()
Sets the working directory. final MapProperty<String, String>
getEnvironment()
Add additional environment variables or override environment variables inherited from the system. final Property<Action<ExecSpec>>
getExecOverrides()
final DefaultProjectApiHelper
getProjectHelper()
final NodeExtension
getExtension()
Overrides for ExecSpec final Unit
execOverrides(Action<ExecSpec> execOverrides)
final Unit
exec()
-
Methods inherited from class com.github.gradle.node.task.BaseTask
getResult, setResult
-
Methods inherited from class org.gradle.api.internal.AbstractTask
appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects
-
Methods inherited from class org.gradle.api.DefaultTask
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getObjects
@Inject() abstract ObjectFactory getObjects()
-
getProviders
@Inject() abstract ProviderFactory getProviders()
-
getScript
@InputFile()@PathSensitive(value = PathSensitivity.RELATIVE) final RegularFileProperty getScript()
Node.js script to run.
-
getOptions
@Input() final ListProperty<String> getOptions()
Arguments to be passed to Node.js
-
getArgs
@Input() final ListProperty<String> getArgs()
Additional arguments for the script being run.
-
getIgnoreExitValue
@Input() final Property<Boolean> getIgnoreExitValue()
If enabled prevents the task from failing if the exit code is not 0. Defaults to false.
-
getWorkingDir
@Internal() final DirectoryProperty getWorkingDir()
Sets the working directory.
-
getEnvironment
@Input() final MapProperty<String, String> getEnvironment()
Add additional environment variables or override environment variables inherited from the system.
-
getExecOverrides
@Internal() final Property<Action<ExecSpec>> getExecOverrides()
-
getProjectHelper
@Internal() final DefaultProjectApiHelper getProjectHelper()
-
getExtension
@Internal() final NodeExtension getExtension()
Overrides for ExecSpec
-
execOverrides
final Unit execOverrides(Action<ExecSpec> execOverrides)
-
-
-
-