Package com.brunoritz.gradle.singularnode.npm

Class InstallNpmPackagesTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.brunoritz.gradle.singularnode.npm.InstallNpmPackagesTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
public abstract class InstallNpmPackagesTask extends org.gradle.api.DefaultTask
Installs packages declared in the package.json file.

  • Nested Class Summary

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

    org.gradle.api.Named.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
    InstallNpmPackagesTask(org.gradle.process.ExecOperations processes, org.gradle.api.Project project)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.ListProperty<CharSequence>
    getArgs()
    Optional arguments to pass to the package installation command.
    File
    getExecutionMarkerFile()
    The execution marker file indicates that this task was executed.
    abstract org.gradle.api.provider.Property<InstallationLayout>
    getInstallationLayout()
     
    @Nullable File
    getPackageFile()
     
    @Nullable File
    getPackageLockFile()
     
    abstract org.gradle.api.file.DirectoryProperty
    getWorkingDirectory()
     
    void
    installPackages()
     

    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, 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, notCompatibleWithConfigurationCache

  • Constructor Details

    • InstallNpmPackagesTask

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

  • Method Details

    • getArgs

      @Input @Optional public abstract org.gradle.api.provider.ListProperty<CharSequence> getArgs()
      Optional arguments to pass to the package installation command. By default, no arguments are defined.

    • 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()

    • getExecutionMarkerFile

      @OutputFile public File getExecutionMarkerFile()
      The execution marker file indicates that this task was executed. It is a compromise between reliability and speed. Declaring node_modules an output directory would add a tremendous hashing overhead for Gradle.

      Manual changes to node_modules or changes introduced by a build cannot be detected with this approach.

    • installPackages

      public void installPackages() throws IOException
      Throws:
      IOException