Build: use gradle-jvm-wrapper for ease of development

Author: ForNeVeR

.github/workflows/main.yml

@@ -18,13 +18,16 @@ jobs:
         image: [macos-12, ubuntu-22.04, windows-2022]
       fail-fast: false
     steps:
-      - uses: actions/checkout@v4
+      - name: "Check out the sources"
+        uses: actions/checkout@v4
 
-      - name: Setup Java
-        uses: actions/setup-java@v4
+      - name: Cache downloaded JDK
+        uses: actions/cache@v4
         with:
-          distribution: 'corretto'
-          java-version: '17'
+          path: |
+            ~/.local/share/gradle-jvm
+            ~/AppData/Local/gradle-jvm
+          key: ${{ runner.os }}-${{ hashFiles('gradlew*') }}
 
       - name: "Validate Gradle wrapper"
         uses: gradle/actions/wrapper-validation@v3

.github/workflows/release.yml

@@ -20,9 +20,17 @@ jobs:
         shell: pwsh
         run: echo "version=$(if ($env:GITHUB_REF.StartsWith('refs/tags/v')) { $env:GITHUB_REF -replace '^refs/tags/v', '' } else { 'next' })" >> $env:GITHUB_OUTPUT
 
-      - name: Checkout
+      - name: "Check out the sources"
         uses: actions/checkout@v4
 
+      - name: Cache downloaded JDK
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.local/share/gradle-jvm
+            ~/AppData/Local/gradle-jvm
+          key: ${{ runner.os }}-${{ hashFiles('gradlew*') }}
+
       - name: Read the changelog
         uses: ForNeVeR/ChangelogAutomation.action@v1
         with:

CONTRIBUTING.md

@@ -14,7 +14,9 @@ Keep an eye on the following issue labels:
 
 Development Prerequisites
 -------------------------
-To develop the plugin, JDK 17 should be installed. For example, get [Amazon Corretto 17][downloads.corretto].
+JDK 17 is required to develop the plugin.
+
+If you use the default Gradle wrapper (`gradlew` or `gradlew.bat`), it will be auto-downloaded on wrapper start. Otherwise (say, to open the project in an IDE), you should get a JDK17-compatible installation. For example, install [Amazon Corretto 17][downloads.corretto].
 
 Build and Test
 --------------

build.gradle.kts

