A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

AbstractBaseNpmPackageJsonInstall - Class in org.ysb33r.gradle.nodejs.tasks

Installs the packages as described by a package.json file

AbstractBaseNpmPackageJsonInstall() - Constructor in AbstractBaseNpmPackageJsonInstall

AbstractCmdlineTask - Class in org.ysb33r.gradle.nodejs.tasks

A base class for creating command-line tasks.

AbstractCmdlineTask() - Constructor in AbstractCmdlineTask

AbstractNodeBaseTask - Class in org.ysb33r.gradle.nodejs.tasks

A base class that will provide NodeJS and NPM task extensions.

AbstractNodeBaseTask() - Constructor in AbstractNodeBaseTask

AbstractPackageWrappingExtension - Class in org.ysb33r.gradle.nodejs.pkgwrapper

A base class that can be used to wrap specific NPM packages as features in Gradle, thereby allowing for configuraton both a project or task level.

AbstractPackageWrappingExtension(org.gradle.api.Task, org.ysb33r.gradle.nodejs.pkgwrapper.AbstractPackageWrappingExtension, boolean) - Constructor in AbstractPackageWrappingExtension

Associate projExt with a task.

addArgs(java.lang.Object) - Method in AbstractCmdlineTask

Allows the derived task to push additional arguments that will usually precede any arguments derived from command-line.

addConfigurations(org.gradle.api.Project) - Method in NpmPlugin

additionalInstallArgs(Iterable<String>) - Method in AbstractBaseNpmPackageJsonInstall

Adds more installation arguments

addNpmPackageExtension(org.gradle.api.Project, org.ysb33r.gradle.nodejs.NodeJSExtension, org.ysb33r.gradle.nodejs.NpmExtension) - Method in NpmPlugin

AltDevPlugin - Class in org.ysb33r.gradle.nodejs.plugins

Conventions for building a project with Node and Gradle, but driving everything from Gradle.

AltDevPlugin() - Constructor in AltDevPlugin

appendPath(Provider<String>) - Method in BaseNodeJSExtension

Add search to system path.

appendPath(Provider<String>) - Method in NodeJSExtensionMethods

Add search to system path.

apply(org.gradle.api.Project) - Method in AltDevPlugin

apply(org.gradle.api.Project) - Method in CommandLinePlugin

apply(org.gradle.api.Project) - Method in DevBasePlugin

apply(org.gradle.api.Project) - Method in GulpBasePlugin

apply(org.gradle.api.Project) - Method in GulpPlugin

apply(org.gradle.api.Project) - Method in NodeJSBasePlugin

apply(org.gradle.api.Project) - Method in NpmDevPlugin

apply(org.gradle.api.Project) - Method in NpmPlugin

apply(org.gradle.api.Project) - Method in WrapperPlugin

ARCH - Field in Downloader

asMap() - Method in PackageJson

Returns all properties as map which will be suitable for writing out as JSON again.

associateCacheTask(TaskProvider<NodeBinariesCacheTask>) - Method in NodeWrappers

B

BadNvmRcException - Class in org.ysb33r.gradle.nodejs.errors

Thrown when reading .nvmrc does not yield a resolvable version.

BadNvmRcException() - Constructor in BadNvmRcException

BASE_URI - Field in Downloader

BaseNodeJSExtension - Class in org.ysb33r.gradle.nodejs

Base class for configuring project defaults or task specifics for Node.js.

BaseNodeJSExtension.1 - Class in org.ysb33r.gradle.nodejs

BaseNodeJSExtension.1() - Constructor in BaseNodeJSExtension.1

BaseNodeJSExtension(org.gradle.api.Task, Callable<T>) - Constructor in BaseNodeJSExtension

Constructs a new extension which is attached to the provided task.

BaseNpmExtension - Class in org.ysb33r.gradle.nodejs

Set up global config or task-based config for NPM.

BaseNpmExtension(org.gradle.api.Task, T, S) - Constructor in BaseNpmExtension

Adds the extension to a NpmTask task.

BaseNpmSelfResolvingDependency - Class in org.ysb33r.gradle.nodejs.dependencies.npm

An NPM dependency that can resolve itself.

BaseNpmSelfResolvingDependency(org.ysb33r.grolifant5.api.core.ProjectOperations, org.ysb33r.gradle.nodejs.NodeJSExtensionMethods, org.ysb33r.gradle.nodejs.NpmExtensionMethods, Map<String, Object>) - Constructor in BaseNpmSelfResolvingDependency

because(java.lang.String) - Method in BaseNpmSelfResolvingDependency

buildDependencies - Property in BaseNpmSelfResolvingDependency

C

CACHE_TASK_NAME - Field in WrapperPlugin

calculateInstallableFiles(java.io.File) - Method in NpmExecutor

Returns a live set of installable files.

call() - Method in BaseNodeJSExtension.1

canBeUpToDate - Property in AbstractCmdlineTask

By default, this task is never up to date.

CLEAN_TASK - Field in DevBasePlugin

CMD_EXE - Field in ExecHelpers

CMD_EXT - Field in ExecHelpers

CMD_START - Field in ExecHelpers

CommandLinePlugin - Class in org.ysb33r.gradle.nodejs.plugins

Provides command-line access to tools use the tool name as task followed by multiple --arg or single --args

CommandLinePlugin() - Constructor in CommandLinePlugin

compareTo(Element) - Method in PackageJson.Element

configCacheSafeOperations - Property in BaseNodeJSExtension

configCacheSafeOperations - Property in BaseNpmExtension

CONFIGURATION_NAME - Field in NpmPlugin

configureSpecFromExtensions(org.ysb33r.gradle.nodejs.NodeJSExecSpec, org.ysb33r.gradle.nodejs.NodeJSExtension) - Method in NodeJSExecutor

Configures an NodeJSExecSpec from a NodeJSExtension.

contentEquals(org.gradle.api.artifacts.Dependency) - Method in BaseNpmSelfResolvingDependency

copy() - Method in BaseNpmSelfResolvingDependency

createExecSpec() - Method in BaseNpmExtension

Create execution specification.

createExecSpec() - Method in GenericNodeBaseTask

Creates a node.js execution specification and populates it with default working directory, environment and location of node.

createExecSpec() - Method in NodeJSExtension

Create execution specification.

createExecSpec() - Method in NpmExtensionMethods

