Index (nodejs-gradle-plugin 0.12.3 API)

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

AbstractCmdlineTask - Class in org.ysb33r.gradle.nodejs.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(Task, AbstractPackageWrappingExtension, boolean) - Constructor in AbstractPackageWrappingExtension: Associate projExt with a task.
addArgs(Object) - Method in AbstractCmdlineTask: Allows the derived task to push additional arguments that will usually precede any arguments derived from command-line.
addConfigurations(Project) - Method in NpmPlugin
additionalInstallArgs(Iterable<String>) - Method in NpmPackageJsonInstall: Adds more installation arguments
addNpmPackageExtension(Project) - Method in NpmPlugin
appendPath(Provider<String>) - Method in NodeJSExtension: Add search to system path.
apply(Project) - Method in CommandLinePlugin
apply(Project) - Method in GulpBasePlugin
apply(Project) - Method in GulpPlugin
apply(Project) - Method in NodeJSBasePlugin
apply(Project) - Method in NpmDevPlugin
apply(Project) - Method in NpmPlugin
apply(Project) - Method in WrapperPlugin

B

BadNvmRcException - Class in org.ysb33r.gradle.nodejs.errors: Thrown when reading .nvmrc does not yield a resolvable version.
because(String) - Method in NpmSelfResolvingDependency
build(Map<String, Object>, Object) - Method in TagBasedPackageResolver
buildCommandLine() - Method in NpmExecSpec: Builds up the command-line.
buildCommandLine() - Method in NpmTask

C

CACHE_TASK_NAME - Field in WrapperPlugin
calculateInstallableFiles(Project, NpmExtension, File) - Method in NpmExecutor: Returns a live set of installable files.
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
configureSpecFromExtensions(NodeJSExecSpec, NodeJSExtension) - Method in NodeJSExecutor: Configures an NodeJSExecSpec from a NodeJSExtension.
configureSpecFromExtensions(NpmExecSpec, NodeJSExtension, NpmExtension, boolean) - Method in NpmExecutor: Configures an NpmExecSpec from a NodeJSExtensions and a NpmExtension.
contentEquals(Dependency) - Method in NpmSelfResolvingDependency
copy() - Method in NpmSelfResolvingDependency
createExecSpec() - Method in AbstractNodeBaseTask: 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 NpmExtension: Create execution specification.

D

DEFAULT_GROUP - Field in NpmDevPlugin
DEFAULT_SRCDIR - Field in NpmDevPlugin
defaultNodejs() - Method in NpmExtension: Sets NPM to be resolved from the default node.js distribution associated with this project.

E

environment(Map<String, ?>) - Method in AbstractNodeBaseTask
environment(Map<String, ?>) - Method in NodeJSExtension: Add environmental variables to be passed to the exe.
environmentFromExtensions(NodeJSExtension, NpmExtension) - Method in NpmExecutor: Creates an environment based up on extensions.
exec() - Method in AbstractCmdlineTask
exec() - Method in GulpTask
exec() - Method in NpmPackageJsonInit
exec() - Method in NpmPackageJsonInstall
exec() - Method in SyncProjectToPackageJson
executable(Map<String, Object>) - Method in AbstractPackageWrappingExtension: Sets wrapper executable.
executable(Map<String, Object>) - Method in NodeJSExtension
executable(Map<String, Object>) - Method in NpmExtension
executableByNvmrc() - Method in NodeJSExtension: Read the version from .nvmrc.
executableByPath(Object) - Method in AbstractPackageWrappingExtension: Set package to be located by fixed path.
executableByVersion(Object) - Method in AbstractPackageWrappingExtension: Set package to be resolved by version.
executableIsBundled() - Method in NpmExtension: Use the NPM that is bundled with Node.

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.

G

