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

org.ysb33r.gradle.nodejs.NodeJSExtension

All Implemented Interfaces and Traits:: NodeJSExtensionMethods, org.ysb33r.grolifant5.api.core.runnable.ProvisionedExecMethods<NodeJSExecSpec>

@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
class NodeJSExtension
extends BaseNodeJSExtension<NodeJSExtension>
implements NodeJSExtensionMethods, org.ysb33r.grolifant5.api.core.runnable.ProvisionedExecMethods<NodeJSExecSpec>

Configure project defaults or task specifics for Node.js.

Since:: 0.1

Field Summary

Fields
Modifiers	Name	Description
`static String`	`NAME`

Properties Summary

Properties
Type	Name and description
`Provider<Boolean>`	`provideResolveNodeByVersion` A provider to whether the node executable is resolved by version.
`Provider<Boolean>`	`provideSyncNodeVersionFromNvmRc` A provider to whether the node version is synchronized form `.nvmrc`.

Constructor Summary

Constructors
Constructor and description
`NodeJSExtension (Project project)` Constructs a new extension which is attached to the provided project.
`NodeJSExtension (Task task)` Constructs a new extension which is attached to the provided task.
`protected NodeJSExtension (Task task, NodeJSExtension altProjectExt)` Constructs a new extension which is attached to the provided task.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`NodeJSExecSpec`	`createExecSpec()` Create execution specification.
	`void`	`executableByNvmRc(Provider<File> nvmrc)` Read the version from `.nvmrc`.
	`void`	`executableByNvmrc()` Read the version from `.nvmrc`.
	`void`	`executableByPath(Object path)` Locate an executable by a local path.
	`void`	`executableBySearchPath(Object baseName)` Locate executable by searching the current environmental search path.
	`void`	`executableByVersion(Object version)` Locate an executable by version, probably downloading it if not local.
	`Provider<File>`	`getNvmrcLocation()` `.nvmrc` location.
	`boolean`	`isResolveNodeByVersion()` Indicates whether resolving `node` is by version.
	`boolean`	`isSyncNodeVersionFromNvmRc()` Indicates whether the Node version is being synchronised from `.nvmrc`.

- Field Detail
  - public static final String NAME
- Property Detail
  - final Provider<Boolean> provideResolveNodeByVersion
    
    A provider to whether the node executable is resolved by version.
    Since:
    4.0
  - final Provider<Boolean> provideSyncNodeVersionFromNvmRc
    
    A provider to whether the node version is synchronized form .nvmrc.
    Since:
    4.0
- Constructor Detail
  - NodeJSExtension(Project project)
    
    Constructs a new extension which is attached to the provided project.
    Parameters:
    project - Project this extension is associated with.
  - NodeJSExtension(Task task)
    
    Constructs a new extension which is attached to the provided task.
    Parameters:
    project - Project this extension is associated with.
  - protected NodeJSExtension(Task task, NodeJSExtension altProjectExt)
    
    Constructs a new extension which is attached to the provided task.
    Parameters:
    project - Project this extension is associated with.
    altProjectExt - Alternative extension which implements NodeJSExtension.
- Method Detail
  - @Override NodeJSExecSpec createExecSpec()
    
    Create execution specification.
    Returns:
    Execution specification.
    Since:
    0.10
  - @SuppressWarnings(value: CatchArrayIndexOutOfBoundsException) void executableByNvmRc(Provider<File> nvmrc)
    
    Read the version from .nvmrc. Only supports fixed versions, not open versions like node or lts/*.
    Parameters:
    nvmrc - Provider to the location of .nvmrc
    Since:
    0.11
  - @SuppressWarnings(value: DuplicateStringLiteral) void executableByNvmrc()
    
    Read the version from .nvmrc. Only supports fixed versions, not open versions like node or lts/*. Assumes .nvmrc is at the npm homedirectory
    Since:
    0.11
  - @Override void executableByPath(Object path)
    
    Locate an executable by a local path.
    Parameters:
    path - Something resolvable to a File.
  - @Override void executableBySearchPath(Object baseName)
    
    Locate executable by searching the current environmental search path.
    Parameters:
    baseName - The base name of the executable
  - @Override void executableByVersion(Object version)
    
    Locate an executable by version, probably downloading it if not local.
    Parameters:
    version - Something resolvable to a string.
  - Provider<File> getNvmrcLocation()
    
    .nvmrc location.
    Returns:
    Location of .nvmrc. Can be a null provider.
    Since:
    2.0
  - boolean isResolveNodeByVersion()
    
    Indicates whether resolving node is by version.
    Returns:
    true if the version has been set.
  - boolean isSyncNodeVersionFromNvmRc()
    
    Indicates whether the Node version is being synchronised from .nvmrc.
    Returns:
    true us linkage has been established.

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class NodeJSExtension

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Field Detail

public static final String NAME

Property Detail

final Provider<Boolean> provideResolveNodeByVersion

final Provider<Boolean> provideSyncNodeVersionFromNvmRc

Constructor Detail

NodeJSExtension(Project project)

NodeJSExtension(Task task)

protected NodeJSExtension(Task task, NodeJSExtension altProjectExt)

Method Detail

@Override NodeJSExecSpec createExecSpec()

@SuppressWarnings(value: CatchArrayIndexOutOfBoundsException) void executableByNvmRc(Provider<File> nvmrc)

@SuppressWarnings(value: DuplicateStringLiteral) void executableByNvmrc()

@Override void executableByPath(Object path)

@Override void executableBySearchPath(Object baseName)

@Override void executableByVersion(Object version)

Provider<File> getNvmrcLocation()

boolean isResolveNodeByVersion()

boolean isSyncNodeVersionFromNvmRc()