Create execution specification.

createNodeJSExecSpec(T) - Method in NodeJSExecutor

Creates an NodeJSExecSpec with default node location.

createNodeJSExecSpecWithDefaultEnvironment(T) - Method in NodeJSExecutor

Creates an NodeJSExecSpec with default node location and a default environment.

createNpmExecSpec(org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations, org.ysb33r.gradle.nodejs.NodeJSConfigCacheSafeOperations, org.ysb33r.gradle.nodejs.NpmConfigCacheSafeOperations, boolean) - Method in NpmExecutor

Creates a NpmExecSpec with default node & npm-cli.js locations.

createNpmExecSpecWithDefaultEnvironment(org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations, org.ysb33r.gradle.nodejs.NodeJSConfigCacheSafeOperations, org.ysb33r.gradle.nodejs.NpmConfigCacheSafeOperations, boolean) - Method in NpmExecutor

Creates an NpmExecSpec with default node & npm-cli.js locations and then configure an appropriate default environment.

createNpmPackageInstaller(Provider<File>, Provider<List<String>>) - Method in NpmExecutor

Create a NPM package installer that is configuration cache safe and which will install all packages including dev.

createPackageInstaller() - Method in AbstractBaseNpmPackageJsonInstall

Creates an actual installer.

D

DEFAULT_GROUP - Field in DevBasePlugin

DEFAULT_SRCDIR - Field in DevBasePlugin

DEPENDENCY_EXTENSION_NAME - Field in NpmPlugin

dependencyGroup - Property in NpmDependencyGroup

DependencyHandlerExtension - Class in org.ysb33r.gradle.nodejs.dependencies.npm

Adds a npm extension to a dependency handler.

DependencyHandlerExtension(org.ysb33r.grolifant5.api.core.ProjectOperations, org.ysb33r.gradle.nodejs.NodeJSExtension, org.ysb33r.gradle.nodejs.NpmExtension) - Constructor in DependencyHandlerExtension

DevBasePlugin - Class in org.ysb33r.gradle.nodejs.plugins

Javascript development base plugin.

DevBasePlugin() - Constructor in DevBasePlugin

DEVELOPMENT - Field in NpmDependencyGroup

Downloader - Class in org.ysb33r.gradle.nodejs.internal

Downloads specific versions of NodeJS.

Downloader.1 - Class in org.ysb33r.gradle.nodejs.internal

Downloader.1() - Constructor in Downloader.1

Downloader.2 - Class in org.ysb33r.gradle.nodejs.internal

Downloader.2() - Constructor in Downloader.2

Downloader(org.ysb33r.grolifant5.api.core.ProjectOperations) - Constructor in Downloader

Creates a Node downloader.

DOWNLOADER_NAME - Field in Downloader

DOWNLOADER_SUBPATH - Field in Downloader

E

environment(Map<String, ?>) - Method in BaseNodeJSExtension

Add environmental variables to be passed to the exe.

environment(Map<String, ?>) - Method in GenericNodeBaseTask

environment(Map<String,?>) - Method in NodeJSExtensionMethods

Add environmental variables to be passed to the exe.

environmentFromExtensions(org.ysb33r.gradle.nodejs.NodeJSConfigCacheSafeOperations, org.ysb33r.gradle.nodejs.NpmConfigCacheSafeOperations) - Method in NpmExecutor

Creates an environment based up on extensions.

environmentProvider - Property in SimpleNodeJSConfigCacheSafeOperations

environmentProviderFromExtensions(org.ysb33r.gradle.nodejs.NodeJSConfigCacheSafeOperations, org.ysb33r.gradle.nodejs.NpmConfigCacheSafeOperations) - Method in NpmExecutor

Creates an environment based up on extensions.

exec() - Method in AbstractBaseNpmPackageJsonInstall

exec() - Method in AbstractCmdlineTask

exec() - Method in NodeNpmPrepareTask

exec() - Method in SyncPackageJson

exec() - Method in SyncProjectToNvmRc

ExecHelpers - Class in org.ysb33r.gradle.nodejs.internal.npm

Internal helper class for running execution specifications and working around Windows issues.

ExecHelpers() - Constructor in ExecHelpers

executable - Property in SimpleNodeJSConfigCacheSafeOperations

executable - Property in SimpleNpmConfigCacheSafeOperations

executableByNvmrc() - Method in NodeJSExtension

Read the version from .nvmrc.

executableByPath(java.lang.Object) - Method in AbstractPackageWrappingExtension

Set package to be located by fixed path.

executableByPath(java.lang.Object) - Method in NodeJSExtension

Locate an executable by a local path.

executableBySearchPath(java.lang.Object) - Method in NodeJSExtension

Locate executable by searching the current environmental search path.

executableByVersion(java.lang.Object) - Method in AbstractPackageWrappingExtension

Set package to be resolved by version.

executableByVersion(java.lang.Object) - Method in NodeJSExtension

Locate an executable by version, probably downloading it if not local.

executableDownloader - Property in Downloader

executableIsBundled() - Method in BaseNpmExtension

Use the NPM that is bundled with Node.

executableIsBundled() - Method in NpmExtensionMethods

Use the NPM that is bundled with Node.

execute(org.gradle.api.XmlProvider) - Method in WrapperPlugin.1

F

FORCE_NODE_DEFAULT_FOR_NPM - Field in NpmExecutor

Use this value to force the use of the bundled NPM rather than the version supplied by an NPM extension.

forceSemver - Property in SyncPackageJson

Force NPM semantic versioning to be used.

forceTwoSpaceIndent - Property in SyncPackageJson

Whether to force a two-space indent when rewriting the file.

formatName(java.lang.String) - Method in PackageJson

Formats a name suitable for package.json.

formatVersion(java.lang.String, boolean) - Method in PackageJson

Formats a supplied version into a NPM-safe version

FOUR_SPACES - Field in PackageJson.Indentation

from(org.ysb33r.gradle.nodejs.NodeJSConfigCacheSafeOperations) - Method in NodeJSConfigCacheSafeOperations

from(org.ysb33r.gradle.nodejs.NpmConfigCacheSafeOperations) - Method in NpmConfigCacheSafeOperations

Creates a new instance from something else that implements the same interface.

G

GenericNodeBaseTask - Class in org.ysb33r.gradle.nodejs.tasks

