Index (singlular-node 1.2.0 API)

A C E G I L M N P R S U W Y
All Classes and Interfaces|All Packages|Constant Field Values

A

apply(Project) - Method in class com.brunoritz.gradle.singularnode.SingularNodePlugin
args(List<CharSequence>) - Method in class com.brunoritz.gradle.singularnode.platform.NodeCommand: Appends the given arguments to the potentially existing ones.
args(CharSequence...) - Method in class com.brunoritz.gradle.singularnode.platform.NodeCommand: Appends the given arguments to the potentially existing ones.

C

com.brunoritz.gradle.singularnode - package com.brunoritz.gradle.singularnode
com.brunoritz.gradle.singularnode.nodejs - package com.brunoritz.gradle.singularnode.nodejs
com.brunoritz.gradle.singularnode.npm - package com.brunoritz.gradle.singularnode.npm
com.brunoritz.gradle.singularnode.platform - package com.brunoritz.gradle.singularnode.platform
com.brunoritz.gradle.singularnode.platform.layout - package com.brunoritz.gradle.singularnode.platform.layout
com.brunoritz.gradle.singularnode.pnpm - package com.brunoritz.gradle.singularnode.pnpm
com.brunoritz.gradle.singularnode.yarn - package com.brunoritz.gradle.singularnode.yarn
configureNodeJsInstallation(Project) - Static method in class com.brunoritz.gradle.singularnode.nodejs.NodeJsSetup: Configures the project to support installing NodeJS.

E

execute() - Method in class com.brunoritz.gradle.singularnode.npm.NpmTask
execute() - Method in class com.brunoritz.gradle.singularnode.platform.NodeCommand: Executes the configured command.
execute() - Method in class com.brunoritz.gradle.singularnode.pnpm.PnpmTask
execute() - Method in class com.brunoritz.gradle.singularnode.yarn.YarnTask

G

