AbstractBaseNpmPackageJsonInstall (nodejs-gradle-plugin 5.0.0-alpha.3 API)

org.ysb33r.gradle.nodejs.tasks.AbstractBaseNpmPackageJsonInstall

@groovy.transform.CompileStatic
@SuppressWarnings(value: AbstractClassWithoutAbstractMethod)
abstract class AbstractBaseNpmPackageJsonInstall<T extends BaseNodeJSExtension<T>, S extends BaseNpmExtension<T, S>>
extends GenericNodeBaseTask<T, S>

Installs the packages as described by a package.json file

Since:: 2.1

Properties Summary

Properties
Type	Name and description
`Iterable<String>`	`additionalInstallArgs`
`boolean`	`productionOnly` Set to `true` if only production dependencies should be installed.

Constructor Summary

Constructors
Constructor and description
`protected AbstractBaseNpmPackageJsonInstall ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`additionalInstallArgs(String[] args)` Adds more installation arguments
	`void`	`additionalInstallArgs(Iterable<String> args)` Adds more installation arguments
	`protected NpmPackageInstaller`	`createPackageInstaller()` Creates an actual installer.
	`void`	`exec()`
	`Iterable<String>`	`getAdditionalInstallArgs()` Customise installation via additional argument that are passed to `npm install`.
	`abstract Provider<File>`	`getHomeDirProvider()` THe NPM home directory.
	`protected abstract NpmPackageInstaller`	`getNpmPackageInstaller()` Returns the NPM packer installer instance.
	`File`	`getPackageJsonFile()` The package.json file that this task will query.
	`Provider<File>`	`getPackageJsonFileProvider()` The package.json file that this task will query.
	`File`	`getPackageLockFile()` The executable-lock.json file that this task will create.
	`Provider<File>`	`getPackageLockFileProvider()` The executable-lock.json file that this task will create.
	`void`	`setAdditionalInstallArgs(Iterable<String> args)` Replace list of arguments with a new list.

- Property Detail
  - Iterable<String> additionalInstallArgs
  - @Internal boolean productionOnly
    
    Set to true if only production dependencies should be installed.
    Since:
    0.9.0
- Constructor Detail
  - protected AbstractBaseNpmPackageJsonInstall()
- Method Detail
  - void additionalInstallArgs(String[] args)
    
    Adds more installation arguments
    sa:
    https://docs.npmjs.com/cli/install
    
    Parameters:
    args - One or more arguments
  - void additionalInstallArgs(Iterable<String> args)
    
    Adds more installation arguments
    sa:
    https://docs.npmjs.com/cli/install
    
    Parameters:
    args - Iterable list of arguments
  - protected NpmPackageInstaller createPackageInstaller()
    
    Creates an actual installer. The default method relies on getPackageJsonFileProvider not returning null.
    Returns:
    An installer.
    Since:
    4.0
  - @TaskAction void exec()
  - @Input Iterable<String> getAdditionalInstallArgs()
    
    Customise installation via additional argument that are passed to npm install.
    sa:
    https://docs.npmjs.com/cli/install
    
    Returns:
    List of additional arguments.
  - @Internal abstract Provider<File> getHomeDirProvider()
    
    THe NPM home directory.
    Returns:
    A provider to the home directory.
    Since:
    4.0
  - @Internal protected abstract NpmPackageInstaller getNpmPackageInstaller()
    
    Returns the NPM packer installer instance.
    This method is called from task actionsand thus should be configuration cache safe.
    
    Returns:
    Package installer.
    Since:
    4.0
  - @Internal File getPackageJsonFile()
    
    The package.json file that this task will query.
    Returns:
    File object.
  - @PathSensitive(value: RELATIVE) @InputFile Provider<File> getPackageJsonFileProvider()
    
    The package.json file that this task will query.
    Returns:
    File provider object.
    Since:
    0.8.0
  - @Internal File getPackageLockFile()
    
    The executable-lock.json file that this task will create.
    Returns:
    File object.
  - @OutputFile Provider<File> getPackageLockFileProvider()
    
    The executable-lock.json file that this task will create.
    Returns:
    File object.
    Since:
    0.8.0
  - void setAdditionalInstallArgs(Iterable<String> args)
    
    Replace list of arguments with a new list.
    sa:
    https://docs.npmjs.com/cli/install
    
    Parameters:
    args - new arguments to use.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractBaseNpmPackageJsonInstall<T extends BaseNodeJSExtension<T>, S extends BaseNpmExtension<T, S>>

Properties Summary

Constructor Summary

Methods Summary

Property Detail

Iterable<String> additionalInstallArgs

@Internal boolean productionOnly

Constructor Detail

protected AbstractBaseNpmPackageJsonInstall()

Method Detail

void additionalInstallArgs(String[] args)

void additionalInstallArgs(Iterable<String> args)

protected NpmPackageInstaller createPackageInstaller()

@TaskAction void exec()

@Input Iterable<String> getAdditionalInstallArgs()

@Internal abstract Provider<File> getHomeDirProvider()

@Internal protected abstract NpmPackageInstaller getNpmPackageInstaller()

@Internal File getPackageJsonFile()

@PathSensitive(value: RELATIVE) @InputFile Provider<File> getPackageJsonFileProvider()

@Internal File getPackageLockFile()

@OutputFile Provider<File> getPackageLockFileProvider()

void setAdditionalInstallArgs(Iterable<String> args)