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

org.ysb33r.gradle.nodejs.BaseNpmExtension

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

@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
class BaseNpmExtension<T extends BaseNodeJSExtension<T>, S extends BaseNpmExtension<T, S>>
extends org.ysb33r.grolifant5.api.core.runnable.AbstractToolExtension<S>
implements NpmExtensionMethods, org.ysb33r.grolifant5.api.core.runnable.ProvisionedExecMethods<NpmExecSpec>

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

Since:: 2.1

Properties Summary

Properties
Type	Name and description
`org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations`	`configCacheSafeOperations`
`File`	`globalConfig`
`File`	`homeDirectory`
`File`	`localConfig`

Constructor Summary

Constructors
Constructor and description
`protected BaseNpmExtension (Project project, T nodejs)` Adds the extension to the project.
`protected BaseNpmExtension (Task task, T nodejs, S altNpmExt)` Adds the extension to a NpmTask task.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`NpmExecSpec`	`createExecSpec()` Create execution specification.
	`void`	`executableIsBundled()` Use the NPM that is bundled with Node.
	`protected org.ysb33r.grolifant5.api.core.downloader.ExecutableDownloader`	`getDownloader()` Gets the downloader implementation.
	`File`	`getGlobalConfig()` Location & name of global NPM config file.
	`Provider<File>`	`getGlobalConfigProvider()` Location & name of global NPM config file.
	`File`	`getHomeDirectory()` The NPM home directory - the parent directory of `node_modules`,
	`Provider<File>`	`getHomeDirectoryProvider()` The NPM home directory - the parent directory of `node_modules`,
	`File`	`getLocalConfig()` Location & name of local NPM config file.
	`Provider<File>`	`getLocalConfigProvider()` Location & name of local NPM config file.
	`protected String`	`getNodeJsExtensionName()` Returns the name of the extension to look for when trying to find the Node.js extension.
	`protected String`	`getNpmProjectExtensionName()` Returns the name of the extension to look for when trying to find the Npm extension.
	`Provider<File>`	`getNpxCliJsProvider()` The location of NPX.
	`Provider<File>`	`getProjectConfig()` Location of `.npmrc` for a project.
	`Provider<File>`	`getProjectConfigProvider()`
	`Provider<String>`	`getVersionProvider()` Provides the version as specified in `package.json`.
	`void`	`globalConfig(Object path)` Set global config file.
	`void`	`homeDirectory(Object homeDir)` Sets the home directory.
	`void`	`localConfig(Object path)` Set local config file.
	`protected String`	`runExecutableAndReturnVersion()` Runs the executable and returns the version.
	`void`	`setGlobalConfig(Object path)` Set global config file.
	`void`	`setHomeDirectory(Object homeDir)` Sets the home directory.
	`void`	`setLocalConfig(Object path)` Set local config file.
	`Provider<File>`	`useGlobalGradleLocation()` Sets it to use the equivalent of `getGradleHomeDir()/.npmrc`.
	`Provider<File>`	`useGlobalSystemLocation()` Tries to determine the location where global config will typically be places.
	`Provider<File>`	`useLocalProjectLocation()` Use to indicate that userconfig should be retrieved from the NPM home directory as configured by getHomeDirectory().
	`Provider<File>`	`useLocalUserProfileLocation()` Use to indicate that userconfig should be retrieved from the user's home directory.
	`void`	`usePackageJsonVersionAsProjectVersion()` Use the version specified in `package.json` as the version of the project.

- Property Detail
  - final org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations configCacheSafeOperations
  - File globalConfig
  - File homeDirectory
  - File localConfig
- Constructor Detail
  - protected BaseNpmExtension(Project project, T nodejs)
    
    Adds the extension to the project.
    Parameters:
    project - Project to link to.
    nodejs - NodeJS extension to use.
    Since:
    0.10
  - protected BaseNpmExtension(Task task, T nodejs, S altNpmExt)
    
    Adds the extension to a NpmTask task.
    Links the executable resolving to the global instance, but allows it to be overridden on a per-task basis.
    Parameters:
    task - Task to be extended.
    nodejs - Alternative NodeJS extension to use as project extension.
    altNpmExt - Alternative Npm extension to use as project extension.
    Since:
    0.10