@@ -9,6 +9,7 @@ plugins {
   id("java")
   alias(libs.plugins.changelog)
   alias(libs.plugins.download)
+  alias(libs.plugins.gradleJvmWrapper)
   alias(libs.plugins.grammarkit)
   alias(libs.plugins.intellij)
   alias(libs.plugins.kotlin)
@@ -60,10 +61,6 @@ configurations {
 }
 
 tasks {
-  wrapper {
-    gradleVersion = "8.3"
-  }
-
   val resources = file("src/main/resources")
 
   generateLexer {

gradle/libs.versions.toml

@@ -14,6 +14,7 @@ junixsocket = ["junixsocket-common", "junixsocket-native-common"]
 [plugins]
 changelog = { id = "org.jetbrains.changelog", version = "2.2.0" }
 download = { id = "de.undercouch.download", version = "5.6.0" }
+gradleJvmWrapper = "me.filippov.gradle.jvm.wrapper:0.14.0"
 grammarkit = { id = "org.jetbrains.grammarkit", version = "2022.3.2.2" }
 intellij = { id = "org.jetbrains.intellij", version = "1.17.3" }
 kotlin = { id = "org.jetbrains.kotlin.jvm", version = "1.9.24" }

gradlew

@@ -115,6 +115,97 @@ esac
 CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
 
 
+# GRADLE JVM WRAPPER START MARKER
+BUILD_DIR="${HOME}/.local/share/gradle-jvm"
+JVM_ARCH=$(uname -m)
+JVM_TEMP_FILE=$BUILD_DIR/gradle-jvm-temp.tar.gz
+if [ "$darwin" = "true" ]; then
+    case $JVM_ARCH in
+    x86_64)
+        JVM_URL=https://download.oracle.com/java/17/archive/jdk-17.0.3.1_macos-x64_bin.tar.gz
+        JVM_TARGET_DIR=$BUILD_DIR/jdk-17.0.3.1_macos-x64_bin-1bcf03
+        ;;
+    arm64)
+        JVM_URL=https://download.oracle.com/java/17/archive/jdk-17.0.3.1_macos-aarch64_bin.tar.gz
+        JVM_TARGET_DIR=$BUILD_DIR/jdk-17.0.3.1_macos-aarch64_bin-297fa2
+        ;;
+    *) 
+        die "Unknown architecture $JVM_ARCH"
+        ;;
+    esac
+elif [ "$cygwin" = "true" ] || [ "$msys" = "true" ]; then
+    JVM_URL=https://download.oracle.com/java/17/archive/jdk-17.0.3.1_windows-x64_bin.zip
+    JVM_TARGET_DIR=$BUILD_DIR/jdk-17.0.3.1_windows-x64_bin-d6ede5
+else
+    JVM_ARCH=$(linux$(getconf LONG_BIT) uname -m)
+     case $JVM_ARCH in
+        x86_64)
+            JVM_URL=https://download.oracle.com/java/17/archive/jdk-17.0.3.1_linux-x64_bin.tar.gz
+            JVM_TARGET_DIR=$BUILD_DIR/jdk-17.0.3.1_linux-x64_bin-9324ae
+            ;;
+        aarch64)
+            JVM_URL=https://download.oracle.com/java/17/archive/jdk-17.0.3.1_linux-aarch64_bin.tar.gz
+            JVM_TARGET_DIR=$BUILD_DIR/jdk-17.0.3.1_linux-aarch64_bin-319da6
+            ;;
+        *) 
+            die "Unknown architecture $JVM_ARCH"
+            ;;
+        esac
+fi
+
+set -e
+
+if [ -e "$JVM_TARGET_DIR/.flag" ] && [ -n "$(ls "$JVM_TARGET_DIR")" ] && [ "x$(cat "$JVM_TARGET_DIR/.flag")" = "x${JVM_URL}" ]; then
+    # Everything is up-to-date in $JVM_TARGET_DIR, do nothing
+    true
+else
+  echo "Downloading $JVM_URL to $JVM_TEMP_FILE"
+
+  rm -f "$JVM_TEMP_FILE"
+  mkdir -p "$BUILD_DIR"
+  if command -v curl >/dev/null 2>&1; then
+      if [ -t 1 ]; then CURL_PROGRESS="--progress-bar"; else CURL_PROGRESS="--silent --show-error"; fi
+      # shellcheck disable=SC2086
+      curl $CURL_PROGRESS -L --output "${JVM_TEMP_FILE}" "$JVM_URL" 2>&1
+  elif command -v wget >/dev/null 2>&1; then
+      if [ -t 1 ]; then WGET_PROGRESS=""; else WGET_PROGRESS="-nv"; fi
+      wget $WGET_PROGRESS -O "${JVM_TEMP_FILE}" "$JVM_URL" 2>&1
+  else
+      die "ERROR: Please install wget or curl"
+  fi
+
+  echo "Extracting $JVM_TEMP_FILE to $JVM_TARGET_DIR"
+  rm -rf "$JVM_TARGET_DIR"
+  mkdir -p "$JVM_TARGET_DIR"
+
+  case "$JVM_URL" in
+    *".zip") unzip "$JVM_TEMP_FILE" -d "$JVM_TARGET_DIR" ;;
+    *) tar -x -f "$JVM_TEMP_FILE" -C "$JVM_TARGET_DIR" ;;
+  esac
+  
+  rm -f "$JVM_TEMP_FILE"
+
+  echo "$JVM_URL" >"$JVM_TARGET_DIR/.flag"
+fi
+
+JAVA_HOME=
+for d in "$JVM_TARGET_DIR" "$JVM_TARGET_DIR"/* "$JVM_TARGET_DIR"/Contents/Home "$JVM_TARGET_DIR"/*/Contents/Home; do
+  if [ -e "$d/bin/java" ]; then
+    JAVA_HOME="$d"
+  fi
+done
+
+if [ '!' -e "$JAVA_HOME/bin/java" ]; then
+  die "Unable to find bin/java under $JVM_TARGET_DIR"
+fi
+
+# Make it available for child processes
+export JAVA_HOME
+
+set +e
+
+# GRADLE JVM WRAPPER END MARKER
+
 # Determine the Java command to use to start the JVM.
 if [ -n "$JAVA_HOME" ] ; then
     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then

