feat: allow dynamic version selection for gjf

Author: simschla

README.md

@@ -436,16 +436,6 @@ spotless --target '**/src/**/*.java' format-annotations \
 
 ### google-java-format
 
-<!---freshmark gjfshields
-output = [
-  link(shield('Google Java Format version', 'google-java-format', '{{libs.versions.native.include.googleJavaFormat}}', 'blue'), 'https://github.com/google/google-java-format'),
-  ].join('\n')
--->
-
-[![Google Java Format version](https://img.shields.io/badge/google--java--format-1.27.0-blue.svg)](https://github.com/google/google-java-format)
-
-<!---freshmark /gjfshields -->
-
 Formats Java files according to the [google-java-format](https://github.com/google/google-java-format) style guide.
 
 To see usage instructions for the google-java-format formatter, run: `spotless google-java-format --help`
@@ -458,7 +448,7 @@ output =
 -->
 
 ```
-Usage: spotless google-java-format [-hijrV] [-s=<style>]
+Usage: spotless google-java-format [-hijrV] [-s=<style>] [-v=<useVersion>]
 Runs google java format
   -h, --help              Show this help message and exit.
   -i, --reorder-imports   Reorder imports.
@@ -471,6 +461,10 @@ Runs google java format
   -s, --style=<style>     The style to use for the google java format.
                           One of: AOSP, GOOGLE
                           (default: GOOGLE)
+  -v, --use-version=<useVersion>
+                          The version of google java format to use. Must be >=
+                            1.8.
+                          (default: 1.28.0)
   -V, --version           Print version information and exit.
 
 ✅ This step supports the following file type: Java

app/src/main/java/com/diffplug/spotless/cli/steps/GoogleJavaFormat.java

@@ -31,6 +31,13 @@
 @AdditionalInfoLinks("https://github.com/google/google-java-format")
 public class GoogleJavaFormat extends SpotlessFormatterStep {
 
+    private static final String DEFAULT_VERSION_SYSPROP = "steps.google-java-format.default-version";
+
+    static {
+        // workaround for dynamic property values in annotations
+        System.setProperty(DEFAULT_VERSION_SYSPROP, GoogleJavaFormatStep.defaultVersion());
+    }
+
     @CommandLine.Option(
             names = {"--style", "-s"},
             defaultValue = "GOOGLE",
@@ -61,11 +68,18 @@ public enum Style {
             description = "Format javadoc." + OptionConstants.DEFAULT_VALUE_SUFFIX)
     boolean formatJavadoc;
 
+    @CommandLine.Option(
+            names = {"--use-version", "-v"},
+            defaultValue = "${sys:" + DEFAULT_VERSION_SYSPROP + "}",
+            description =
+                    "The version of google java format to use. Must be >= 1.8." + OptionConstants.DEFAULT_VALUE_SUFFIX)
+    String useVersion;
+
     @Override
     public List<FormatterStep> prepareFormatterSteps(SpotlessActionContext context) {
         return List.of(GoogleJavaFormatStep.create(
                 GoogleJavaFormatStep.defaultGroupArtifact(),
-                GoogleJavaFormatStep.defaultVersion(),
+                useVersion,
                 style.name(),
                 context.provisioner(),
                 reflowLongStrings,

gradle/libs.versions.toml

@@ -8,7 +8,6 @@ junit = "5.8.1"
 maven-resolver = "2.0.13"
 mockito = "5.17.0"
 native-include-cleanThat = "2.23"
-native-include-googleJavaFormat = "1.27.0"
 native-include-palantirJavaFormat = "2.67.0"
 # to find required version here check eclipse_wtp_formatter/v4.21.0.lockfile
 # where <4.21.0> is the default version of com.diffplug.spotless.extra.wtp.EclipseWtpFormatterStep#defaultVersion
@@ -40,7 +39,6 @@ maven-resolver-transport-file = { module = "org.apache.maven.resolver:maven-reso
 maven-resolver-util = { module = "org.apache.maven.resolver:maven-resolver-util" } # version from bom
 mockito = { module = "org.mockito:mockito-core", version.ref = "mockito" }
 native-include-cleanThat = { module = "io.github.solven-eu.cleanthat:java", version.ref = "native-include-cleanThat" }
-native-include-googleJavaFormat = { module = "com.google.googlejavaformat:google-java-format", version.ref = "native-include-googleJavaFormat" }
 native-include-palantirJavaFormat = { module = "com.palantir.javaformat:palantir-java-format", version.ref = "native-include-palantirJavaFormat" }
 native-include-spotlessEclipseWtp = { module = "com.diffplug.spotless:spotless-eclipse-wtp", version.ref = "native-include-spotlessEclipseWtp" }
 picocli = { module = "info.picocli:picocli", version.ref = "picocli" }
@@ -66,7 +64,6 @@ maven-resolver-impl-libs = [
 ]
 native-includes = [
     "native-include-cleanThat",
-    "native-include-googleJavaFormat",
     "native-include-palantirJavaFormat",
     "native-include-spotlessEclipseWtp",
 ]