- Method Detail
  - @Override NpmExecSpec createExecSpec()
    
    Create execution specification.
    Returns:
    Execution specification.
    Since:
    0.10
  - void executableIsBundled()
    
    Use the NPM that is bundled with Node. This is the default and should rarely be required.
    Since:
    0.12
  - @Override protected org.ysb33r.grolifant5.api.core.downloader.ExecutableDownloader getDownloader()
    
    Gets the downloader implementation. Can throw an exception if downloading is not supported.
    Returns:
    A downloader that can be used to retrieve an executable.
    Since:
    0.10
  - @Deprecated File getGlobalConfig()
    
    Location & name of global NPM config file. When this extension is attached to a project, the default location is set to "${project.gradle.gradleUserHomeDir/npmrc"}
    deprecated:
    Use getGlobalConfigProvider instead.
    
    Returns:
    File object pointing to global NPM config
  - @Override Provider<File> getGlobalConfigProvider()
    
    Location & 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:
    Provider to the global NPM config location for Gradle.
    Since:
    3.0
  - @Deprecated File getHomeDirectory()
    
    The NPM home directory - the parent directory of node_modules,
    deprecated:
    Use getHomeDirectoryProvider instead.
    
    Returns:
    Parent directory of node_modules. Never null if the extension is tied to a project, in which case it defaults to project.projectDir.
  - Provider<File> getHomeDirectoryProvider()
    
    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.
    Since:
    0.8.0
  - @Deprecated File getLocalConfig()
    
    Location & name of local NPM config file. When this extension is attached to a project, the default location is set to "${project.rootProject.projectDir/npmrc"}
    deprecated:
    Use getLocalConfigProvider instead
    
    Returns:
    File object pointing to local NPM config
  - @Override Provider<File> getLocalConfigProvider()
    
    Location & 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:
    Provider to local NPM config
  - protected String getNodeJsExtensionName()
    
    Returns the name of the extension to look for when trying to find the Node.js extension.
    Returns:
    Name of Node.js project extension
    Since:
    0.4
  - protected String getNpmProjectExtensionName()
    
    Returns the name of the extension to look for when trying to find the Npm extension.
    Returns:
    Name of NPM project extension or (@code null) if this a project extension.
    Since:
    0.4
  - Provider<File> getNpxCliJsProvider()
    
    The location of NPX.
    Returns:
    A provider to the location of NPX
    Since:
    0.10
  - Provider<File> getProjectConfig()
    
    Location of .npmrc for a project.
    Returns:
    Project config level.
  - @Override Provider<File> getProjectConfigProvider()
  - Provider<String> getVersionProvider()
    
    Provides the version as specified in package.json.
    Returns:
    Version provider.
    Since:
    2.0
  - @Deprecated void globalConfig(Object path)
    
    Set global config file.
    deprecated:
    Use setGlobalConfig
    
    Parameters:
    path - Anything that can be converted using project.file.
  - @Deprecated void homeDirectory(Object homeDir)
    
    Sets the home directory.
    deprecated:
    Use setHomeDirectory instead
    
    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
  - void localConfig(Object path)
    
    Set local config file.
    Parameters:
    path - Anything that can be converted using project.file.
  - @Override protected String runExecutableAndReturnVersion()
    
    Runs the executable and returns the version. See org.ysb33r.grolifant5.internal.core.executable.ExecUtils#parseVersionFromOutput as a helper to implement this method.
    throws:
    ConfigurationException if configuration is not correct or version could not be determined.
    
    Returns:
    Version string.
    Since:
    0.10
  - void setGlobalConfig(Object path)
    
    Set global config file.
    Parameters:
    path - Anything that can be converted using project.file.
  - 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
  - void setLocalConfig(Object path)
    
    Set local config file.
    Parameters:
    path - Anything that can be converted using project.file.
  - 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.
    Since:
    0.12
  - Provider<File> useGlobalSystemLocation()
    
    Tries to determine the location where global config will typically be places.
    Returns:
    A provider to a system location.
    Since:
    0.12
  - 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
    Since:
    0.12
  - 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
    Since:
    0.12
  - 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.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class BaseNpmExtension<T extends BaseNodeJSExtension<T>, S extends BaseNpmExtension<T, S>>

Properties Summary

Constructor Summary

Methods Summary

Property Detail

final org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations configCacheSafeOperations

File globalConfig

File homeDirectory

File localConfig

Constructor Detail

protected BaseNpmExtension(Project project, T nodejs)

protected BaseNpmExtension(Task task, T nodejs, S altNpmExt)

Method Detail

@Override NpmExecSpec createExecSpec()

void executableIsBundled()

@Override protected org.ysb33r.grolifant5.api.core.downloader.ExecutableDownloader getDownloader()

@Deprecated File getGlobalConfig()

@Override Provider<File> getGlobalConfigProvider()

@Deprecated File getHomeDirectory()

Provider<File> getHomeDirectoryProvider()

@Deprecated File getLocalConfig()

@Override Provider<File> getLocalConfigProvider()

protected String getNodeJsExtensionName()

protected String getNpmProjectExtensionName()

Provider<File> getNpxCliJsProvider()

Provider<File> getProjectConfig()

@Override Provider<File> getProjectConfigProvider()

Provider<String> getVersionProvider()

@Deprecated void globalConfig(Object path)

@Deprecated void homeDirectory(Object homeDir)

void localConfig(Object path)

@Override protected String runExecutableAndReturnVersion()

void setGlobalConfig(Object path)

void setHomeDirectory(Object homeDir)

void setLocalConfig(Object path)

Provider<File> useGlobalGradleLocation()

Provider<File> useGlobalSystemLocation()

Provider<File> useLocalProjectLocation()

Provider<File> useLocalUserProfileLocation()

void usePackageJsonVersionAsProjectVersion()