getAdditionalInstallArgs() - Method in NpmPackageJsonInstall: 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
getCmdArgs() - Method in NpmScriptTask: Any arguments specific to the command in use
getDefaultEnvironment() - Method in NodeJSExecutor: Minimum default environment to use when running node
getDownloader() - Method in NodeJSExtension: Gets the downloader implementation.
getDownloader() - Method in NpmExtension: 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: The entrypoint path relative to the installed executable folder
getEntryPoint() - Method in PackageEntryPoint: Entry point command / JS file
getEnvironment() - Method in AbstractNodeBaseTask
getEnvironment() - Method in NodeJSExtension: Environment for running the exe
getEnvironment() - Method in NpmTask: The environment variables to use for the process.
getExeArgs() - Method in NpmExecSpec: Returns the arguments for the executable to be executed.
getExecutable() - Method in AbstractPackageWrappingExtension: An executable entry point for a package that is suitable for execution by node.
getExtensionName() - Method in AbstractPackageWrappingExtension: Returns the name by which the extension is known.
getExtensionName() - Method in GulpExtension: Returns the name by which the extension is known.
getFiles() - Method in NpmSelfResolvingDependency
getFinalArgs() - Method in AbstractCmdlineTask
getGlobalConfig() - Method in NpmExtension: Location & name of global NPM config file.
getGlobalPackageWrappingExtension() - Method in AbstractPackageWrappingExtension
getGroup() - Method in NpmSelfResolvingDependency
getGroup() - Method in PackageInstallGroup: Installation group for a package i.e.
getGulpFile() - Method in GulpExtension: The location of gulpfile.js.
getGulpFile() - Method in GulpTask: The gulpfile.js that will be used.
getGulpPath() - Method in GulpTask: The absolute path to gulpfile.js that will be used.
getHomeDirectory() - Method in NpmExtension: The NPM home directory - the parent directory of node_modules,
getHomeDirectoryProvider() - Method in NpmExtension: The NPM home directory - the parent directory of node_modules,
getInstallGroup() - Method in AbstractPackageWrappingExtension: The installation group for this executable.
getInstallGroup() - Method in NpmDependency: NPM installation group
getLocalConfig() - Method in NpmExtension: Location & name of local NPM config file.
getName() - Method in NpmSelfResolvingDependency
getNodeExtension() - Method in AbstractNodeBaseTask: Internal access to attached NodeJS extension.
getNodejs() - Method in AbstractCmdlineTask
getNodejs() - Method in NpmTask
getNodeJsExtensionName() - Method in NpmExtension: 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 NodeJSExtension: Resolves a path to a npm executable that is associated with the configured Node.js.
getNpmExecutor() - Method in AbstractNodeBaseTask
getNpmExtension() - Method in AbstractNodeBaseTask: Internal access to attached NPM extension.
getNpmProjectExtensionName() - Method in NpmExtension: Returns the name of the extension to look for when trying to find the Npm extension.
getNpxCliJsProvider() - Method in NpmExtension: The location of NPX.
getPackageInstallationFolder(Project, NodeJSExtension, NpmExtension, NpmPackageDescriptor) - Method in NpmExecutor: Works out where the installation folder will be for a executable.
getPackageJsonFile() - Method in NpmPackageJsonInit: The package.json file that this task will create update.
getPackageJsonFile() - Method in NpmPackageJsonInstall: The package.json file that this task will query.
getPackageJsonFile() - Method in SyncProjectToPackageJson: Location of the package.json file.
getPackageJsonFileProvider() - Method in NpmPackageJsonInit: The package.json file that this task will create update.
getPackageJsonFileProvider() - Method in NpmPackageJsonInstall: The package.json file that this task will query.
getPackageJsonName() - Method in SyncProjectToPackageJson: Project name that will be use for package.json
getPackageJsonVersion() - Method in SyncProjectToPackageJson: Version that will be use for package.json
getPackageLockFile() - Method in NpmPackageJsonInstall: The executable-lock.json file that this task will create.
getPackageLockFileProvider() - Method in NpmPackageJsonInstall: 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
getProjectConfig() - Method in NpmExtension: Location of .npmrc for a project.
getProjectName() - Method in NpmPackageJsonInit
getProjectOperations() - Method in AbstractCmdlineTask
getProjectOperations() - Method in AbstractNodeBaseTask
getPropertiesDescription() - Method in NodeBinariesCacheTask: Obtains a description to be added to the cached binary properties file.
getReason() - Method in NpmSelfResolvingDependency
getRequires() - Method in GulpExtension: Get set of requires that will be passed to Gulp.
getResolvableExecutable() - Method in AbstractPackageWrappingExtension: Lazy-evaluated location of the wrapped executable entry point.
getResolvableNodeExecutable() - Method in NodeJSExtension: Resolves a path to a node executable.
getResolvedExecutable() - Method in AbstractPackageWrappingExtension: Lazy-evaluated location of the wrapped executable entry point.
getResolvedNpmCliJs() - Method in NodeJSExtension: Resolves a path to a npm executable that is associated with the configured Node.js.
getResolvedNpmCliJs() - Method in NpmExtension: Resolves a path to a npm-cli.js executable.
getResolvedNpxCliJs() - Method in NpmExtension: Resolves a path to a npx-cli.js executable.
getScope() - Method in NpmDependency: Package scope
getScope() - Method in NpmPackageDescriptor: Package scope
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 NpmSelfResolvingDependency
getTokenValuesAsMap() - Method in NodeWrappers
getVersion() - Method in NpmSelfResolvingDependency
getVersionProvider() - Method in NpmPackageJsonInit
globalConfig(Object) - Method in NpmExtension: Set global config file.
GRADLE - Field in SyncProjectToPackageJson
GulpBasePlugin - Class in org.ysb33r.gradle.nodejs.plugins: Create Gulp plugin that applies some conventions.
GulpExtension - Class in org.ysb33r.gradle.nodejs: Extension that allows for setting of Gulp configuration at a project or task level.
GulpExtension(GulpTask) - Constructor in GulpExtension: Adds the extension to a GulpTask task.
gulpFile(Object) - Method in GulpExtension: Sets the location of gulpfile.js
GulpPlugin - Class in org.ysb33r.gradle.nodejs.plugins: Create Gulp plugin that applies some conventions.
GulpTask - Class in org.ysb33r.gradle.nodejs.tasks: Ability to run a Gulp task.
GulpTask() - Constructor in GulpTask