A base class that will provide NodeJS and NPM task extensions.

GenericNodeBaseTask() - Constructor in GenericNodeBaseTask

getAdditionalInstallArgs() - Method in AbstractBaseNpmPackageJsonInstall

Customise installation via additional argument that are passed to npm install.

getAdditionalProperties() - Method in NodeBinariesCacheTask

getBeginToken() - Method in NodeWrappers

getBinaryLocationProvider() - Method in NodeBinariesCacheTask

Obtains location of executable binary or script

getBinaryVersionProvider() - Method in NodeBinariesCacheTask

Obtains version of binary or script

getBundledDependencies() - Method in PackageJson

getByVersion(java.lang.String) - Method in Downloader.1

getByVersion(java.lang.String) - Method in Downloader.2

getByVersion(java.lang.String) - Method in NpmInstaller

Locates, and optionally downloads, NPM by version.

getCmd() - Method in NpmExecSpec

Get direct access to the org.ysb33r.grolifant5.api.core.executable.CommandEntryPoint instance.

getCmd() - Method in NpmTask

getDefaultEnvironment() - Method in NodeJSExecutor

Minimum default environment to use when running node

getDependencies() - Method in PackageJson

getDescription() - Method in PackageJson

getDevDependencies() - Method in PackageJson

getDisplayName() - Method in NpmComponentIdentifier

getDownloader() - Method in BaseNodeJSExtension

Gets the downloader implementation.

getDownloader() - Method in BaseNpmExtension

Gets the downloader implementation.

getEndToken() - Method in NodeWrappers

getEntryPoint() - Method in AbstractPackageWrappingExtension

The entrypoint path relative to the installed executable folder

getEntryPoint() - Method in GulpExtension

getEntryPoint() - Method in PackageEntryPoint

Entry point command / JS file

getEnvironment() - Method in AbstractNodeBaseTask

getEnvironment() - Method in BaseNodeJSExtension

Environment for running the exe

getEnvironment() - Method in GenericNodeBaseTask

getEnvironment() - Method in NodeJSExtensionMethods

Environment for running the exe

getEnvironment() - Method in NpmPackageJsonInstall

getEnvironmentProvider() - Method in BaseNodeJSExtension

getEnvironmentProvider() - Method in NodeJSConfigCacheSafeOperations

Environment for running the exe

getExecutable() - Method in AbstractPackageWrappingExtension

An executable entry point for a package that is suitable for execution by node.

getExecutable() - Method in NodeJSConfigCacheSafeOperations

A provider for a resolved executable.

getExecutable() - Method in NpmConfigCacheSafeOperations

A provider for a resolved executable.

getExtensionName() - Method in AbstractPackageWrappingExtension

Returns the name by which the extension is known.

getFiles() - Method in BaseNpmSelfResolvingDependency

getFinalArgs() - Method in AbstractCmdlineTask

getFinalArgs() - Method in GulpTask

getGlobalConfig() - Method in BaseNpmExtension

Location & name of global NPM config file.

getGlobalConfig() - Method in NpmExtensionMethods

Location and name of global NPM config file.

getGlobalConfigProvider() - Method in BaseNpmExtension

Location & name of global NPM config file.

getGlobalConfigProvider() - Method in NpmConfigCacheSafeOperations

Location and name of global NPM config file.

getGlobalPackageWrappingExtension() - Method in AbstractPackageWrappingExtension

getGroup() - Method in BaseNpmSelfResolvingDependency

getGroup() - Method in PackageInstallGroup

Installation group for a package i.e.

getGulpExecutablePath() - Method in GulpTask

getGulpFileProvider() - Method in GulpExtension

The location of gulpfile.js.

getHomeDirectory() - Method in BaseNpmExtension

The NPM home directory - the parent directory of node_modules,

getHomeDirectory() - Method in NpmExtensionMethods

The NPM home directory - the parent directory of node_modules,

getHomeDirectoryProvider() - Method in BaseNpmExtension

The NPM home directory - the parent directory of node_modules,

getHomeDirectoryProvider() - Method in NpmConfigCacheSafeOperations

The NPM home directory - the parent directory of node_modules,

getHomeDirProvider() - Method in AbstractBaseNpmPackageJsonInstall

THe NPM home directory.

getHomeDirProvider() - Method in NpmPackageJsonInstall

The NPM home directory.

getHomepage() - Method in PackageJson

getInstallGroup() - Method in AbstractPackageWrappingExtension

The installation group for this executable.

getInstallGroup() - Method in NpmDependency

NPM installation group

getKeywords() - Method in PackageJson

getLicense() - Method in PackageJson

getLocalConfig() - Method in BaseNpmExtension

Location & name of local NPM config file.

getLocalConfig() - Method in NpmExtensionMethods

Location and name of local NPM config file.

getLocalConfigProvider() - Method in BaseNpmExtension

Location & name of local NPM config file.

getLocalConfigProvider() - Method in NpmConfigCacheSafeOperations

Location and name of local NPM config file.

getName() - Method in BaseNpmSelfResolvingDependency

getName() - Method in PackageJson

getNativeExecSpec() - Method in NpmScriptTask

Access to the underlying NpmExecSpec.

getNativeExecSpec() - Method in NpmTask

Access to the underlying NpmExecSpec.

getNodeExecutablePath(java.lang.String) - Method in Downloader

Returns the path to the node executable.

getNodeExtension() - Method in AbstractNodeBaseTask

Internal access to attached NodeJS extension.

getNodeExtension() - Method in GenericNodeBaseTask

Internal access to attached NodeJS extension.

getNodeExtension() - Method in NpmPackageJsonInstall

Internal access to attached NodeJS extension.

getNodejs() - Method in AbstractCmdlineTask

getNodejs() - Method in NpmTask

getNodeJsExtensionName() - Method in BaseNpmExtension

Returns the name of the extension to look for when trying to find the Node.js extension.

getNodeWrapperProvider() - Method in NodeWrappers

getNpm() - Method in AbstractCmdlineTask

getNpm() - Method in NpmTask

getNpmCliJsProvider() - Method in BaseNodeJSExtension

Resolves a path to a npm executable that is associated with the configured Node.js.

getNpmCliJsProvider() - Method in NodeJSConfigCacheSafeOperations

Resolves a path to a npm executable that is associated with the configured Node.js.

getNpmExecutablePath(java.lang.String) - Method in Downloader