gradlew.bat

@@ -36,6 +36,82 @@ for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
 @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
 
+@rem GRADLE JVM WRAPPER START MARKER
+
+setlocal
+set BUILD_DIR=%LOCALAPPDATA%\gradle-jvm
+set JVM_TARGET_DIR=%BUILD_DIR%\jdk-17.0.3.1_windows-x64_bin-d6ede5\
+
+set JVM_URL=https://download.oracle.com/java/17/archive/jdk-17.0.3.1_windows-x64_bin.zip
+
+set IS_TAR_GZ=0
+set JVM_TEMP_FILE=gradle-jvm.zip
+
+if /I "%JVM_URL:~-7%"==".tar.gz" (
+    set IS_TAR_GZ=1
+    set JVM_TEMP_FILE=gradle-jvm.tar.gz
+)
+
+set POWERSHELL=%SystemRoot%\system32\WindowsPowerShell\v1.0\powershell.exe
+
+if not exist "%JVM_TARGET_DIR%" MD "%JVM_TARGET_DIR%"
+
+if not exist "%JVM_TARGET_DIR%.flag" goto downloadAndExtractJvm
+
+set /p CURRENT_FLAG=<"%JVM_TARGET_DIR%.flag"
+if "%CURRENT_FLAG%" == "%JVM_URL%" goto continueWithJvm
+
+:downloadAndExtractJvm
+
+PUSHD "%BUILD_DIR%"
+if errorlevel 1 goto fail
+
+echo Downloading %JVM_URL% to %BUILD_DIR%\%JVM_TEMP_FILE%
+if exist "%JVM_TEMP_FILE%" DEL /F "%JVM_TEMP_FILE%"
+"%POWERSHELL%" -nologo -noprofile -Command "Set-StrictMode -Version 3.0; $ErrorActionPreference = \"Stop\"; (New-Object Net.WebClient).DownloadFile('%JVM_URL%', '%JVM_TEMP_FILE%')"
+if errorlevel 1 goto fail
+
+POPD
+
+RMDIR /S /Q "%JVM_TARGET_DIR%"
+if errorlevel 1 goto fail
+
+MKDIR "%JVM_TARGET_DIR%"
+if errorlevel 1 goto fail
+
+PUSHD "%JVM_TARGET_DIR%"
+if errorlevel 1 goto fail
+
+echo Extracting %BUILD_DIR%\%JVM_TEMP_FILE% to %JVM_TARGET_DIR%
+
+if "%IS_TAR_GZ%"=="1" (
+    tar xf "..\\%JVM_TEMP_FILE%"
+) else (
+    "%POWERSHELL%" -nologo -noprofile -command "Set-StrictMode -Version 3.0; $ErrorActionPreference = \"Stop\"; Add-Type -A 'System.IO.Compression.FileSystem'; [IO.Compression.ZipFile]::ExtractToDirectory('..\\%JVM_TEMP_FILE%', '.');"
+)
+if errorlevel 1 goto fail
+
+DEL /F "..\%JVM_TEMP_FILE%"
+if errorlevel 1 goto fail
+
+POPD
+
+echo %JVM_URL%>"%JVM_TARGET_DIR%.flag"
+if errorlevel 1 goto fail
+
+:continueWithJvm
+
+set JAVA_HOME=
+for /d %%d in ("%JVM_TARGET_DIR%"*) do if exist "%%d\bin\java.exe" set JAVA_HOME=%%d
+if not exist "%JAVA_HOME%\bin\java.exe" (
+  echo Unable to find java.exe under %JVM_TARGET_DIR%
+  goto fail
+)
+
+endlocal & set JAVA_HOME=%JAVA_HOME%
+
+@rem GRADLE JVM WRAPPER END MARKER
+
 @rem Find java.exe
 if defined JAVA_HOME goto findJavaFromJavaHome