Method Detail

• public NpmExecSpec createExecSpec()

  Create execution specification.

  Returns:

  Execution specification.

• public void executableIsBundled()

  Use the NPM that is bundled with Node.

  This is the default and should rarely be required.

• public File getGlobalConfig()

  Location and name of global NPM config file. When this extension is attached to a project, the default location is set to "${project.gradle.gradleUserHomeDir/npmrc"}

  Returns:

  File object pointing to global NPM config

• public File getHomeDirectory()

  The NPM home directory - the parent directory of node_modules,

  Returns:

  Parent directory of node_modules. Never null if the extension is tied to a project, in which case it defaults to project.projectDir.

• public File getLocalConfig()

  Location and name of local NPM config file. When this extension is attached to a project, the default location is set to "${project.rootProject.projectDir/npmrc"}

  Returns:

  File object pointing to local NPM config

• public Provider<File> getProjectConfig()

  Location of .npmrc for a project.

  Returns:

  Project config level.

• public void globalConfig(Object path)

  Sets global config file.

  Parameters:

  path - Anything that can be converted using project.file.

• public void homeDirectory(Object homeDir)

  Sets the home directory.

  Parameters:

  homeDir - A directory in which node_modules will be created as a child folder. Anything that can be resolved with project.file is acceptable

• public void localConfig(Object path)

  Sets local config file.

  Parameters:

  path - Anything that can be converted using project.file.

• public void setGlobalConfig(Object path)

  Sets global config file.

  Parameters:

  path - Anything that can be converted using project.file.

• public void setHomeDirectory(Object homeDir)

  Sets the home directory.

  Parameters:

  homeDir - A directory in which node_modules will be created as a child folder. Anything that can be resolved with project.file is acceptable

• public void setLocalConfig(Object path)

  Sets local config file.

  Parameters:

  path - Anything that can be converted using project.file.

• public Provider<File> useGlobalGradleLocation()

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

  This allows Gradle projects to be custom configured on local system without being affected by any system-wide node installations.

  Returns:

  Location of a global configuration file for NPM that is located inside the Gradle home directory.

• public Provider<File> useGlobalSystemLocation()

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

  Returns:

  A provider to a system location.

• public Provider<File> useLocalProjectLocation()

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

  Returns:

  Location for a userconfig .npmrc

• public Provider<File> useLocalUserProfileLocation()

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

  Typically, this is ~/.npmrc or %APPDATA\npm\.npmrc

  Returns:

  Location for a userconfig .npmrc

• public void usePackageJsonVersionAsProjectVersion()

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

  If package.json does not exist, then undefined is used as the version.