Getting started

Requirements

The following tools must be installed to use the plugin:

• JDK 21 build: Gradle 8.5+
• JDK 17 build: Gradle 8.5+

The plugin is built and tested on Linux, Mac OS, Windows (see the list of build environments used in the contributing notes).

Supported distributions

• Node.js: ^14.19.0, ≥16.9.0
• npm: any
• pnpm: ^5.0.0 (requires Node.js 14), ≥6.0.0
• Yarn: ≥1.0.0

Steps

1. Install the plugin.

   • Using Gradle DSL (recommended)

     • Groovy
     • Kotlin

     plugins {
         // For JDK 21+
         id 'org.siouan.frontend-jdk21' version '11.0.0'
         // For JDK 17+
         id 'org.siouan.frontend-jdk17' version '11.0.0'
     }

     plugins {
         // For JDK 21+
         id("org.siouan.frontend-jdk21") version "11.0.0"
         // For JDK 17+
         id("org.siouan.frontend-jdk17") version "11.0.0"
     }

   • Using Gradle build script block

     • Groovy
     • Kotlin

     buildscript {
         repositories {
             url 'https://plugins.gradle.org/m2/'
         }
         dependencies {
             // For JDK 21+
             classpath 'org.siouan:frontend-gradle-plugin-jdk21:11.0.0'
             // For JDK 17+
             classpath 'org.siouan:frontend-gradle-plugin-jdk17:11.0.0'
         }
     }
     
     // For JDK 21+
     apply plugin: 'org.siouan.frontend-jdk21'
     // For JDK 17+
     apply plugin: 'org.siouan.frontend-jdk17'

     buildscript {
         repositories {
             url = uri("https://plugins.gradle.org/m2/")
         }
         dependencies {
             // For JDK 21+
             classpath("org.siouan:frontend-gradle-plugin-jdk21:11.0.0")
             // For JDK 17+
             classpath("org.siouan:frontend-gradle-plugin-jdk17:11.0.0")
         }
     }
     
     // For JDK 21+
     apply(plugin = "org.siouan.frontend-jdk21")
     // For JDK 17+
     apply(plugin = "org.siouan.frontend-jdk17")

2. Starting from Node.js 25+, Corepack is not bundled in the distribution anymore. Set the corepackVersion property with a non-null value.
3. Define the packageManager property in the package.json file: (npm|pnpm|yarn)@x.y.z(+hash) (other syntax defined by Corepack is not supported).
4. Add .frontend-gradle-plugin/ directory to .gitignore file(s).
5. Configure the build, test (check), deploy (publish) phases in your project, with the help of the built-in tasks dependency tree and optionally examples provided for typical use cases.
6. Run gradlew build.
7. Additionally:
   • If you need to execute an instant command with a node-based executable (e.g. to install a dependency), invoke one of the following tasks on a Gradle command line: runNode, runCorepack, runNpm, runPnpm, runYarn.
   • If you need to define a reusable node-based command with eventual custom inputs, outputs, or environment, use one of the following task types: RunNodeTaskType, RunCorepackTaskType, RunNpmTaskType, RunPnpmTaskType, RunYarnTaskType.
   • If you need to run node/corepack/npm/pnpm/yarn executables from a command line (e.g. to start a development server), take a look at the FAQ.