Returns the path to the included npm-cli.js Node.js executable JavaScript.

getNpmExecutor() - Method in AbstractNodeBaseTask

getNpmExecutor() - Method in GenericNodeBaseTask

getNpmExecutor() - Method in NpmPackageJsonInstall

getNpmExtension() - Method in AbstractNodeBaseTask

Internal access to attached NPM extension.

getNpmExtension() - Method in GenericNodeBaseTask

Internal access to attached NPM extension.

getNpmExtension() - Method in NpmPackageJsonInstall

Internal access to attached NPM extension.

getNpmPackageCoordinates() - Method in NpmDependency

getNpmPackageCoordinates() - Method in NpmPackageDescriptor

Returns a string that can be passed for installation purposes.

getNpmPackageCoordinates() - Method in SimpleNpmPackageDescriptor

Returns a string that can be passed for installation purposes.

getNpmPackageInstaller() - Method in AbstractBaseNpmPackageJsonInstall

Returns the NPM packer installer instance.

getNpmPackageInstaller() - Method in NpmPackageJsonInstall

Returns the NPM packer installer instance.

getNpmProjectExtensionName() - Method in BaseNpmExtension

Returns the name of the extension to look for when trying to find the Npm extension.

getNpxCliJsProvider() - Method in BaseNpmExtension

The location of NPX.

getNpxCliJsProvider() - Method in NpmConfigCacheSafeOperations

The location of NPX.

getNvmrcLocation() - Method in NodeJSExtension

.nvmrc location.

getOptionalDependencies() - Method in PackageJson

getPackageInstallationFolder(org.ysb33r.gradle.nodejs.NpmPackageDescriptor) - Method in NpmExecutor

Works out where the installation folder will be for a executable.

getPackageJsonFile() - Method in AbstractBaseNpmPackageJsonInstall

The package.json file that this task will query.

getPackageJsonFile() - Method in SyncPackageJson

Location of the package.json file.

getPackageJsonFileProvider() - Method in AbstractBaseNpmPackageJsonInstall

The package.json file that this task will query.

getPackageJsonName() - Method in SyncPackageJson

Project name that will be use for package.json

getPackageLockFile() - Method in AbstractBaseNpmPackageJsonInstall

The executable-lock.json file that this task will create.

getPackageLockFileProvider() - Method in AbstractBaseNpmPackageJsonInstall

The executable-lock.json file that this task will create.

getPackageName() - Method in NpmDependency

Name of the package without tags

getPackageName() - Method in NpmPackageDescriptor

Name of the executable without tags

getPeerDependencies() - Method in PackageJson

getPreArgs() - Method in NpmScriptDefinition

getProjectConfig() - Method in BaseNpmExtension

Location of .npmrc for a project.

getProjectConfig() - Method in NpmExtensionMethods

Location of .npmrc for a project.

getProjectConfigProvider() - Method in BaseNpmExtension

getProjectConfigProvider() - Method in NpmConfigCacheSafeOperations

Location of .npmrc for a project.

getProjectName() - Method in SyncPackageJson

getPropertiesDescription() - Method in NodeBinariesCacheTask

Obtains a description to be added to the cached binary properties file.

getReason() - Method in BaseNpmSelfResolvingDependency

getRequires() - Method in GulpExtension

Get set of requires that will be passed to Gulp.

getRequiresProvider() - Method in GulpExtension

Lazy-evaluated list of requires.

getScope() - Method in NpmDependency

Package scope

getScope() - Method in NpmPackageDescriptor

Package scope

getScripts() - Method in PackageJson

getTagName() - Method in NpmDependency

Name of NPM tag

getTagName() - Method in NpmPackageDescriptor

Name of NPM tag

getTarget() - Method in GulpTask

The task to run.

getTargetComponentId() - Method in BaseNpmSelfResolvingDependency

getTokenValuesAsMap() - Method in NodeWrappers

getVersion() - Method in BaseNpmSelfResolvingDependency

getVersion() - Method in PackageJson

getVersionProvider() - Method in BaseNpmExtension

Provides the version as specified in package.json.

getVersionProvider() - Method in NpmConfigCacheSafeOperations

Provides the version as specified in package.json.

getVersionProvider() - Method in SyncPackageJson

globalConfig(java.lang.Object) - Method in BaseNpmExtension

Set global config file.

globalConfig(java.lang.Object) - Method in NpmExtensionMethods

Sets global config file.

globalConfigProvider - Property in SimpleNpmConfigCacheSafeOperations

gradle - Property in NpmrcProviders

Typically ~/.gradle/.npmrc

GulpBasePlugin - Class in org.ysb33r.gradle.nodejs.plugins

Create Gulp plugin that applies some conventions.

GulpBasePlugin() - Constructor in GulpBasePlugin

GulpExtension - Class in org.ysb33r.gradle.nodejs

Extension that allows for setting of Gulp configuration at a project or task level.

GulpExtension(org.ysb33r.gradle.nodejs.tasks.GulpTask) - Constructor in GulpExtension

GulpPlugin - Class in org.ysb33r.gradle.nodejs.plugins

Create Gulp plugin that applies some conventions.

GulpPlugin() - Constructor in GulpPlugin

GulpTask - Class in org.ysb33r.gradle.nodejs.tasks

Ability to run a Gulp task.

GulpTask() - Constructor in GulpTask

H

homeDirectory(java.lang.Object) - Method in BaseNpmExtension

Sets the home directory.

homeDirectory(java.lang.Object) - Method in NpmExtensionMethods

Sets the home directory.

homeDirectoryProvider - Property in SimpleNpmConfigCacheSafeOperations

I

index - Property in PackageJson.Element

initPkgJson(java.lang.String, Provider<String>) - Method in NpmExecutor

Creates a template package.json file.

install(java.lang.String) - Method in NpmInstaller

INSTALL_TASK - Field in AltDevPlugin

INSTALL_TASK - Field in DevBasePlugin

installNpmPackage(org.ysb33r.gradle.nodejs.NpmPackageDescriptor, org.ysb33r.gradle.nodejs.NpmDependencyGroup, Iterable<String>, Map<String, Object>) - Method in NpmExecutor

Installs an NPM executable by running npmExt install in a controlled environment.

installPackagesFromDescription(java.io.File, Iterable<String>, boolean) - Method in NpmExecutor

