Tasks

The task downloads a Node.js distribution, verifies its integrity, and installs it in the directory pointed by the nodeInstallDirectory property (if this property is null, the distribution is installed in directory ${projectDir}/node). 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. 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.

The task identifies the name and the version of the package manager applicable to the project by parsing the packageManager property located in the package.json file (pointed by the packageJsonDirectory property). For example, if the package.json file contains "packageManager": "npm@9.6.7", the task resolves npm as the name of the package manager, and 9.6.7 as its version.

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.

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 does nothing by default, considering frontend artifacts (minimified Javascript, CSS, HTML files...) are generated in the ${project.buildDir} directory. If it is not the case, this task may be useful to clean the relevant directory. A clean script shall be defined in the package.json file, and the cleanScript property shall be set with the corresponding npm/pnpm/yarn command. This task depends on the installFrontend task, and is skipped if the cleanScript property is null. Apart from direct execution, the task is also executed when the Gradle lifecycle clean task is executed.

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. This task depends on the installFrontend task, and is skipped if the checkScript property is null. 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. This task depends on the assembleFrontend task, and is skipped either if the assembleScript property is null, or if the publishScript property is null. Apart from direct execution, the task is also executed when the Gradle publish task is executed.

The plugin provides task type org.siouan.frontendgradleplugin.infrastructure.gradle.RunNode that allows creating a custom task to run a JS script. The script property must be set with the corresponding command. Then, choose whether Node.js only is required, or if additional dependencies located in the package.json file should be installed: make the task either depends on installNode task or on installFrontend task. The code hereafter shows the configuration required to run a JS script:

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunNode
tasks.register('myScript', RunNode) {
    // dependsOn tasks.named('installNode')
    // dependsOn tasks.named('installFrontend')
    script = 'my-script.js'
}

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunNode
tasks.register<RunNode>("myScript") {
    // dependsOn(tasks.named("installNode"))
    // dependsOn(tasks.named("installFrontend"))
    script.set("my-script.js")
}

The plugin provides task type org.siouan.frontendgradleplugin.infrastructure.gradle.RunCorepack that allows creating a custom task to run a corepack command. The script property must be set with the corresponding command. The code hereafter shows the configuration required to output the version of corepack:

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunCorepack
tasks.register('corepackVersion', RunCorepack) {
    script = '--version'
}

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunCorepack
tasks.register<RunCorepack>("corepackVersion") {
    script.set("--version")
}

The plugin provides task type org.siouan.frontendgradleplugin.infrastructure.gradle.RunNpm that allows creating a custom task to run a npm command. The script property must be set with the corresponding command. Then, choose whether additional dependencies located in the package.json file should be installed: make the task either depends on installPackageManager task or on installFrontend task. The code hereafter shows the configuration required to output the version of npm:

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunNpm
tasks.register('npmVersion', RunNpm) {
    // dependsOn tasks.named('installPackageManager')
    // dependsOn tasks.named('installFrontend')
    script = '--version'
}

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunNpm
tasks.register<RunNpm>("npmVersion") {
    // dependsOn(tasks.named("installPackageManager"))
    // dependsOn(tasks.named("installFrontend"))
    script.set("--version")
}

The plugin provides task type org.siouan.frontendgradleplugin.infrastructure.gradle.RunPnpm that allows creating a custom task to run a pnpm command. The script property must be set with the corresponding command. Then, choose whether additional dependencies located in the package.json file should be installed: make the task either depends on installPackageManager task or on installFrontend task. The code hereafter shows the configuration required to output the version of pnpm:

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunPnpm
tasks.register('pnpmVersion', RunPnpm) {
    // dependsOn tasks.named('installPackageManager')
    // dependsOn tasks.named('installFrontend')
    script = '--version'
}

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunPnpm
tasks.register<RunPnpm>("pnpmVersion") {
    // dependsOn(tasks.named("installPackageManager"))
    // dependsOn(tasks.named("installFrontend"))
    script.set("--version")
}

The plugin provides task type org.siouan.frontendgradleplugin.infrastructure.gradle.RunYarn that allows creating a custom task to run a yarn command. The script property must be set with the corresponding command. Then, choose whether additional dependencies located in the package.json file should be installed: make the task either depends on installPackageManager task or on installFrontend task. The code hereafter shows the configuration required to output the version of yarn:

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunYarn
tasks.register('yarnVersion', RunYarn) {
    // dependsOn tasks.named('installPackageManager')
    // dependsOn tasks.named('installFrontend')
    script = '--version'
}

import org.siouan.frontendgradleplugin.infrastructure.gradle.RunYarn
tasks.register<RunYarn>("yarnVersion") {
    // dependsOn(tasks.named("installPackageManager"))
    // dependsOn(tasks.named("installFrontend"))
    script.set("--version")
}