Getting started

Requirements

The following tools must be installed to use the plugin:

JDK 17 build: Gradle 7.3+
JDK 11 build: Gradle 6.2+

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

Install the plugin.

Using Gradle DSL (recommended)

plugins {
    // For JDK 17+
    id 'org.siouan.frontend-jdk17' version '8.0.0'
    // For JDK 11+
    id 'org.siouan.frontend-jdk11' version '8.0.0'
}

plugins {
    // For JDK 17+
    id("org.siouan.frontend-jdk17") version "8.0.0"
    // For JDK 11+
    id("org.siouan.frontend-jdk11") version "8.0.0"
}

Using Gradle build script block

buildscript {
    repositories {
        url 'https://plugins.gradle.org/m2/'
    }
    dependencies {
        // For JDK 17+
        classpath 'org.siouan:frontend-gradle-plugin-jdk17:8.0.0'
        // For JDK 11+
        classpath 'org.siouan:frontend-gradle-plugin-jdk11:8.0.0'
    }
}

// For JDK 17+
apply plugin: 'org.siouan.frontend-jdk17'
// For JDK 11+
apply plugin: 'org.siouan.frontend-jdk11'

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

// For JDK 17+
apply(plugin = "org.siouan.frontend-jdk17")
// For JDK 11+
apply(plugin = "org.siouan.frontend-jdk11")

Define the packageManager property in the package.json file.
Add .frontend-gradle-plugin/ directory to .gitignore file(s).
Configure your project, optionally with the help of examples provided for typical use cases.
Run gradlew build.
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.