Field Detail

• protected final java.util.concurrent.Callable<NpmExtensionMethods> locateNpm

Property Detail

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

• java.util.Map<String, ?> environment

Constructor Detail

• protected BaseNodeJSExtension(Project project)

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

  Parameters:

  project - Project this extension is associated with.

• protected BaseNodeJSExtension(Task task, T alternativeProjectExt)

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

  Parameters:

  project - Project this extension is associated with.

  alternativeProjectExt - Alternative extension to use, rather than the default project extension

• protected BaseNodeJSExtension(Task task, String projectExtName)

  Constructs a new extension which is attached to the provided task. This is meant for other plugins that want to provide their own NodeJSExtension implementation

  Parameters:

  project - Project this extension is associated with.

  projectExtName - Name of the extension that is attached to the project.

  Since:

  0.4

• protected BaseNodeJSExtension(Task task, java.util.concurrent.Callable<T> extClass)

  Constructs a new extension which is attached to the provided task. This is meant for other plugins that want to provide their own NodeJSExtension implementation

  Parameters:

  project - Project this extension is associated with.

  extClass - A function object that will return an extension that is attached to the project.

  Since:

  3.0

Method Detail

• void appendPath(Provider<String> postfix)

  Add search to system path. In the case of a task this will be appended to both the task and project extension's version of the system path.

  Parameters:

  postfix - Provider of a path item that can be appended to the current system path.

  Since:

  0.9.2

• void environment(java.util.Map<String, ?> args)

  Add environmental variables to be passed to the exe.

  Parameters:

  args - Environmental variable key-value map.

  Since:

  0.7

• @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

• java.util.Map<String, String> getEnvironment()

  Environment for running the exe

  Calling this will resolve all lazy-values in the variable map.

  Returns:

  Map of environmental variables that will be passed.

  Since:

  0.7

• @Override Provider<java.util.Map<String, String>> getEnvironmentProvider()

• Provider<File> getNpmCliJsProvider()

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

  Returns:

  Returns the path to the located npm executable.

  Throws:

  ExecConfigurationException if executable was not configured.

  Since:

  0.10

• void prefixPath(Provider<String> prefix)

  Add search to system path

  In the case of a task this will be prefixed to both the task and project extension's version of the system path.

  Prefixes are in reversed other - the last prefix added will be the first in the path list.

  Parameters:

  prefix - Provider of a path item that can be prefixed to the current system path.

  Since:

  0.9.2

• @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:

  org.ysb33r.grolifant5.api.errors.ConfigurationException if configuration is not correct or version could not be determined.

  Returns:

  Version string.

  Since:

  0.10

• void setEnvironment(java.util.Map<String, ?> args)

  Replace current environment with new one. If this is called on the task extension, no project extension environment will be used.

  Parameters:

  args - New environment key-value map of properties.

  Since:

  0.7

• void useSystemPath()

  Adds the system path to the execution environment.

  Since:

  0.7