Installs packages from a package.json description.

isResolveNodeByVersion() - Method in NodeJSExtension

Indicates whether resolving node is by version.

isSatisfiedBy(org.gradle.api.Task) - Method in NodeNpmPrepareTask.1

isSyncNodeVersionFromNvmRc() - Method in NodeJSExtension

Indicates whether the Node version is being synchronised from .nvmrc.

J

K

key - Property in PackageJson.Element

L

loadVersionFromPackageJson(java.io.File) - Method in PackageJson

Loads the version string.

localConfig(java.lang.Object) - Method in BaseNpmExtension

Set local config file.

localConfig(java.lang.Object) - Method in NpmExtensionMethods

Sets local config file.

localConfigProvider - Property in SimpleNpmConfigCacheSafeOperations

locateNpm - Field in BaseNodeJSExtension

M

MAX_VALUE - Field in NpmDependencyGroup

MAX_VALUE - Field in PackageJson.Indentation

MIN_VALUE - Field in NpmDependencyGroup

MIN_VALUE - Field in PackageJson.Indentation

N

NAME - Property in GulpExtension

NAME - Field in NodeJSExtension

NAME - Field in NpmExtension

name - Property in PackageDescriptor

next() - Method in NpmDependencyGroup

next() - Method in PackageJson.Indentation

NODE_WRAPPER - Field in NodeWrappers

NODE_WRAPPER_WINDOWS - Field in NodeWrappers

NodeBinariesCacheTask - Class in org.ysb33r.gradle.nodejs.tasks

Caches node binaries

NodeBinariesCacheTask() - Constructor in NodeBinariesCacheTask

NodeCmdlineTask - Class in org.ysb33r.gradle.nodejs.tasks

Providers a task for running node with arguments.

NodeCmdlineTask() - Constructor in NodeCmdlineTask

NodeJSBasePlugin - Class in org.ysb33r.gradle.nodejs.plugins

Provide the basic capabilities for dealing with Node.js & NPM tasks.

NodeJSBasePlugin() - Constructor in NodeJSBasePlugin

NodeJSConfigCacheSafeOperations - Interface in org.ysb33r.gradle.nodejs

NodeJS methods that an extension should implement.

NodeJSExecSpec - Class in org.ysb33r.gradle.nodejs

Execution specification for running a Node.js script.

NodeJSExecSpec(org.gradle.api.Project, Provider<File>) - Constructor in NodeJSExecSpec

Construct class and attach it to specific project.

NodeJSExecutor - Class in org.ysb33r.gradle.nodejs.utils

Utilities to execute Node.js scripts.

NodeJSExecutor() - Constructor in NodeJSExecutor

NodeJSExtension - Class in org.ysb33r.gradle.nodejs

Configure project defaults or task specifics for Node.js.

nodeJSExtension - Field in AbstractPackageWrappingExtension

NodeJSExtension associated with the project or task extension

NodeJSExtension(org.gradle.api.Task, org.ysb33r.gradle.nodejs.NodeJSExtension) - Constructor in NodeJSExtension

Constructs a new extension which is attached to the provided task.

NodeJSExtensionMethods - Interface in org.ysb33r.gradle.nodejs

NodeJS methods that an extension should implement.

NodeNpmPrepareTask - Class in org.ysb33r.gradle.nodejs.tasks

A simplified task that can just prepare an environment consisting of Node & Npm.

NodeNpmPrepareTask.1 - Class in org.ysb33r.gradle.nodejs.tasks

NodeNpmPrepareTask.1() - Constructor in NodeNpmPrepareTask.1

NodeNpmPrepareTask(org.ysb33r.gradle.nodejs.NodeJSConfigCacheSafeOperations, org.ysb33r.gradle.nodejs.NpmConfigCacheSafeOperations) - Constructor in NodeNpmPrepareTask

NodeWrappers - Class in org.ysb33r.gradle.nodejs.tasks

A task to generate Node wrappers.

NodeWrappers() - Constructor in NodeWrappers

NPM_INSTALL - Field in NpmExecutor

NPM_MAVEN_GROUP_NO_SCOPE - Field in BaseNpmSelfResolvingDependency

NPM_MAVEN_GROUP_PREFIX - Field in BaseNpmSelfResolvingDependency

npmCliJsProvider - Property in SimpleNodeJSConfigCacheSafeOperations

NpmCmdlineTask - Class in org.ysb33r.gradle.nodejs.tasks

Providers a task for running npm with arguments.

NpmCmdlineTask() - Constructor in NpmCmdlineTask

NpmComponentIdentifier - Class in org.ysb33r.gradle.nodejs.internal.npm

Implements a ComponentIdentifier interface.

NpmComponentIdentifier(java.lang.String) - Constructor in NpmComponentIdentifier

NpmConfigCacheSafeOperations - Interface in org.ysb33r.gradle.nodejs

NPM operations that should be configuration cache-safe.

npmConfigurations(java.lang.Object) - Method in SyncPackageJson

Adds configurations which contain NPM dependencies.

NpmDependency - Class in org.ysb33r.gradle.nodejs

Creates an NPM dependency

NpmDependency(Map<String, ?>) - Constructor in NpmDependency

Allows additional parameters to be set

NpmDependencyGroup - Enum in org.ysb33r.gradle.nodejs

Defines the three NPM executable installation/grouping options

NpmDevPlugin - Class in org.ysb33r.gradle.nodejs.plugins

Conventions for building a project with Node and Gradle.

NpmDevPlugin() - Constructor in NpmDevPlugin

NpmExecSpec - Class in org.ysb33r.gradle.nodejs

Base specification for running an NPM command via npm-cli.js

NpmExecSpec(Provider<File>, Provider<File>, org.ysb33r.grolifant5.api.core.ProjectOperations) - Constructor in NpmExecSpec

Construct class and attach it to specific project.

NpmExecutor - Class in org.ysb33r.gradle.nodejs.utils.npm

Utility methods that aids in running NPM.

NpmExecutor.1 - Class in org.ysb33r.gradle.nodejs.utils.npm

NpmExecutor.1() - Constructor in NpmExecutor.1

NpmExecutor(org.ysb33r.grolifant5.api.core.ProjectOperations, org.ysb33r.gradle.nodejs.NodeJSExtensionMethods, org.ysb33r.gradle.nodejs.NpmExtensionMethods, boolean) - Constructor in NpmExecutor

