Class NpmExecutor

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.nodejs.NpmExecutor

All Implemented Interfaces:

Renamable, ResourceProvider

public class NpmExecutor
extends AbstractProvider
implements Renamable

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

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

• The provider invokes the function set with provided(Function) and collects all resources. If the provided resources exist and no resource from required is newer then the provided resources found, the provider returns a result that indicates successful invocation. The date of the result is set to the newest date from the provided 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 provided(Function) to determine the resources to be removed when it is invoked with a request for Cleanliness.

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> Stream<T>	doProvide(ResourceRequest<T> requested)	Invoked by ResourceProviderSpi.provide(ResourceRequest) after checking if the invocation is allowed.
NpmExecutor	name(String name)	Name.
NpmExecutor	provided(Function<Project, Stream<Resource>> resources)	Sets the function used to determine the resources provided by this provider.
NpmExecutor	required(Path root)	Convenience method to add a FileResource to the required resources.
NpmExecutor	required(Path root, String pattern)	Convenience method to add a FileTree to the required resources.
NpmExecutor	required(Stream<Resource> resources)	Add the given Stream of resources to the required resources.

Methods inherited from class AbstractProvider

context, name, newResource, of, rename, toString, vavrStream

Methods inherited from class Object

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

Methods inherited from interface ResourceProvider

of, resources

Constructor Details

NpmExecutor

public NpmExecutor(Project project)

Initializes a new NPM executor.

Parameters:

project - the project

Method Details

name

public NpmExecutor name(String name)

Name.

Specified by:

name in interface Renamable

Parameters:

name - the name

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<Resource> resources)

Add the given Stream of resources to the required resources.

Parameters:

resources - the resources

Returns:

the npm executor

required

public NpmExecutor required(Path root,
 String pattern)

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

Parameters:

root - the root

pattern - the pattern

Returns:

the npm executor

required

public NpmExecutor required(Path root)

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

Parameters:

root - the root

Returns:

the npm executor

provided

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

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

Parameters:

resources - the resources

Returns:

the npm executor

doProvide

protected <T extends Resource> Stream<T> doProvide(ResourceRequest<T> requested)

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:

requested - the request for resources

Returns:

the stream