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

org.ysb33r.gradle.nodejs.pkgwrapper.AbstractPackageWrappingExtension

@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
abstract class AbstractPackageWrappingExtension
extends org.ysb33r.grolifant5.api.core.runnable.CombinedProjectTaskExtensionBase<AbstractPackageWrappingExtension>

A base class that can be used to wrap specific NPM packages as features in Gradle, thereby allowing for configuraton both a project or task level.

Since:: 0.1

Field Summary

Fields
Modifiers	Name	Description
`protected static boolean`	`USE_DEFAULT_EXTENSIONS`	Whether the NodeJS & Npm extensions should be those provided by the project and tasals
`protected static boolean`	`USE_EMBEDDED_EXTENSIONS`	Whether the NodeJS & Npm extensions should be created as extensions of this extensions and thus be decoupled from the normal extensions provided by this plugin suite.
`protected NodeJSExtension`	`nodeJSExtension`	NodeJSExtension associated with the project or task extension
`protected NpmExtension`	`npmExtension`	NpmExtension associated with the project or task extension

Properties Summary

Properties
Type	Name and description
`NpmDependencyGroup`	`installGroup`

Constructor Summary

Constructors
Constructor and description
`protected AbstractPackageWrappingExtension (Project project, String packageName)` Associate extension with a project and use default extensions.
`protected AbstractPackageWrappingExtension (Project project, String packageName, NpmDependencyGroup installGroup, boolean embeddedExtensions)` Parameters: `project` - Associated project
`protected AbstractPackageWrappingExtension (Task task, String name)` Associate extension with a task.
`protected AbstractPackageWrappingExtension (Task task, AbstractPackageWrappingExtension projExt, boolean embeddedExtensions)` Associate projExt with a task.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`executableByPath(Object path)` Set package to be located by fixed path.
	`void`	`executableByVersion(Object ver)` Set package to be resolved by version.
	`protected abstract String`	`getEntryPoint()` The entrypoint path relative to the installed executable folder
	`Provider<File>`	`getExecutable()` An executable entry point for a package that is suitable for execution by `node`.
	`protected abstract String`	`getExtensionName()` Returns the name by which the extension is known.
	`protected AbstractPackageWrappingExtension`	`getGlobalPackageWrappingExtension()`
	`NpmDependencyGroup`	`getInstallGroup()` The installation group for this executable.
	`void`	`setInstallGroup(NpmDependencyGroup installGroup)` Sets the installation group (production, development, optional).

- Field Detail
  - protected static final boolean USE_DEFAULT_EXTENSIONS
    
    Whether the NodeJS & Npm extensions should be those provided by the project and tasals
    Since:
    0.10
  - protected static final boolean USE_EMBEDDED_EXTENSIONS
    
    Whether the NodeJS & Npm extensions should be created as extensions of this extensions and thus be decoupled from the normal extensions provided by this plugin suite. This is very useful for wrapping Node-based tools, which can potentially be used independently from any Javascript development.
    Since:
    0.10
  - protected final NodeJSExtension nodeJSExtension
    
    NodeJSExtension associated with the project or task extension
    Returns:
    NodeJSExtension
  - protected final NpmExtension npmExtension
    
    NpmExtension associated with the project or task extension
    Returns:
    NpmExtension
- Property Detail
  - NpmDependencyGroup installGroup
- Constructor Detail
  - protected AbstractPackageWrappingExtension(Project project, String packageName)
    
    Associate extension with a project and use default extensions. Defaults to NpmDependencyGroup.PRODUCTION.
    Parameters:
    project - Associated project
    packageName - Name of package
  - protected AbstractPackageWrappingExtension(Project project, String packageName, NpmDependencyGroup installGroup, boolean embeddedExtensions)
    
    Parameters:
    project - Associated project
    packageName - Name of package
    installGroup - Install group
    embeddedExtensions - Whether embedded extensions should be used. Default is not to create embedded extensions, but use the default extensions.
  - @Deprecated protected AbstractPackageWrappingExtension(Task task, String name)
    
    Associate extension with a task. @deprecated
    Parameters:
    task
    name - Name by which project extension is known.
  - protected AbstractPackageWrappingExtension(Task task, AbstractPackageWrappingExtension projExt, boolean embeddedExtensions)
    
    Associate projExt with a task.
    Parameters:
    task
    projExt - The project projExt.
    embeddedExtensions - Whether embedded extensions should be used. Default is not to create embedded extensions, but use the default extensions.
- Method Detail
  - void executableByPath(Object path)
    
    Set package to be located by fixed path.
    Parameters:
    path - Path to package. Anything than can be resolved using org.ysb33r.grolifant5.api.core.FileSystemOperations#file.
    Since:
    0.10
  - void executableByVersion(Object ver)
    
    Set package to be resolved by version.
    Parameters:
    ver - Version. Anything that can be resolved to a valid version string.
    Since:
    0.10
  - protected abstract String getEntryPoint()
    
    The entrypoint path relative to the installed executable folder
    Returns:
    Relative path
  - Provider<File> getExecutable()
    
    An executable entry point for a package that is suitable for execution by node.
    Returns:
    Location of package entry point.
    Since:
    0.10
  - @Deprecated protected abstract String getExtensionName()
    
    Returns the name by which the extension is known. @deprecated
    Returns:
    Extension name. Never null.
  - protected AbstractPackageWrappingExtension getGlobalPackageWrappingExtension()
  - NpmDependencyGroup getInstallGroup()
    
    The installation group for this executable.
    Returns:
    The configured instalaltion group. If this is a task extension and it has not been configured, it will query the equivalent project extension. For a project extension that is not configured, NpmDependencyGroup.PRODUCTION will be returned
  - void setInstallGroup(NpmDependencyGroup installGroup)
    
    Sets the installation group (production, development, optional).
    Parameters:
    installGroup

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractPackageWrappingExtension

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Field Detail

protected static final boolean USE_DEFAULT_EXTENSIONS

protected static final boolean USE_EMBEDDED_EXTENSIONS

protected final NodeJSExtension nodeJSExtension

protected final NpmExtension npmExtension

Property Detail

NpmDependencyGroup installGroup

Constructor Detail

protected AbstractPackageWrappingExtension(Project project, String packageName)

protected AbstractPackageWrappingExtension(Project project, String packageName, NpmDependencyGroup installGroup, boolean embeddedExtensions)

@Deprecated protected AbstractPackageWrappingExtension(Task task, String name)

protected AbstractPackageWrappingExtension(Task task, AbstractPackageWrappingExtension projExt, boolean embeddedExtensions)

Method Detail

void executableByPath(Object path)

void executableByVersion(Object ver)

protected abstract String getEntryPoint()

Provider<File> getExecutable()

@Deprecated protected abstract String getExtensionName()

protected AbstractPackageWrappingExtension getGlobalPackageWrappingExtension()

NpmDependencyGroup getInstallGroup()

void setInstallGroup(NpmDependencyGroup installGroup)