getArgs() - Method in class com.brunoritz.gradle.singularnode.npm.InstallNpmPackagesTask: Optional arguments to pass to the package installation command.
getArgs() - Method in class com.brunoritz.gradle.singularnode.npm.NpmTask
getArgs() - Method in class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmPackagesTask: Optional arguments to pass to the package installation command.
getArgs() - Method in class com.brunoritz.gradle.singularnode.pnpm.PnpmTask
getArgs() - Method in class com.brunoritz.gradle.singularnode.yarn.InstallYarnPackagesTask: Optional arguments to pass to the package installation command.
getArgs() - Method in class com.brunoritz.gradle.singularnode.yarn.YarnTask
getEnvironment() - Method in class com.brunoritz.gradle.singularnode.npm.NpmTask
getEnvironment() - Method in class com.brunoritz.gradle.singularnode.pnpm.PnpmTask
getEnvironment() - Method in class com.brunoritz.gradle.singularnode.yarn.YarnTask
getExecutionMarkerFile() - Method in class com.brunoritz.gradle.singularnode.npm.InstallNpmPackagesTask: The execution marker file indicates that this task was executed.
getExecutionMarkerFile() - Method in class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmPackagesTask: The execution marker file indicates that this task was executed.
getExecutionMarkerFile() - Method in class com.brunoritz.gradle.singularnode.yarn.InstallYarnPackagesTask: The execution marker file indicates that this task was executed.
getInstallationLayout() - Method in class com.brunoritz.gradle.singularnode.nodejs.InstallNodeJsTask
getInstallationLayout() - Method in class com.brunoritz.gradle.singularnode.npm.InstallNpmPackagesTask
getInstallationLayout() - Method in class com.brunoritz.gradle.singularnode.npm.InstallNpmTask
getInstallationLayout() - Method in class com.brunoritz.gradle.singularnode.npm.NpmTask
getInstallationLayout() - Method in class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmPackagesTask
getInstallationLayout() - Method in class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmTask
getInstallationLayout() - Method in class com.brunoritz.gradle.singularnode.pnpm.PnpmTask
getInstallationLayout() - Method in class com.brunoritz.gradle.singularnode.yarn.InstallYarnPackagesTask
getInstallationLayout() - Method in class com.brunoritz.gradle.singularnode.yarn.InstallYarnTask
getInstallationLayout() - Method in class com.brunoritz.gradle.singularnode.yarn.YarnTask
getInstallBaseDir() - Method in class com.brunoritz.gradle.singularnode.npm.NpmTask
getInstallBaseDir() - Method in class com.brunoritz.gradle.singularnode.pnpm.PnpmTask
getInstallBaseDir() - Method in class com.brunoritz.gradle.singularnode.yarn.YarnTask
getNodeArchive() - Method in class com.brunoritz.gradle.singularnode.nodejs.InstallNodeJsTask
getNodeJsInstallDir() - Method in class com.brunoritz.gradle.singularnode.nodejs.InstallNodeJsTask
getNpmInstallDirectory() - Method in class com.brunoritz.gradle.singularnode.npm.InstallNpmTask
getNpmVersion() - Method in class com.brunoritz.gradle.singularnode.npm.InstallNpmTask
getPackageFile() - Method in class com.brunoritz.gradle.singularnode.npm.InstallNpmPackagesTask
getPackageFile() - Method in class com.brunoritz.gradle.singularnode.npm.NpmTask
getPackageFile() - Method in class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmPackagesTask
getPackageFile() - Method in class com.brunoritz.gradle.singularnode.pnpm.PnpmTask
getPackageFile() - Method in class com.brunoritz.gradle.singularnode.yarn.InstallYarnPackagesTask
getPackageFile() - Method in class com.brunoritz.gradle.singularnode.yarn.YarnTask
getPackageLockFile() - Method in class com.brunoritz.gradle.singularnode.npm.InstallNpmPackagesTask
getPackageLockFile() - Method in class com.brunoritz.gradle.singularnode.npm.NpmTask
getPackageLockFile() - Method in class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmPackagesTask
getPackageLockFile() - Method in class com.brunoritz.gradle.singularnode.pnpm.PnpmTask
getPackageLockFile() - Method in class com.brunoritz.gradle.singularnode.yarn.InstallYarnPackagesTask
getPackageLockFile() - Method in class com.brunoritz.gradle.singularnode.yarn.YarnTask
getPnpmInstallDirectory() - Method in class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmTask
getPnpmVersion() - Method in class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmTask
getWorkingDirectory() - Method in class com.brunoritz.gradle.singularnode.npm.InstallNpmPackagesTask
getWorkingDirectory() - Method in class com.brunoritz.gradle.singularnode.npm.InstallNpmTask
getWorkingDirectory() - Method in class com.brunoritz.gradle.singularnode.npm.NpmTask
getWorkingDirectory() - Method in class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmPackagesTask
getWorkingDirectory() - Method in class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmTask
getWorkingDirectory() - Method in class com.brunoritz.gradle.singularnode.pnpm.PnpmTask
getWorkingDirectory() - Method in class com.brunoritz.gradle.singularnode.yarn.InstallYarnPackagesTask
getWorkingDirectory() - Method in class com.brunoritz.gradle.singularnode.yarn.InstallYarnTask
getWorkingDirectory() - Method in class com.brunoritz.gradle.singularnode.yarn.YarnTask
getYarnInstallDirectory() - Method in class com.brunoritz.gradle.singularnode.yarn.InstallYarnTask
getYarnVersion() - Method in class com.brunoritz.gradle.singularnode.yarn.InstallYarnTask
GROUP - Static variable in class com.brunoritz.gradle.singularnode.yarn.YarnSetup

I

