Tasks

The task downloads a Node.js distribution, verifies its integrity, and installs it in the directory pointed by the nodeInstallDirectory property. The URL used to download the distribution is resolved using the nodeDistributionUrlRoot property and the nodeDistributionUrlPathPattern property. Checking the distribution integrity consists of downloading a file providing the distribution shasum. This file is expected to be in the same remote web directory than the distribution archive. For example, if the distribution is located at https://nodejs.org/dist/vX.Y.Z/node-vX.Y.Z-win-x64.zip, the plugin attempts to download the shasum file located at https://nodejs.org/dist/vX.Y.Z/SHASUMS256.txt. By default, the plugin relies on the VM network properties to know if a proxy server shall be used when downloading the distribution and the shasum. A custom proxy server may also be used by defining httpsProxyHost property (respectively httpProxyHost property) if the nodeDistributionUrlRoot property uses the https protocol (resp. uses the http protocol). In case of connectivity/HTTP error, download of the distribution file and the shasum file may be retried using property maxDownloadAttempts.

If a Node.js distribution is already installed in the system, either as a global installation or as an installation performed by another Gradle (sub-)project, and shall be used instead of a downloaded distribution, take a look at the nodeDistributionProvided property instead: when true, this task is ignored if invoked during a Gradle build, and its outcome will always be SKIPPED.

The task takes advantage of Gradle incremental build, and is not executed again unless one of its inputs/outputs changed. In this case, the task outcome will be UP-TO-DATE.

This task should not be executed directly. Gradle executes it if the build requires it.

The purpose of this task is to allow replacing the default version of Corepack embedded in Node.js. This may be necessary in case of Corepack fails to install the package manager used by the project, or to continuously benefit from the latest improvements and bug fixes. By default, this task is not executed unless property corepackVersion is defined with a non-null value. In the latter case, the plugin executes command npm install -g corepack[@<corepackVersion>]. Apart from a specific version number, if this property is set with the latest value, the plugin installs the latest version available. Note that this task will not be executed again and update Corepack automatically if a newer version is released after this task has run once successfully. Since the project may use a package manager that is not npm, the task disables Corepack strict behavior when running npm (see environment variable COREPACK_ENABLE_STRICT).

As the task touches the Node.js install directory, please pay attention when using a shared Node.js distribution (nodeDistributionProvided is true), because this task will impact other projects using Corepack. This may be desirable or not depending on your situation.

The task takes advantage of Gradle incremental build, and is not executed again unless one of its inputs/outputs changed. In this case, the task outcome will be UP-TO-DATE.

This task should not be executed directly. Gradle executes it if the build requires it.

The behavior of this task depends on the existence of the package.json file:

• If the package.json file exists, the task identifies the name and the version of the package manager applicable to the project by parsing the packageManager property. For example, if the package.json file contains "packageManager": "npm@10.9.0", the task resolves npm as the name of the package manager, and 10.9.0 as its version.
• If the package.json file does not exist, the task removes output files to prevent side effects with other tasks provided by the plugin.

The task takes advantage of Gradle incremental build, and is not executed again unless one of its inputs/outputs changed. In this case, the task outcome will be UP-TO-DATE.

This task should not be executed directly. Gradle executes it if the build requires it.

The task installs the package manager resolved with task resolvePackageManager, by executing command corepack enable <package-manager>.

The task takes advantage of Gradle incremental build, and is not executed again unless one of its inputs/outputs changed. Consequently, if the task takes part of a Gradle build, its outcome will be UP-TO-DATE.

This task should not be executed directly. Gradle executes it if the build requires it.

Depending on the package manager, this task executes either command npm install, or command pnpm install, or command yarn install, by default. Consequently, the command shall install project dependencies according to the algorithm followed by each package manager (see hereafter). Optionally, this command may be customized with the installScript property (e.g. to run a npm ci command instead). On a developer workstation, executing this task is a good starting point to setup a workspace for development as it will install the Node.js distribution (if not provided) as well as dependencies.

This task may be used to integrate a check script into a Gradle build. The check script shall be defined in the package.json file, and the checkScript property shall be set with the corresponding npm/pnpm/yarn command. A typical check script may lint source files, execute tests, and/or perform additional analysis actions. Apart from direct execution, the task is also executed when the Gradle lifecycle check task is executed.

This task may be used to integrate a publish script into a Gradle build. The publish script shall be defined in the package.json file, and the publishScript property shall be set with the corresponding npm/pnpm/yarn command. Apart from direct execution, the task is also executed when the Gradle publish task is executed.

This task allows to execute a node command from a Gradle command line. To define custom inputs, outputs, or environment, it is recommended to register a custom task using RunNodeTaskType rather than overriding the default configuration of this task.

This task allows to execute a corepack command from a Gradle command line. To define custom inputs, outputs, or environment, it is recommended to register a custom task using RunCorepackTaskType rather than overriding the default configuration of this task.

This task allows to execute a npm command from a Gradle command line. To define custom inputs, outputs, or environment, it is recommended to register a custom task using RunNpmTaskType rather than overriding the default configuration of this task.

