GulpExtension (nodejs-gradle-plugin 2.0.0 API)

org.ysb33r.gradle.nodejs.GulpExtension

Extension that allows for setting of Gulp configuration at a project or task level. If no executable is set the default will be to install GULP_DEFAULT for a project extension. In the case of a task extension it will default to the project extension's settings.
Since:
0.1

Inherited fields
Fields inherited from class	Fields
`class AbstractPackageWrappingExtension`	`USE_DEFAULT_EXTENSIONS, USE_EMBEDDED_EXTENSIONS, nodeJSExtension, npmExtension`

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`GULP_DEFAULT` The default version of Gulp that will be used if nothing is configured.
`static java.lang.String`	`NAME`
`java.lang.Object`	`gulpFile`
`java.lang.Iterable<java.lang.String>`	`requires`

Constructor Summary

Constructors
Constructor and description
`GulpExtension (org.gradle.api.Project project)` Adds the extension to the project.
`GulpExtension (GulpTask task)` Adds the extension to a GulpTask task.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected java.lang.String`	`getEntryPoint()` The entrypoint path relative to the installed executable folder
	`protected java.lang.String`	`getExtensionName()` Returns the name by which the extension is known.
	`java.io.File`	`getGulpFile()` The location of `gulpfile.js`.
	`java.lang.Iterable<java.lang.String>`	`getRequires()` Get set of requires that will be passed to Gulp.
	`void`	`gulpFile(java.lang.Object gulpFileLocation)` Sets the location of `gulpfile.js`
	`void`	`requires(java.lang.String... reqs)` Appends more require specifications.
	`void`	`requires(java.lang.Iterable<java.lang.String> reqs)` Appends more require specifications.
	`void`	`setGulpFile(java.lang.Object gulpFileLocation)` Sets the location of `gulpfile.js`
	`void`	`setRequires(java.lang.Iterable<java.lang.String> reqs)` Replace any existing require specifications with a new one.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractPackageWrappingExtension`	`executable, executableByPath, executableByVersion, getEntryPoint, getExecutable, getExtensionName, getGlobalPackageWrappingExtension, getInstallGroup, setInstallGroup`

- Property Detail
  - static final java.lang.String GULP_DEFAULT
    
    The default version of Gulp that will be used if nothing is configured.
  - static final java.lang.String NAME
  - java.lang.Object gulpFile
  - java.lang.Iterable<java.lang.String> requires
- Constructor Detail
  - @java.lang.SuppressWarnings(['UnnecessaryCast', 'DuplicateStringLiteral']) GulpExtension(org.gradle.api.Project project)
    
    Adds the extension to the project.
    Sets the default Gulp tag to GULP_DEFAULT.
    Parameters:
    project - Project to link to.
  - GulpExtension(GulpTask task)
    
    Adds the extension to a GulpTask task.
    Links the executable resolving to the global instance, but allows it to be overriden on a per-task basis.
    Parameters:
    task - Task to be extended.
- Method Detail
  - @java.lang.Override protected java.lang.String getEntryPoint()
    
    The entrypoint path relative to the installed executable folder
    Returns:
    bin/gulp.js
  - @java.lang.Override protected java.lang.String getExtensionName()
    
    Returns the name by which the extension is known.
    Returns:
    Extension name. Never null.
  - java.io.File getGulpFile()
    
    The location of gulpfile.js.
    Returns:
    Returns location. If this is a project extension and the location was not set project.file( "\${project.projectDir/gulpfile.js"} will be returned.
  - java.lang.Iterable<java.lang.String> getRequires()
    
    Get set of requires that will be passed to Gulp.
    This is the same as the --requires command-line.
    Returns:
    An iterable list of require specifications. If the extension is attached to a task and the list is null, the project extension will be queried. To override the list from the project extension with an empty list, call setRequires with an empty list.
  - void gulpFile(java.lang.Object gulpFileLocation)
    
    Sets the location of gulpfile.js
    Parameters:
    gulpFileLocation
  - void requires(java.lang.String... reqs)
    
    Appends more require specifications.
    Parameters:
    reqs - one of more require specifications
  - void requires(java.lang.Iterable<java.lang.String> reqs)
    
    Appends more require specifications.
    Parameters:
    reqs - Iteratable list of executable requirements
  - void setGulpFile(java.lang.Object gulpFileLocation)
    
    Sets the location of gulpfile.js
    Parameters:
    gulpFileLocation
  - void setRequires(java.lang.Iterable<java.lang.String> reqs)
    
    Replace any existing require specifications with a new one.
    Parameters:
    reqs - Iteratable list of executable requirements.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GulpExtension

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.lang.String GULP_DEFAULT

static final java.lang.String NAME

java.lang.Object gulpFile

java.lang.Iterable<java.lang.String> requires

Constructor Detail

@java.lang.SuppressWarnings(['UnnecessaryCast', 'DuplicateStringLiteral']) GulpExtension(org.gradle.api.Project project)

GulpExtension(GulpTask task)

Method Detail

@java.lang.Override protected java.lang.String getEntryPoint()

@java.lang.Override protected java.lang.String getExtensionName()

java.io.File getGulpFile()

java.lang.Iterable<java.lang.String> getRequires()

void gulpFile(java.lang.Object gulpFileLocation)

void requires(java.lang.String... reqs)

void requires(java.lang.Iterable<java.lang.String> reqs)

void setGulpFile(java.lang.Object gulpFileLocation)

void setRequires(java.lang.Iterable<java.lang.String> reqs)