Parameters:

projectOperations - Operations for the specific project context

NpmExtension - Class in org.ysb33r.gradle.nodejs

Set up global config or task-based config for NPM.

npmExtension - Field in AbstractPackageWrappingExtension

NpmExtension associated with the project or task extension

NpmExtension(org.gradle.api.Task, Class<? super NpmExtension>) - Constructor in NpmExtension

Constructs a new extension which is attached to the provided task.

NpmExtensionMethods - Interface in org.ysb33r.gradle.nodejs

Methods than Npm extension is required to implement.

NpmInstaller - Class in org.ysb33r.gradle.nodejs.internal.npm

Installs a custom version of NPM in node_modules.

NpmInstaller(org.ysb33r.grolifant5.api.core.ProjectOperations, org.ysb33r.gradle.nodejs.NodeJSExtensionMethods, org.ysb33r.gradle.nodejs.NpmExtensionMethods) - Constructor in NpmInstaller

Parameters:

nodeJSExtension - nodejs extension.

NpmPackageDescriptor - Interface in org.ysb33r.gradle.nodejs

Specifies various characteristics of an NPM Package which can be used for various NPM commands, especially install and search.

NpmPackageInstaller - Interface in org.ysb33r.gradle.nodejs.utils.npm

Abstract the installaiotn of NPM packages.

NpmPackageJsonInstall - Class in org.ysb33r.gradle.nodejs.tasks

Installs the packages as described by a package.json file

NpmPackageJsonInstall() - Constructor in NpmPackageJsonInstall

NpmPackageResolveException - Class in org.ysb33r.gradle.nodejs.errors

Thrown for errors when resolving NPM packages.

NpmPackageResolveException() - Constructor in NpmPackageResolveException

NpmPackageResolver - Class in org.ysb33r.gradle.nodejs.internal.npm

Resolves an NPM executable and installs it in a designated node_modules directory

NpmPackageResolver(org.ysb33r.grolifant5.api.core.ProjectOperations, org.ysb33r.gradle.nodejs.NodeJSExtension, org.ysb33r.gradle.nodejs.NpmExtension) - Constructor in NpmPackageResolver

Creates a executable resolver that as a NodeJS ane NPM context.

NpmPlugin - Class in org.ysb33r.gradle.nodejs.plugins

Since:

0.1

NpmPlugin() - Constructor in NpmPlugin

NPMRC_SEARCH_LOCATIONS - Field in NpmrcProviders

NpmrcProviders - Class in org.ysb33r.gradle.nodejs.internal.npm

Provides locations of various .npmrc files.

NpmrcProviders(org.ysb33r.grolifant5.api.core.ProjectOperations, java.io.File, Provider<File>) - Constructor in NpmrcProviders

NpmScriptDefinition - Class in org.ysb33r.gradle.nodejs

A specification for executing NPM scripts.

NpmScriptDefinition.1 - Class in org.ysb33r.gradle.nodejs

NpmScriptDefinition.1() - Constructor in NpmScriptDefinition.1

NpmScriptDefinition.2 - Class in org.ysb33r.gradle.nodejs

NpmScriptDefinition.2() - Constructor in NpmScriptDefinition.2

NpmScriptDefinition(org.ysb33r.grolifant5.api.core.ProjectOperations) - Constructor in NpmScriptDefinition

NpmScriptExecSpec - Class in org.ysb33r.gradle.nodejs

Base specification for running an NPM script via npm-cli.js

NpmScriptExecSpec(Provider<File>, Provider<File>, org.ysb33r.grolifant5.api.core.ProjectOperations) - Constructor in NpmScriptExecSpec

Construct class and attach it to specific project.

NpmScriptTask - Class in org.ysb33r.gradle.nodejs.tasks

Runs scripts that are defined in package.json.

NpmScriptTask() - Constructor in NpmScriptTask

NpmSelfResolvingDependency - Class in org.ysb33r.gradle.nodejs.dependencies.npm

An NPM dependency that can resolve itself.

NpmSelfResolvingDependency(org.ysb33r.grolifant5.api.core.ProjectOperations, org.ysb33r.gradle.nodejs.NodeJSExtension, org.ysb33r.gradle.nodejs.NpmExtension, Map<String, Object>) - Constructor in NpmSelfResolvingDependency

An NPM dependency that can resolve itself.

NpmTask - Class in org.ysb33r.gradle.nodejs.tasks

Ability to execute any NPM command with parameters.

NpmTask() - Constructor in NpmTask

npxCliJsProvider - Property in SimpleNpmConfigCacheSafeOperations

NpxCmdlineTask - Class in org.ysb33r.gradle.nodejs.tasks

Providers a task for running npx with arguments.

NpxCmdlineTask() - Constructor in NpxCmdlineTask

O

of(java.lang.String, java.lang.String) - Method in PackageDescriptor

of(java.lang.String, java.lang.String) - Method in PackageJson

Creates a base object consisting only of a name and version.

OMIT_DEV - Field in NpmExecutor

onlyNpmDependencyKeys(Map<String, Object>) - Method in NpmDependency

Extracts only the keys for NpmDependency that are valid.

OPTIONAL - Field in NpmDependencyGroup

OS - Field in Downloader

P

PACKAGE_JSON - Field in PackageJson

PackageDescriptor - Class in org.ysb33r.gradle.nodejs

Describes a NPM package without a version

PackageEntryPoint - Interface in org.ysb33r.gradle.nodejs.pkgwrapper

Entry point for a NPM package

PackageInstallGroup - Interface in org.ysb33r.gradle.nodejs.pkgwrapper

Obtains the installation group for a package

PackageJson - Class in org.ysb33r.gradle.nodejs

Parses a package.json file.

PackageJson.Element - Class in org.ysb33r.gradle.nodejs

PackageJson.Element() - Constructor in PackageJson.Element

PackageJson.Indentation - Enum in org.ysb33r.gradle.nodejs

Indentation to use when writing files.

packageName - Property in SimpleNpmPackageDescriptor

parsePackageJson(java.io.File) - Method in PackageJson

Parses a package.json file.

parsePackageJsonToGPath(java.io.File) - Method in PackageJson

Parses a package.json file.

parsePackageJsonToMap(java.io.File) - Method in PackageJson

Parses a package.json file.