InstallationLayout - Class in com.brunoritz.gradle.singularnode.platform.layout: Represents all relevant directories and binaries needed by the plugin.
InstallationLayout(DirectoryProperty) - Constructor for class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout
InstallationLayoutFactory - Class in com.brunoritz.gradle.singularnode.platform.layout: A factory that produces environment dependent installation layouts.
installBaseDir - Variable in class com.brunoritz.gradle.singularnode.NodeJsExtension: The directory into wich to install NodeJS and Yarn.
installNode() - Method in class com.brunoritz.gradle.singularnode.nodejs.InstallNodeJsTask
InstallNodeJsTask - Class in com.brunoritz.gradle.singularnode.nodejs: Installs the requested version of NodeJS into the installation directory.
InstallNodeJsTask(FileSystemOperations, ArchiveOperations) - Constructor for class com.brunoritz.gradle.singularnode.nodejs.InstallNodeJsTask
installNpm() - Method in class com.brunoritz.gradle.singularnode.npm.InstallNpmTask
InstallNpmPackagesTask - Class in com.brunoritz.gradle.singularnode.npm: Installs packages declared in the package.json file.
InstallNpmPackagesTask(ExecOperations, Project) - Constructor for class com.brunoritz.gradle.singularnode.npm.InstallNpmPackagesTask
InstallNpmTask - Class in com.brunoritz.gradle.singularnode.npm: Installs the requested version of NPM into the installation directory.
InstallNpmTask(FileSystemOperations, ExecOperations) - Constructor for class com.brunoritz.gradle.singularnode.npm.InstallNpmTask
installPackages() - Method in class com.brunoritz.gradle.singularnode.npm.InstallNpmPackagesTask
installPackages() - Method in class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmPackagesTask
installPackages() - Method in class com.brunoritz.gradle.singularnode.yarn.InstallYarnPackagesTask
installPnpm() - Method in class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmTask
InstallPnpmPackagesTask - Class in com.brunoritz.gradle.singularnode.pnpm: Installs packages declared in the package.json file.
InstallPnpmPackagesTask(ExecOperations, Project) - Constructor for class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmPackagesTask
InstallPnpmTask - Class in com.brunoritz.gradle.singularnode.pnpm: Installs the requested version of PNPM into the installation directory.
InstallPnpmTask(FileSystemOperations, ExecOperations) - Constructor for class com.brunoritz.gradle.singularnode.pnpm.InstallPnpmTask
installYarn() - Method in class com.brunoritz.gradle.singularnode.yarn.InstallYarnTask
InstallYarnPackagesTask - Class in com.brunoritz.gradle.singularnode.yarn: Installs packages declared in the package.json file.
InstallYarnPackagesTask(ExecOperations, Project) - Constructor for class com.brunoritz.gradle.singularnode.yarn.InstallYarnPackagesTask
InstallYarnTask - Class in com.brunoritz.gradle.singularnode.yarn: Installs the requested version of Yarn into the installation directory.
InstallYarnTask(FileSystemOperations, ExecOperations) - Constructor for class com.brunoritz.gradle.singularnode.yarn.InstallYarnTask

L

Lookup - Class in com.brunoritz.gradle.singularnode.platform: Utility methods to lookup configuration and tasks related to the NodeJS plugin.
Lookup() - Constructor for class com.brunoritz.gradle.singularnode.platform.Lookup

M

ManagedNodeJs - Class in com.brunoritz.gradle.singularnode: Provides information about the managed tooling installation to the build processs.
ManagedNodeJs(InstallationLayout) - Constructor for class com.brunoritz.gradle.singularnode.ManagedNodeJs

N

