Package com.brunoritz.gradle.singularnode.npm

Class NpmTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.brunoritz.gradle.singularnode.npm.NpmTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
public abstract class NpmTask extends org.gradle.api.DefaultTask
The task type for defining custon NPM tasks to execute. Any task that uses this class as its type will automatically depend on the package installation task to enusure up-to-date packages. Example Usage 
 // package.json
 {
     "scripts": {
         "test": "node -e 'console.log(process.env)'"
     }
 }

 // build.gradle
 task runTest(type: NpmTask) {
     args.set([
         'run', 'test'
     ])
 }

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Task

    org.gradle.api.Task.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    NpmTask(org.gradle.process.ExecOperations processes, org.gradle.api.Project project)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute()
     
    abstract org.gradle.api.provider.ListProperty<CharSequence>
    getArgs()
     
    abstract org.gradle.api.provider.MapProperty<CharSequence,CharSequence>
    getEnvironment()
     
    abstract org.gradle.api.provider.Property<InstallationLayout>
    getInstallationLayout()
     
    abstract org.gradle.api.file.DirectoryProperty
    getInstallBaseDir()
     
    @Nullable File
    getPackageFile()
     
    @Nullable File
    getPackageLockFile()
     
    abstract org.gradle.api.file.DirectoryProperty
    getWorkingDirectory()
     

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, 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 org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, getConvention, notCompatibleWithConfigurationCache

  • Constructor Details

    • NpmTask

      @Inject public NpmTask(org.gradle.process.ExecOperations processes, org.gradle.api.Project project)

  • Method Details

    • getArgs

      @Input @Optional public abstract org.gradle.api.provider.ListProperty<CharSequence> getArgs()

    • getEnvironment

      @Input @Optional public abstract org.gradle.api.provider.MapProperty<CharSequence,CharSequence> getEnvironment()

    • getInstallBaseDir

      @Internal public abstract org.gradle.api.file.DirectoryProperty getInstallBaseDir()

    • getWorkingDirectory

      @Internal public abstract org.gradle.api.file.DirectoryProperty getWorkingDirectory()

    • getInstallationLayout

      @Internal public abstract org.gradle.api.provider.Property<InstallationLayout> getInstallationLayout()

    • getPackageFile

      @InputFile @PathSensitive(RELATIVE) @Optional public @Nullable File getPackageFile()

    • getPackageLockFile

      @InputFile @PathSensitive(RELATIVE) @Optional public @Nullable File getPackageLockFile()

    • execute

      public void execute()