PEER - Field in NpmDependencyGroup

pkg(Map<String, ?>) - Method in DependencyHandlerExtension

Creates a NPM dependency from a specification.

prefixPath(Provider<String>) - Method in BaseNodeJSExtension

Add search to system path

prefixPath(Provider<String>) - Method in NodeJSExtensionMethods

Add search to system path

previous() - Method in NpmDependencyGroup

previous() - Method in PackageJson.Indentation

PRODUCTION - Field in NpmDependencyGroup

productionOnly - Property in AbstractBaseNpmPackageJsonInstall

Set to true if only production dependencies should be installed.

project - Property in NpmrcProviders

This is typically in src/node/.npmrc, but it is dependant on the where the npmHomeProvider points to.

projectConfigProvider - Property in SimpleNpmConfigCacheSafeOperations

PROPERTIES_FILENAME - Field in NodeBinariesCacheTask

provideResolveNodeByVersion - Property in NodeJSExtension

A provider to whether the node executable is resolved by version.

provideSyncNodeVersionFromNvmRc - Property in NodeJSExtension

A provider to whether the node version is synchronized form .nvmrc.

Q

R

requires(Iterable<String>) - Method in GulpExtension

Appends more require specifications.

resolve(boolean) - Method in BaseNpmSelfResolvingDependency

resolve(org.ysb33r.gradle.nodejs.NpmPackageDescriptor, org.ysb33r.gradle.nodejs.NpmDependencyGroup) - Method in NpmPackageResolver

Resolves an NPM executable

resolverFromPath(java.lang.Object) - Method in TagBasedNpmPackageResolver

resolverFromVersion(java.lang.Object) - Method in TagBasedNpmPackageResolver

resolvesWithEntryPoint(org.ysb33r.gradle.nodejs.NpmPackageDescriptor, java.lang.String, org.ysb33r.gradle.nodejs.NpmDependencyGroup) - Method in NpmPackageResolver

Resolves an entry point and then finds the location of the entry point

run() - Method in NpmExecutor.1

run() - Method in NpmPackageInstaller

Executes a package installation and return the file tree

runExecSpec(org.ysb33r.gradle.nodejs.NodeJSExecSpec) - Method in AbstractNodeBaseTask

Executes a configured execution specification.

runExecutableAndReturnVersion() - Method in BaseNodeJSExtension

Runs the executable and returns the version.

runExecutableAndReturnVersion() - Method in BaseNpmExtension

Runs the executable and returns the version.

runNpm(org.ysb33r.grolifant5.api.core.ExecTools, org.ysb33r.grolifant5.api.core.ExecTools$OutputType, org.ysb33r.grolifant5.api.core.ExecTools$OutputType, org.ysb33r.gradle.nodejs.NpmExecSpec) - Method in ExecHelpers

runNpm(org.ysb33r.grolifant5.api.core.ExecTools$OutputType, org.ysb33r.grolifant5.api.core.ExecTools$OutputType, org.ysb33r.gradle.nodejs.NpmExecSpec) - Method in NpmExecutor

Runs NPM given a fully-configured execution specification.

S

saveArgument - Property in NpmDependencyGroup

scope - Property in PackageDescriptor

scope - Property in SimpleNpmPackageDescriptor

script(Closure<?>) - Method in NpmScriptExecSpec

Configures the script.

script(Closure<?>) - Method in NpmScriptTask

SCRIPT_TASK_PREFIX - Field in NpmDevPlugin

setAdditionalInstallArgs(Iterable<String>) - Method in AbstractBaseNpmPackageJsonInstall

Replace list of arguments with a new list.

setArgs(List<Object>) - Method in AbstractCmdlineTask

setArgsLine(java.lang.String) - Method in AbstractCmdlineTask

setCommandProvider(java.lang.Object) - Method in AbstractCmdlineTask

setConsoleOutput(java.lang.String) - Method in AbstractCmdlineTask

Ability to turn output on or off.

setEnvironment(Map<String, ?>) - Method in BaseNodeJSExtension

Replace current environment with new one.

setEnvironment(Map<String, ?>) - Method in GenericNodeBaseTask

setEnvironment(Map<String,?>) - Method in NodeJSExtensionMethods

Replaces current environment with new one.

setEnvironmentProvider(Provider<Map<String, String>>) - Method in AbstractCmdlineTask

setGlobalConfig(java.lang.Object) - Method in BaseNpmExtension

Set global config file.

setGlobalConfig(java.lang.Object) - Method in NpmExtensionMethods

Sets global config file.

setGulpFile(java.lang.Object) - Method in GulpExtension

Sets the location of gulpfile.js

setHomeDirectory(java.lang.Object) - Method in BaseNpmExtension

Sets the home directory.

setHomeDirectory(java.lang.Object) - Method in NpmExtensionMethods

Sets the home directory.

setInstallGroup(org.ysb33r.gradle.nodejs.NpmDependencyGroup) - Method in AbstractPackageWrappingExtension

Sets the installation group (production, development, optional).

setLocalConfig(java.lang.Object) - Method in BaseNpmExtension

Set local config file.

setLocalConfig(java.lang.Object) - Method in NpmExtensionMethods

Sets local config file.

setName(java.lang.String) - Method in PackageJson

setPackageJsonFile(java.lang.Object) - Method in SyncPackageJson

Set the location of the package.json file

setPackageJsonName(java.lang.Object) - Method in SyncPackageJson

Set the name for package.json file.

setPackages(Provider<List<NpmPackageDescriptor>>) - Method in NodeNpmPrepareTask

Sets the list of packages to install.

setRequires(Iterable<String>) - Method in GulpExtension

Replace any existing require specifications with a new one.

setTarget(java.lang.String) - Method in GulpTask

Set the Gulp task to run.

setVersion(java.lang.String) - Method in PackageJson

setWorkingDir(java.lang.Object) - Method in AbstractCmdlineTask

SimpleNodeJSConfigCacheSafeOperations - Class in org.ysb33r.gradle.nodejs.internal.node

Store simple values for executing node in a configuration cache-safe manner.

SimpleNodeJSConfigCacheSafeOperations(Provider<File>, Provider<File>, Provider<Map<String, String>>) - Constructor in SimpleNodeJSConfigCacheSafeOperations

SimpleNpmConfigCacheSafeOperations - Class in org.ysb33r.gradle.nodejs.internal.npm