NodeCommand - Class in com.brunoritz.gradle.singularnode.platform: Utility to create NodeJS invocations.
NodeCommand(ExecOperations, File, InstallationLayout) - Constructor for class com.brunoritz.gradle.singularnode.platform.NodeCommand
nodeDownloadBase - Variable in class com.brunoritz.gradle.singularnode.NodeJsExtension: The URL from which to download NodeJS.
nodeJsBinDir - Variable in class com.brunoritz.gradle.singularnode.ManagedNodeJs: The direcotry in which the NodeJS executable binary is stored.
nodeJsBinDirectory() - Method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout: Returns the directory containing the NodeJS executable.
nodeJsBinDirectory() - Method in class com.brunoritz.gradle.singularnode.platform.layout.UnixInstallationLayout
nodeJsBinDirectory() - Method in class com.brunoritz.gradle.singularnode.platform.layout.WindowsInstallationLayout
nodeJsExecutable - Variable in class com.brunoritz.gradle.singularnode.ManagedNodeJs: The path to the installed NodeJS executable.
NodeJsExtension - Class in com.brunoritz.gradle.singularnode: Allows the root project to configure the details of the tooling to be installed.
NodeJsExtension(Project) - Constructor for class com.brunoritz.gradle.singularnode.NodeJsExtension
nodeJsInstallDir() - Method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout: Returns the directory within which NodeJS is installed.
NodeJsSetup - Class in com.brunoritz.gradle.singularnode.nodejs: Configures all tasks, repositories and dependencies required for installing NodeJS locally.
nodeVersion - Variable in class com.brunoritz.gradle.singularnode.NodeJsExtension: The version of NodeJS to be installed.
npmInstallArgs - Variable in class com.brunoritz.gradle.singularnode.NodeJsExtension: Arguments to pass to NPM when installing packages.
npmInstallDirectory() - Method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout: Returns the directory whiin which the managed version of NPM is installed.
npmScript - Variable in class com.brunoritz.gradle.singularnode.ManagedNodeJs: The path to the managed NPM script.
NpmSetup - Class in com.brunoritz.gradle.singularnode.npm: Configures all required tasks and properties for the NPM package manager.
NpmTask - Class in com.brunoritz.gradle.singularnode.npm: The task type for defining custon NPM tasks to execute.
NpmTask(ExecOperations, Project) - Constructor for class com.brunoritz.gradle.singularnode.npm.NpmTask
npmVersion - Variable in class com.brunoritz.gradle.singularnode.NodeJsExtension: The version of NPM to be installed.

P

pathOfBundledCliScript(String) - Method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout: Returns the full path of a bundled NPM CLI script.
pathOfBundledCliScript(String) - Method in class com.brunoritz.gradle.singularnode.platform.layout.UnixInstallationLayout
pathOfBundledCliScript(String) - Method in class com.brunoritz.gradle.singularnode.platform.layout.WindowsInstallationLayout
pathOfBundledNpmScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout: Returns the full path to the bundled NPM script.
pathOfBundledNpmScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.UnixInstallationLayout
pathOfBundledNpmScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.WindowsInstallationLayout
pathOfBundnledNpxScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout: Returns the full path to the bundled NPX script.
pathOfBundnledNpxScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.UnixInstallationLayout
pathOfBundnledNpxScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.WindowsInstallationLayout
pathOfManagedNpmScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout: Returns the full path to the NPM installation managed by this plugin.
pathOfManagedNpmScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.UnixInstallationLayout
pathOfManagedNpmScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.WindowsInstallationLayout
pathOfManagedPnpmScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout: Returns the full path to the PNPM installation managed by this plugin.
pathOfManagedPnpmScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.UnixInstallationLayout
pathOfManagedPnpmScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.WindowsInstallationLayout
pathOfManagedYarnScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout: Returns the full path to the Yarn installation managed by this plugin.
pathOfManagedYarnScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.UnixInstallationLayout
pathOfManagedYarnScript() - Method in class com.brunoritz.gradle.singularnode.platform.layout.WindowsInstallationLayout
pathOfNodeExecutable() - Method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout: Returns the full path of the executable representing the NodeJS engine.
pathOfNodeExecutable() - Method in class com.brunoritz.gradle.singularnode.platform.layout.UnixInstallationLayout
pathOfNodeExecutable() - Method in class com.brunoritz.gradle.singularnode.platform.layout.WindowsInstallationLayout
platformDependentLayout(DirectoryProperty) - Static method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayoutFactory: Creates a new installation layout starting at the given installation base directoy.
pluginConfiguration(Project) - Static method in class com.brunoritz.gradle.singularnode.platform.Lookup: Returns the configuration extension for this plugin.
pnpmInstallArgs - Variable in class com.brunoritz.gradle.singularnode.NodeJsExtension: Arguments to pass to PNPM when installing packages.
pnpmInstallDirectory() - Method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout: Returns the directory within which the managed version of PNPM is installed.
pnpmScript - Variable in class com.brunoritz.gradle.singularnode.ManagedNodeJs: The path to the managed PNPM script.
PnpmSetup - Class in com.brunoritz.gradle.singularnode.pnpm: Configures all required tasks and properties for the PNPM package manager.
PnpmTask - Class in com.brunoritz.gradle.singularnode.pnpm: The task type for defining custon PNPM tasks to execute.
PnpmTask(ExecOperations, Project) - Constructor for class com.brunoritz.gradle.singularnode.pnpm.PnpmTask
pnpmVersion - Variable in class com.brunoritz.gradle.singularnode.NodeJsExtension: The version of PNPM to be installed.

