Field Detail

• public static final boolean FORCE_NODE_DEFAULT_FOR_NPM

  Use this value to force the use of the bundled NPM rather than the version supplied by an NPM extension. This is used with createNpmExecSpec and in the constructor

  Since:

  0.12

• public static final java.lang.String NPM_INSTALL

Constructor Detail

• NpmExecutor(org.ysb33r.grolifant.api.core.ProjectOperations projectOperations, NodeJSExtension nodeJS, NpmExtension npm, boolean forceNodeDefaultForNpm = false )

  Parameters:

  projectOperations - Operations for the specific project context

  nodeJS - NodeJSExtension to use for resolving node location.

  npm - NpmExtension to use for resolving NPM-related activities.

  forceNodeDefaultForNpm - Whether to force the NPM to be used from the bundled NPM rather than the one supplied by the NPM extension. Default is to use the version supplied by the NPM extension.

  Since:

  0.10

Method Detail

• org.gradle.api.file.FileTree calculateInstallableFiles(java.io.File rootPackageJson)

  Returns a live set of installable files.

  This is an approximation. It parses the package.json file to discover dependencies, then recursively parses all other package.json files it find in those dependencies.

  Parameters:

  rootPackageJson - Initial package.json file to start traversal.

  Returns:

  Live file collection, meaning it is possible to add more executable directories. Returns null if no dependencies, optional dependencies or dev dependencies were found.

  Throws:

  GradleException if packageJson does not exist or is not in the npmExtension.homeDirectoryProperty.

  Since:

  0.10

• static org.ysb33r.gradle.nodejs.NpmExecSpec createNpmExecSpec(org.ysb33r.grolifant.api.core.ProjectOperations projectOperations, NodeJSExtension nodeJS, NpmExtension npm, boolean forceNodeDefaultForNpm = false )

  Creates a org.ysb33r.gradle.nodejs.NpmExecSpec with default node & npm-cli.js locations.

  Parameters:

  projectOperations - Grolifant ProjectOperations instance to attach to specification.

  nodeJS - Node extension

  npm - NPM extension

  forceNodeDefaultForNpm - Set to true to use the default NPM shipped with Node, rather than the configured NPM version.

  Returns:

  Execution specification.

• static org.ysb33r.gradle.nodejs.NpmExecSpec createNpmExecSpecWithDefaultEnvironment(org.ysb33r.grolifant.api.core.ProjectOperations projectOperations, NodeJSExtension nodeJS, NpmExtension npm, boolean forceNodeDefaultForNpm = false )

  Creates an org.ysb33r.gradle.nodejs.NpmExecSpec with default node & npm-cli.js locations and then configure an appropriate default environment.

  Parameters:

  projectOperations - Grolifant ProjectOperations instance to attach to specification.

  nodeJS - Node extension

  npm - NPM extension

  forceNodeDefaultForNpm - Set to true to use the default NPM shipped with Node, rather than the configured NPM version.

  Returns:

  Execution specification.

• static java.util.Map<java.lang.String, java.lang.Object> environmentFromExtensions(NodeJSExtension nodeJS, NpmExtension npm)

  Creates an environment based up on extensions.

  Parameters:

  nodeJS - NodeJSExtension.

  npm - NpmExtension.

  Returns:

  Environment*

  Since:

  0.10

• java.io.File getPackageInstallationFolder(NpmPackageDescriptor npmPackageDescriptor)

  Works out where the installation folder will be for a executable.

  Parameters:

  npmPackageDescriptor - Description of NPM executable

  Returns:

  The path where the executable will be installed to

  Since:

  0.10

• java.io.File initPkgJson(java.lang.String projectName, org.gradle.api.provider.Provider<java.lang.String> projectVersion)

  Creates a template package.json file.

  Parameters:

  projectName - Name of the project.

  projectVersion - Version/tag of the project.

  Returns:

  Location of the generated file.

  Since:

  0.10

• org.gradle.api.file.FileTree installNpmPackage(NpmPackageDescriptor npmPackageDescriptor, NpmDependencyGroup installGroup, java.lang.Iterable<java.lang.String> additionalArgs, java.util.Map<java.lang.String, java.lang.Object> additionalEnvironment = [:] )

  Installs an NPM executable by running npmExt install in a controlled environment.

  sa:

  https://docs.npmjs.com/cli/install

  Parameters:

  npmPackageDescriptor - Description of NPM executable.

  installGroup - Production, development of optional installation.

  additionalArgs - Any additional arguments that might be deemed necessary to customise the installation. This is here to provide flexibility as the author cannot foresee all common use cases. Should rarely be used. Should you find using this method regular occurrence it might be prudent to to raise an issue to ask to a feature update and explaining the context in which this is needed.

  additionalEnvironment - Additional environmental settings when installing. This can be used to set the system path variable if need be.

  Returns:

  List of files that were installed

  Since:

  0.10

• org.gradle.api.file.FileTree installPackagesFromDescription(java.io.File packageJson, java.lang.Iterable<java.lang.String> additionalArgs, boolean productionOnly = false )

  Installs packages from a package.json description.

  Parameters:

  packageJson - Path to a package.json file.

  additionalArgs - Additional arguments to be passed to NPM install command.

  productionOnly - Only install the production packages.

  Returns:

  org.gradle.api.file.FileTree with lists of files that were installed. Will also include files from packages that were already there, but which would have been installed otherwise.

  Throws:

  GradleException if packageJson does not exist or is not in the npmExtension.homeDirectoryProperty.

  Since:

  0.10

• org.gradle.process.ExecResult runNpm(org.ysb33r.gradle.nodejs.NpmExecSpec es)

  Runs NPM given a fully-configured execution specification.

  Parameters:

  es - Specification to execute

  Returns:

  Execution result

  Throws:

  May throw depending on whether execution specification was mal-configured or whether execution itself failed.

  Since:

  0.10