Npm operations that should be configuration-cache safe

SimpleNpmConfigCacheSafeOperations(org.ysb33r.gradle.nodejs.NpmConfigCacheSafeOperations) - Constructor in SimpleNpmConfigCacheSafeOperations

SimpleNpmPackageDescriptor - Class in org.ysb33r.gradle.nodejs

A simplistic NPM executable descriptor

SimpleNpmPackageDescriptor(java.lang.String, java.lang.String, java.lang.String) - Constructor in SimpleNpmPackageDescriptor

Parameters:

scope - Can be null

sortOutput - Property in SyncPackageJson

Sorts the output keys.

submitAsExec(Action<ExecSpec>) - Method in NpmExecSpec

SYNC_NVMRC_TASK - Field in DevBasePlugin

SYNC_TASK - Field in AltDevPlugin

SyncPackageJson - Class in org.ysb33r.gradle.nodejs.tasks

Task that will sync various project settings into a package.json file.

SyncPackageJson() - Constructor in SyncPackageJson

SyncProjectToNvmRc - Class in org.ysb33r.gradle.nodejs.tasks

Synchronised the Node version to .nvmrc.

SyncProjectToNvmRc() - Constructor in SyncProjectToNvmRc

system - Property in NpmrcProviders

On Windows this is sually at %APPDATA%/Roaming/npm/npmrc.

T

TagBasedNpmPackageResolver - Class in org.ysb33r.gradle.nodejs.internal.npm

A base class for creating resolvers for specific NPM packages.

TagBasedNpmPackageResolver(java.lang.String, java.lang.String, org.ysb33r.grolifant5.api.core.ProjectOperations, org.ysb33r.gradle.nodejs.NodeJSExtension, org.ysb33r.gradle.nodejs.NpmExtension, org.ysb33r.gradle.nodejs.pkgwrapper.PackageInstallGroup, org.ysb33r.gradle.nodejs.pkgwrapper.PackageEntryPoint) - Constructor in TagBasedNpmPackageResolver

Parameters:

scope - Resolve scope.

tagName - Property in SimpleNpmPackageDescriptor

toList(Collection<I>, Function<I, O>) - Method in Transform

toSet(Iterable<I>, Function<I, O>) - Method in Transform

toString() - Method in BaseNpmSelfResolvingDependency

toString() - Method in PackageDescriptor

toString() - Method in PackageJson.Element

toString() - Method in SimpleNpmPackageDescriptor

Transform - Class in org.ysb33r.gradle.nodejs.internal

Transforms a collection to another collection.

transform(java.lang.String) - Method in NpmScriptDefinition.1

transform(java.lang.String) - Method in NpmScriptDefinition.2

Transform() - Constructor in Transform

TWO_SPACES - Field in PackageJson.Indentation

U

UnsupportedMethodException - Class in org.ysb33r.gradle.nodejs.errors

Thrown when cerain methods are called which have been superceded by other methods, but where the original methods cannot be removed due to interface constraints.

UnsupportedMethodException() - Constructor in UnsupportedMethodException

uriFromVersion(java.lang.String) - Method in Downloader

Provides an appropriate URI to download a specific tag of NodeJS.

USE_DEFAULT_EXTENSIONS - Field in AbstractPackageWrappingExtension

Whether the NodeJS & Npm extensions should be those provided by the project and tasals

USE_EMBEDDED_EXTENSIONS - Field in AbstractPackageWrappingExtension

Whether the NodeJS & Npm extensions should be created as extensions of this extensions and thus be decoupled from the normal extensions provided by this plugin suite.

useGlobalGradleLocation() - Method in BaseNpmExtension

Sets it to use the equivalent of getGradleHomeDir()/.npmrc.

useGlobalGradleLocation() - Method in NpmExtensionMethods

Sets it to use the equivalent of getGradleHomeDir()/.npmrc.

useGlobalSystemLocation() - Method in BaseNpmExtension

Tries to determine the location where global config will typically be places.

useGlobalSystemLocation() - Method in NpmExtensionMethods

Tries to determine the location where global config will typically be placed.

useLocalProjectLocation() - Method in BaseNpmExtension

Use to indicate that userconfig should be retrieved from the NPM home directory as configured by getHomeDirectory().

useLocalProjectLocation() - Method in NpmExtensionMethods

Use to indicate that userconfig should be retrieved from the NPM home directory as configured by getHomeDirectory().

useLocalUserProfileLocation() - Method in BaseNpmExtension

Use to indicate that userconfig should be retrieved from the user's home directory.

useLocalUserProfileLocation() - Method in NpmExtensionMethods

Use to indicate that userconfig should be retrieved from the user's home directory.

usePackageJsonVersionAsProjectVersion() - Method in BaseNpmExtension

Use the version specified in package.json as the version of the project.

usePackageJsonVersionAsProjectVersion() - Method in NpmExtensionMethods

Use the version specified in package.json as the version of the project.

user - Property in NpmrcProviders

On Windows it will be found as %APPDATA%/npm/.npmrc.

useSystemPath() - Method in BaseNodeJSExtension

Adds the system path to the execution environment.

useSystemPath() - Method in NodeJSExtensionMethods

Adds the system path to the execution environment.

V

VALID_KEYS - Field in NpmDependency

valueOf(java.lang.String) - Method in NpmDependencyGroup

valueOf(java.lang.String) - Method in PackageJson.Indentation

values() - Method in NpmDependencyGroup

values() - Method in PackageJson.Indentation

verifyDistributionRoot(java.io.File) - Method in Downloader

Validates that the unpacked distribution is good.

versionProvider - Property in SimpleNpmConfigCacheSafeOperations

W

WRAPPER_TASK_NAME - Field in WrapperPlugin

WrapperPlugin - Class in org.ysb33r.gradle.nodejs.plugins

Provides a task for generating wrappers for node, npx and npm.

WrapperPlugin.1 - Class in org.ysb33r.gradle.nodejs.plugins

WrapperPlugin.1() - Constructor in WrapperPlugin.1

WrapperPlugin() - Constructor in WrapperPlugin

writeToFile(java.io.File, org.ysb33r.gradle.nodejs.PackageJson.Indentation, boolean) - Method in PackageJson

Writes the contents to a package.json file

X

Y

Z

ZIP_TASK - Field in DevBasePlugin

_