Class NpmExecutor

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.ext.nodejs.NpmExecutor

All Implemented Interfaces:

Renamable, RequiredResourceSupport, ResourceProvider

public class NpmExecutor
extends AbstractProvider
implements Renamable, RequiredResourceSupport

A provider for execution results from invoking npm. The provider generates resources in response to requests for ExecResult where the request's ResourceRequest.name() matches this provider's name.

• The working directory is the project directory.

• The provider first checks if a file package.json exists, else it fails. If no directory node_modules exists or package.json is newer than node_modules/.package-lock.json it invokes npm init.

• Then, the provider retrieves all resources added by required(Stream). While the provider itself does not process these resources, it is assumed that they are processed by the npm command and therefore need to be available.

• If no arguments were specified, the provider returns an ExecResult that indicates successful invocation. The date of the result is set to the date of node_modules/.package-lock.json.

• The provider invokes the function configured with output(Function) and collects all resources. If the generated resources exist and no resource from required is newer then the generated resources found, the provider returns a result that indicates successful invocation. The date of the result is set to the newest date from the generated resources and the (existing) resources are attached.

• Else, the provider invokes npm, calls the function set with provided again and adds the result to the ExecResult that it returns.

The provider also uses the function set with output(Function) to determine the resources to be removed when it is invoked with a request for Cleanliness.

The generated resources can also be provided directly in response to a request, see provideResources(ResourceRequest).

This provider is made available as an extension.

Constructor Summary

Constructors

Constructor	Description
NpmExecutor(Project project)	Initializes a new NPM executor.

Method Summary

Modifier and Type	Method	Description
NpmExecutor	args(String... args)	Add the given arguments.
protected <T extends Resource> Collection<T>	doProvide(ResourceRequest<T> request)	Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.
NpmExecutor	name(String name)	Name.
NpmExecutor	nodeJsVersion(String version)	Sets the node.js version to use.
NpmExecutor	output(Function<Project, Stream<Resource>> resources)	Sets the function used to determine the resources generated by this provider.
Project	project()	Returns the project that this provider belongs to.
NpmExecutor	provideResources(ResourceRequest<?> proto)	Provide the generated resources in response to a request like the given one.
NpmExecutor	required(Path root)	Convenience method that adds a FileResource to the required resources.
NpmExecutor	required(Path root, String pattern)	Convenience method that adds a FileTree to the required resources.
NpmExecutor	required(Stream<? extends Resource> resources)	Adds the given Stream of resources to the required resources.
String	toString()	To string.

Methods inherited from class AbstractProvider

context, name, of, rename, vavrStream

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ResourceProvider

context, name, of, resources

Constructor Details

NpmExecutor

public NpmExecutor(Project project)

Initializes a new NPM executor.

Parameters:

project - the project

Method Details

project

public Project project()

Returns the project that this provider belongs to.

Returns:

the project

name

public NpmExecutor name(String name)

Name.

Specified by:

name in interface Renamable

Parameters:

name - the name

Returns:

the npm executor

nodeJsVersion

public NpmExecutor nodeJsVersion(String version)

Sets the node.js version to use. Setting a version is mandatory.

Parameters:

version - the version

Returns:

the npm executor

args

public NpmExecutor args(String... args)

Add the given arguments.

Parameters:

args - the arguments

Returns:

the npm executor

required

public NpmExecutor required(Stream<? extends Resource> resources)

Description copied from interface: RequiredResourceSupport

Adds the given Stream of resources to the required resources.

Specified by:

required in interface RequiredResourceSupport

Parameters:

resources - the resources

Returns:

the provider

required

public NpmExecutor required(Path root,
 String pattern)

Description copied from interface: RequiredResourceSupport

Convenience method that adds a FileTree to the required resources. If root is relative, it is resolved against the project's directory.

Specified by:

required in interface RequiredResourceSupport

Parameters:

root - the root

pattern - the pattern

Returns:

the provider

required

public NpmExecutor required(Path root)

Description copied from interface: RequiredResourceSupport

Convenience method that adds a FileResource to the required resources. If path is relative, it is resolved against the project's directory.

Specified by:

required in interface RequiredResourceSupport

Parameters:

root - the file

Returns:

the provider

output

public NpmExecutor output(Function<Project, Stream<Resource>> resources)

Sets the function used to determine the resources generated by this provider.

Parameters:

resources - the resources

Returns:

the npm executor

provideResources

public NpmExecutor provideResources(ResourceRequest<?> proto)

Provide the generated resources in response to a request like the given one.

Parameters:

proto - defines the kind of request that the npm executor should respond to with the generated resources

Returns:

the npm executor

doProvide

protected <T extends Resource> Collection<T> doProvide(ResourceRequest<T> request)

Description copied from class: AbstractProvider

Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.

Specified by:

doProvide in class AbstractProvider

Type Parameters:

T - the generic type

Parameters:

request - the request for resources

Returns:

the stream

toString

public String toString()

To string.

Overrides:

toString in class AbstractProvider

Returns:

the string