H

homeDirectory(Object) - Method in NpmExtension: Sets the home directory.

I

initPkgJson(Project, NodeJSExtension, NpmExtension) - Method in NpmExecutor: Creates a template package.json file.
INSTALL_TASK - Field in NpmDevPlugin
installNpmPackage(Project, NpmPackageDescriptor, NpmDependencyGroup, Iterable<String>) - Method in NpmExecutor: Installs an NPM executable by running npmExt install i a controlled environment.
installPackagesFromDescription(Project, File, Iterable<String>) - Method in NpmExecutor: Installs packages from a package.json description.

J

K

L

localConfig(Object) - Method in NpmExtension: Set local config file.

M

N

NAME - Field in NodeJSExtension
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
nodeExecutable(Provider<File>) - Method in NpmExecSpec: Install a resolver to find the node executable.
NODEJS_DEFAULT - Field in NodeJSExtension: The default version of Node.js that will be used on a supported platform if nothing else is configured.
NodeJSBasePlugin - Class in org.ysb33r.gradle.nodejs.plugins: Provide the basic capabilities for dealing with Node.js & NPM tasks.
NodeJSExecSpec - Class in org.ysb33r.gradle.nodejs: Execution specification for running a Node.js script.
NodeJSExecSpec(ProjectOperations) - 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.
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(Task, Class<? super NodeJSExtension>) - Constructor in NodeJSExtension: Constructs a new extension which is attached to the provided task.
NodeWrappers - Class in org.ysb33r.gradle.nodejs.tasks
NodeWrappers(TaskProvider<NodeBinariesCacheTask>) - Constructor in NodeWrappers
NPM_INSTALL - Field in NpmExecutor
NpmCmdlineTask - Class in org.ysb33r.gradle.nodejs.tasks: Providers a task for running npm with arguments.
NpmCmdlineTask() - Constructor in NpmCmdlineTask
npmConfigurations(Object) - Method in SyncProjectToPackageJson: 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.
NpmExecSpec - Class in org.ysb33r.gradle.nodejs: Specification for running an NPM command via npm-cli.js
NpmExecSpec(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(ProjectOperations, NodeJSExtension, NpmExtension, boolean) - Constructor in NpmExecutor: @param 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(Task, Class<? super NpmExtension>) - Constructor in NpmExtension: Constructs a new extension which is attached to the provided task.
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.
NpmPackageJsonInit - Class in org.ysb33r.gradle.nodejs.tasks: Create a package.json file if it does not exist.
NpmPackageJsonInit() - Constructor in NpmPackageJsonInit
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.
NpmPlugin - Class in org.ysb33r.gradle.nodejs.plugins: @since 0.1
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(ProjectOperations, NodeJSExtension, NpmExtension, Map<String, Object>) - Constructor in NpmSelfResolvingDependency: @param projectOperations
NpmTask - Class in org.ysb33r.gradle.nodejs.tasks: Ability to execute any NPM command with parameters.
NpmTask() - Constructor in NpmTask
NpxCmdlineTask - Class in org.ysb33r.gradle.nodejs.tasks: Providers a task for running npx with arguments.
NpxCmdlineTask() - Constructor in NpxCmdlineTask

O

of(String, String) - Method in PackageDescriptor
onlyNpmDependencyKeys(Map<String, Object>) - Method in NpmDependency: Extracts only the keys for NpmDependency that are valid.

P

PACKAGE_JSON - Field in SyncProjectToPackageJson
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
prefixPath(Provider<String>) - Method in NodeJSExtension: Add search to system path
PROPERTIES_FILENAME - Field in NodeBinariesCacheTask

Q

R

registerWatchPoints(Builder) - Method in NpmSelfResolvingDependency: @deprecated
requires(Iterable<String>) - Method in GulpExtension: Appends more require specifications.
resolve(boolean) - Method in NpmSelfResolvingDependency
runExecSpec(NodeJSExecSpec) - Method in AbstractNodeBaseTask: Executes a configured execution specification.
runExecutableAndReturnVersion() - Method in NodeJSExtension: Runs the executable and returns the version.
runExecutableAndReturnVersion() - Method in NpmExtension: Runs the executable and returns the version.
runNode(Project, NodeJSExecSpec) - Method in NodeJSExecutor: Runs Node.JS scripts given a fully-configured execution specification.
runNpm(Project, NpmExecSpec) - Method in NpmExecutor: Runs NPM given a fully-configured execution specification.

S

SCRIPT_TASK_PREFIX - Field in NpmDevPlugin
searchPath() - Method in NodeJSExtension: Use this to configure a system path search for Node
searchPath() - Method in NpmExtension: Use this to configure a system path search for npm
setAdditionalInstallArgs(Iterable<String>) - Method in NpmPackageJsonInstall: Replace list of arguments with a new list.
setArgs(List<Object>) - Method in AbstractCmdlineTask
setArgsLine(String) - Method in AbstractCmdlineTask
setCommand(Object) - Method in NpmScriptTask: Set the command to use.
setCommandProvider(Object) - Method in AbstractCmdlineTask
setEnvironment(Map<String, ?>) - Method in AbstractNodeBaseTask
setEnvironment(Map<String, ?>) - Method in NodeJSExtension: Replace current environment with new one.
setEnvironmentProvider(Provider<Map<String, Object>>) - Method in AbstractCmdlineTask
setGlobalConfig(Object) - Method in NpmExtension: Set global config file.
setGulpFile(Object) - Method in GulpExtension: Sets the location of gulpfile.js
setHomeDirectory(Object) - Method in NpmExtension: Sets the home directory.
setInstallGroup(NpmDependencyGroup) - Method in AbstractPackageWrappingExtension: Sets the installation group (production, development, optional).
setLocalConfig(Object) - Method in NpmExtension: Set local config file.
setNodeExecutable(Provider<File>) - Method in NpmExecSpec: Install a resolver to find the node executable.
setPackageJsonFile(Object) - Method in SyncProjectToPackageJson: Set the location of the package.json file
setPackageJsonName(Object) - Method in SyncProjectToPackageJson: Set the name for package.json file.
setPackageJsonVersion(Object) - Method in SyncProjectToPackageJson: Set the version for package.json file.
setRequires(Iterable<String>) - Method in GulpExtension: Replace any existing require specifications with a new one.
setTarget(String) - Method in GulpTask: Set the Gulp task to run.
setWorkingDir(Object) - Method in AbstractCmdlineTask
SimpleNpmPackageDescriptor - Class in org.ysb33r.gradle.nodejs: A simplistic NPM executable descriptor
SimpleNpmPackageDescriptor(String, String, String) - Constructor in SimpleNpmPackageDescriptor: @param scope Can be null
SyncProjectToPackageJson - Class in org.ysb33r.gradle.nodejs.tasks: Task that will sync the project version into the package.json file.
SyncProjectToPackageJson.PackageConflict - Enum in org.ysb33r.gradle.nodejs.tasks
SyncProjectToPackageJson() - Constructor in SyncProjectToPackageJson

T

TagBasedPackageResolver - Class in org.ysb33r.gradle.nodejs.pkgwrapper: A base class for creating resolvers for specific NPM packages.
TagBasedPackageResolver.EntryPoint - Interface in org.ysb33r.gradle.nodejs.pkgwrapper: Obtains the entry point for package.
TagBasedPackageResolver.InstallGroup - Interface in org.ysb33r.gradle.nodejs.pkgwrapper: Obtains the installation group for a package
toString() - Method in NpmDependency
toString() - Method in NpmPackageDescriptor: Returns a string that can be passed for installation purposes.
toString() - Method in PackageDescriptor
toString() - Method in SimpleNpmPackageDescriptor

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.
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 NpmExtension: Sets it to use the equivalent of getGradleHomeDir()/.npmrc.
useGlobalSystemLocation() - Method in NpmExtension: Tries to determine the location where global config will typically be places.
useLocalProjectLocation() - Method in NpmExtension: Use to indicate that userconfig should be retrieved from the NPM home directory as configured by getHomeDirectory().
useLocalUserProfileLocation() - Method in NpmExtension: Use to indicate that userconfig should be retrieved from the user's home directory.
useSystemPath() - Method in NodeJSExtension: Adds the system path to the execution environment.

V

VALID_KEYS - Field in NpmDependency

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.