R

rootProjectTask(Project, String) - Static method in class com.brunoritz.gradle.singularnode.platform.Lookup: Returns an task from the root project by its name.

S

setupChildTasks(Project) - Static method in class com.brunoritz.gradle.singularnode.npm.NpmSetup: Configures the tasks for any subproject using this plugin.
setupChildTasks(Project) - Static method in class com.brunoritz.gradle.singularnode.pnpm.PnpmSetup: Configures the tasks for any subproject using this plugin.
setupChildTasks(Project) - Static method in class com.brunoritz.gradle.singularnode.yarn.YarnSetup: Configures the tasks for any subproject using this plugin.
setupRootTasks(Project, TaskProvider<InstallNodeJsTask>) - Static method in class com.brunoritz.gradle.singularnode.npm.NpmSetup: Configures the tasks needed to install the NPM package manager on the root project.
setupRootTasks(Project, TaskProvider<InstallNodeJsTask>) - Static method in class com.brunoritz.gradle.singularnode.pnpm.PnpmSetup: Configures the tasks needed to install the PNPM package manager on the root project.
setupRootTasks(Project, TaskProvider<InstallNodeJsTask>) - Static method in class com.brunoritz.gradle.singularnode.yarn.YarnSetup: Configures the tasks needed to install the Yarn package manager on the root project.
SingularNodePlugin - Class in com.brunoritz.gradle.singularnode: The Singular Node Installation plugin provides a single NodeJS/NPM/Yarn/PNPM installation throughout the entire project.
SingularNodePlugin() - Constructor for class com.brunoritz.gradle.singularnode.SingularNodePlugin

U

UnixInstallationLayout - Class in com.brunoritz.gradle.singularnode.platform.layout: The installation layout for Unix and compabible systems (macOs, Linux).

W

WindowsInstallationLayout - Class in com.brunoritz.gradle.singularnode.platform.layout: The installation layout for Windows systems.
withEnvironment(Map<CharSequence, CharSequence>) - Method in class com.brunoritz.gradle.singularnode.platform.NodeCommand: Appends environment variables to the command.

Y

yarnInstallArgs - Variable in class com.brunoritz.gradle.singularnode.NodeJsExtension: Arguments to pass to Yarn when installing packages.
yarnInstallDirectory() - Method in class com.brunoritz.gradle.singularnode.platform.layout.InstallationLayout: Returns the directory whiin which the managed version of Yarn is installed.
yarnScript - Variable in class com.brunoritz.gradle.singularnode.ManagedNodeJs: The path to the managed Yarn script.
YarnSetup - Class in com.brunoritz.gradle.singularnode.yarn: Configures all required tasks and properties for the Yarn package manager.
YarnTask - Class in com.brunoritz.gradle.singularnode.yarn: The task type for defining custon Yarn tasks to execute.
YarnTask(ExecOperations, Project) - Constructor for class com.brunoritz.gradle.singularnode.yarn.YarnTask
yarnVersion - Variable in class com.brunoritz.gradle.singularnode.NodeJsExtension: The version of Yarn to be installed.

A C E G I L M N P R S U W Y
All Classes and Interfaces|All Packages|Constant Field Values