This task allows to execute a pnpm command from a Gradle command line. To define custom inputs, outputs, or environment, it is recommended to register a custom task using RunPnpmTaskType rather than overriding the default configuration of this task.

This task allows to execute a yarn command from a Gradle command line. To define custom inputs, outputs, or environment, it is recommended to register a custom task using RunYarnTaskType rather than overriding the default configuration of this task.

Task type org.siouan.frontendgradleplugin.infrastructure.gradle.RunNodeTaskType allows to register a custom task executing a node command. The args property must be defined with the corresponding arguments, either in the build script or on the command line. The example hereafter shows how to register a task in a build script to output the version of node:

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunNodeTaskType
tasks.register('customNodeTask', RunNodeTaskType) {
    dependsOn 'installNode'
    // If the command requires additional dependencies located in the 'package.json' file,
    // replace the previous task dependency with the one hereafter:
    //dependsOn 'installFrontend'
    args = '-v'
}

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunNodeTaskType
tasks.register<RunNodeTaskType>("customNodeTask") {
    dependsOn("installNode")
    // If the command requires additional dependencies located in the 'package.json' file,
    // replace the previous task dependency with the one hereafter:
    //dependsOn("installFrontend")
    args.set("-v")
}

The args property may be defined or overwritten on the command line: gradle customNodeTask "--args=-v"

Task type org.siouan.frontendgradleplugin.infrastructure.gradle.RunCorepackTaskType allows to register a custom task executing a corepack command. The args property must be defined with the corresponding arguments, either in the build script or on the command line. The example hereafter shows how to register a task in a build script to output the version of corepack:

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunCorepackTaskType
tasks.register('customCorepackTask', RunCorepackTaskType) {
    dependsOn 'installCorepack'
    args = '-v'
}

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunCorepackTaskType
tasks.register<RunCorepackTaskType>("customCorepackTask") {
    dependsOn("installCorepack")
    args.set("-v")
}

The args property may be defined or overwritten on the command line: gradle customCorepackTask "--args=-v"

Task type org.siouan.frontendgradleplugin.infrastructure.gradle.RunNpmTaskType allows to register a custom task executing a npm command. The args property must be defined with the corresponding arguments, either in the build script or on the command line. The example hereafter shows how to register a task in a build script to output the version of npm:

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunNpmTaskType
tasks.register('customNpmTask', RunNpmTaskType) {
    dependsOn 'installPackageManager'
    // If the command requires additional dependencies located in the 'package.json' file,
    // replace the previous task dependency with the one hereafter:
    //dependsOn 'installFrontend'
    args = '-v'
}

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunNpmTaskType
tasks.register<RunNpmTaskType>("customNpmTask") {
    dependsOn("installPackageManager")
    // If the command requires additional dependencies located in the 'package.json' file,
    // replace the previous task dependency with the one hereafter:
    //dependsOn("installFrontend")
    args.set("-v")
}

The args property may be defined or overwritten on the command line: gradle customNpmTask "--args=-v"

Task type org.siouan.frontendgradleplugin.infrastructure.gradle.RunPnpmTaskType allows to register a custom task executing a pnpm command. The args property must be defined with the corresponding arguments, either in the build script or on the command line. The example hereafter shows how to register a task in a build script to output the version of pnpm:

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunPnpmTaskType
tasks.register('customPnpmTask', RunPnpmTaskType) {
    dependsOn 'installPackageManager'
    // If the command requires additional dependencies located in the 'package.json' file,
    // replace the previous task dependency with the one hereafter:
    //dependsOn 'installFrontend'
    args = '-v'
}

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunPnpmTaskType
tasks.register<RunPnpmTaskType>("customPnpmTask") {
    dependsOn("installPackageManager")
    // If the command requires additional dependencies located in the 'package.json' file,
    // replace the previous task dependency with the one hereafter:
    //dependsOn("installFrontend")
    args.set("-v")
}

The args property may be defined or overwritten on the command line: gradle customPnpmTask "--args=-v"

Task type org.siouan.frontendgradleplugin.infrastructure.gradle.RunYarnTaskType allows to register a custom task executing a yarn command. The args property must be defined with the corresponding arguments, either in the build script or on the command line. The example hereafter shows how to register a task in a build script to output the version of yarn:

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunYarnTaskType
tasks.register('customYarnTask', RunYarnTaskType) {
    dependsOn 'installPackageManager'
    // If the command requires additional dependencies located in the 'package.json' file,
    // replace the previous task dependency with the one hereafter:
    //dependsOn 'installFrontend'
    args = '-v'
}

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunYarnTaskType
tasks.register<RunYarnTaskType>("customYarnTask") {
    dependsOn("installPackageManager")
    // If the command requires additional dependencies located in the 'package.json' file,
    // replace the previous task dependency with the one hereafter:
    //dependsOn("installFrontend")
    args.set("-v")
}

The args property may be defined or overwritten on the command line: gradle customYarnTask "--args=-v"