AsciidoctorJSExtension (asciidoctor-gradle-js 4.0.0 API)

org.asciidoctor.gradle.js.nodejs.AsciidoctorJSExtension

```
@groovy.transform.CompileStatic
class AsciidoctorJSExtension
extends AbstractAsciidoctorJSExtension
```
Extension for configuring AsciidoctorJS. It can be used as both a project and a task extension.
Authors:
Schalk W. Cronjé
Since:
3.0

Field Summary

Fields
Modifiers	Name	Description
`static String`	`NAME`
`static PackageDescriptor`	`PACKAGE_ASCIIDOCTOR`

Constructor Summary

Constructors
Constructor and description
`AsciidoctorJSExtension (Project project)` Attach extension to project.
`AsciidoctorJSExtension (AbstractAsciidoctorNodeJSTask task)` Attach extension to a task.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`clearRequires()` Removes any previous requires.
	`protected AsciidoctorJSModules`	`createModulesConfiguration()` Creates a new modules block.
	`Configuration`	`getConfiguration()` A configuration containing all required NPM packages.
	`Set<String>`	`getRequires()` Returns the set of NPM packages to be included except for the asciidoctor.js package.
	`Provider<File>`	`getToolingWorkDir()` The suggested working directory that the implementation tool should use.
	`void`	`require(String name, String tag)` Adds an additional NPM package that is required
	`void`	`require(String scope, String name, String tag)` Adds an additional NPM package that is required
	`void`	`setVersion(Object v)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractAsciidoctorJSExtension`	`createModulesConfiguration, getConfiguration, getModules, getVersion, moduleVersion, modules, modules, setVersion`

- Field Detail
  - public static final String NAME
  - public static final PackageDescriptor PACKAGE_ASCIIDOCTOR
- Constructor Detail
  - AsciidoctorJSExtension(Project project)
    
    Attach extension to project.
    Parameters:
    project - Project to attach to.
  - AsciidoctorJSExtension(AbstractAsciidoctorNodeJSTask task)
    
    Attach extension to a task.
    Parameters:
    task - Task to attach to
- Method Detail
  - void clearRequires()
    
    Removes any previous requires. If set on a task extension, no requires from global will be used.
  - @Override protected AsciidoctorJSModules createModulesConfiguration()
    
    Creates a new modules block.
    Returns:
    Modules block that can be attached to this extension.
  - Configuration getConfiguration()
    
    A configuration containing all required NPM packages. The configuration will differ between global state and task state if the task has set different requires or different docbook versions.
    Returns:
    All resolvable NPM dependencies including asciidoctor.js.
  - Set<String> getRequires()
    
    Returns the set of NPM packages to be included except for the asciidoctor.js package.
    Return:
    Set of strings in a format suitable for npm --require.
  - Provider<File> getToolingWorkDir()
    
    The suggested working directory that the implementation tool should use. For instance if the implementation tool is Node.js with NPM, the directory will usually be the same for all tasks, but in cases where different versions of NPM packages are used by tasks then the working directory will be different for the specific task.
    Returns:
    Suggested working directory.
  - void require(String name, String tag)
    
    Adds an additional NPM package that is required
    Parameters:
    name - Name of package
    tag - Tag of package
  - void require(String scope, String name, String tag)
    
    Adds an additional NPM package that is required
    Parameters:
    scope - Scope of package
    name - Name of package
    tag - Tag of package
  - @SuppressWarnings(value: UnnecessarySetter) @Override void setVersion(Object v)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Groovy] Class AsciidoctorJSExtension

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String NAME

public static final PackageDescriptor PACKAGE_ASCIIDOCTOR

Constructor Detail

AsciidoctorJSExtension(Project project)

AsciidoctorJSExtension(AbstractAsciidoctorNodeJSTask task)

Method Detail

void clearRequires()

@Override protected AsciidoctorJSModules createModulesConfiguration()

Configuration getConfiguration()

Set<String> getRequires()

Provider<File> getToolingWorkDir()

void require(String name, String tag)

void require(String scope, String name, String tag)

@SuppressWarnings(value: UnnecessarySetter) @Override void setVersion(Object v)