refactor: extract custom versioning into mixin

simschla · simschla · commit 47d27325b292 · 2025-12-21T21:25:03.000+01:00
diff --git a/README.md b/README.md
@@ -288,7 +288,7 @@ CleanThat enables automatic refactoring of Java code.
                     available.
                   (default: 1.8)
   -v, --use-version=<useVersion>
-                  The version of CleanThat to use.
+                  The version of clean-that to use.
                   (default: 2.24)
   -V, --version   Print version information and exit.
 
@@ -335,7 +335,7 @@ Runs Eclipse WTP formatter.
                         run.
                       One of: CSS, HTML, JS, JSON, XML, XHTML
   -v, --use-version=<useVersion>
-                      The version of Eclipse WTP formatter to use.
+                      The version of eclipse-wtp to use.
                       (default: 4.21.0)
   -V, --version       Print version information and exit.
 
@@ -447,8 +447,7 @@ Runs 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.
+                          The version of google-java-format to use.
                           (default: 1.28.0)
   -V, --version           Print version information and exit.
 
@@ -553,7 +552,7 @@ Runs palantir java format
                          One of: PALANTIR, AOSP, GOOGLE
                          (default: PALANTIR)
   -v, --use-version=<useVersion>
-                         The version of palantir java format to use.
+                         The version of palantir-java-format to use.
                          (default: 2.80.0)
   -V, --version          Print version information and exit.
 
diff --git a/app/src/main/java/com/diffplug/spotless/cli/steps/CleanThat.java b/app/src/main/java/com/diffplug/spotless/cli/steps/CleanThat.java
@@ -31,7 +31,10 @@
 
 import picocli.CommandLine;
 
-@CommandLine.Command(name = "clean-that", description = "CleanThat enables automatic refactoring of Java code.")
+@CommandLine.Command(
+        name = "clean-that",
+        description = "CleanThat enables automatic refactoring of Java code.",
+        defaultValueProvider = CleanThat.DefaultValueProvider.class)
 @SupportedFileTypes("Java")
 @AdditionalInfoLinks({
     "https://github.com/solven-eu/cleanthat",
@@ -41,12 +44,15 @@ public class CleanThat extends SpotlessFormatterStep {
 
     public static final String DEFAULT_MUTATORS = String.join(", ", CleanthatJavaStep.defaultMutators());
 
-    private static final String DEFAULT_VERSION_SYSPROP = "steps.clean-that.default-version";
-
     static {
         // workaround for dynamic property resolution in help messages
         System.setProperty("usage.cleanthat.defaultMutators", DEFAULT_MUTATORS);
-        System.setProperty(DEFAULT_VERSION_SYSPROP, CleanthatJavaStep.defaultVersion());
+    }
+
+    static class DefaultValueProvider extends CustomVersion.CustomVersionDefaultValueProvider {
+        DefaultValueProvider() {
+            super(CleanthatJavaStep::defaultVersion);
+        }
     }
 
     @CommandLine.Option(
@@ -91,17 +97,14 @@ public class CleanThat extends SpotlessFormatterStep {
                             + OptionConstants.DEFAULT_VALUE_SUFFIX)
     String sourceCompatibility;
 
-    @CommandLine.Option(
-            names = {"--use-version", "-v"},
-            defaultValue = "${sys:" + DEFAULT_VERSION_SYSPROP + "}",
-            description = "The version of CleanThat to use." + OptionConstants.DEFAULT_VALUE_SUFFIX)
-    String useVersion;
+    @CommandLine.Mixin
+    CustomVersion customVersion;
 
     @Override
     public @NotNull List<FormatterStep> prepareFormatterSteps(SpotlessActionContext context) {
         return Collections.singletonList(CleanthatJavaStep.create(
                 CleanthatJavaStep.defaultGroupArtifact(),
-                useVersion,
+                customVersion.useVersion,
                 this.sourceCompatibility,
                 includedMutators(),
                 excludedMutators(),
diff --git a/app/src/main/java/com/diffplug/spotless/cli/steps/CustomVersion.java b/app/src/main/java/com/diffplug/spotless/cli/steps/CustomVersion.java
@@ -0,0 +1,59 @@
+/*
+ * Copyright 2025 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.diffplug.spotless.cli.steps;
+
+import java.util.Objects;
+import java.util.function.Supplier;
+
+import org.jetbrains.annotations.NotNull;
+
+import com.diffplug.spotless.cli.help.OptionConstants;
+
+import picocli.CommandLine;
+
+public class CustomVersion {
+
+    private static final String LONG_OPTION = "--use-version";
+    private static final String SHORT_OPTION = "-v";
+
+    @CommandLine.Option(
+            names = {LONG_OPTION, SHORT_OPTION},
+            description = "The version of ${COMMAND-NAME} to use." + OptionConstants.DEFAULT_VALUE_SUFFIX)
+    String useVersion;
+
+    abstract static class CustomVersionDefaultValueProvider implements CommandLine.IDefaultValueProvider {
+        private final Supplier<String> defaultVersionSupplier;
+
+        protected CustomVersionDefaultValueProvider(@NotNull Supplier<String> defaultVersionSupplier) {
+            this.defaultVersionSupplier = Objects.requireNonNull(defaultVersionSupplier);
+        }
+
+        @Override
+        public String defaultValue(CommandLine.Model.ArgSpec argSpec) throws Exception {
+            // if it is the use-version option, provide the default version, otherwise null
+            if (!argSpec.isOption()) {
+                return null;
+            }
+            if (!(argSpec instanceof CommandLine.Model.OptionSpec optionSpec)) {
+                return null;
+            }
+            if (!optionSpec.longestName().equals(LONG_OPTION)) {
+                return null;
+            }
+            return defaultVersionSupplier.get();
+        }
+    }
+}
diff --git a/app/src/main/java/com/diffplug/spotless/cli/steps/EclipseWtp.java b/app/src/main/java/com/diffplug/spotless/cli/steps/EclipseWtp.java
@@ -34,19 +34,21 @@
 
 import picocli.CommandLine;
 
-@CommandLine.Command(name = "eclipse-wtp", description = "Runs Eclipse WTP formatter.")
+@CommandLine.Command(
+        name = "eclipse-wtp",
+        description = "Runs Eclipse WTP formatter.",
+        defaultValueProvider = EclipseWtp.DefaultValueProvider.class)
 @SupportedFileTypes({"css", "html", "js", "json", "xml", "xhtml"})
 @AdditionalInfoLinks({
     "https://github.com/diffplug/spotless/tree/main/plugin-gradle#eclipse-web-tools-platform",
     "https://projects.eclipse.org/projects/webtools"
 })
 public class EclipseWtp extends SpotlessFormatterStep {
 
-    private static final String DEFAULT_VERSION_SYSPROP = "steps.eclipse-wtp.default-version";
-
-    static {
-        // workaround for dynamic property values in annotations
-        System.setProperty(DEFAULT_VERSION_SYSPROP, EclipseWtpFormatterStep.defaultVersion());
+    static class DefaultValueProvider extends CustomVersion.CustomVersionDefaultValueProvider {
+        DefaultValueProvider() {
+            super(EclipseWtpFormatterStep::defaultVersion);
+        }
     }
 
     @CommandLine.Option(
@@ -63,11 +65,8 @@ public class EclipseWtp extends SpotlessFormatterStep {
                             + OptionConstants.VALID_VALUES_SUFFIX)
     Type type;
 
-    @CommandLine.Option(
-            names = {"--use-version", "-v"},
-            defaultValue = "${sys:" + DEFAULT_VERSION_SYSPROP + "}",
-            description = "The version of Eclipse WTP formatter to use." + OptionConstants.DEFAULT_VALUE_SUFFIX)
-    String useVersion;
+    @CommandLine.Mixin
+    CustomVersion customVersion;
 
     public enum Type {
         CSS(EclipseWtpFormatterStep.CSS),
@@ -104,7 +103,7 @@ public enum Type {
     public @NotNull List<FormatterStep> prepareFormatterSteps(SpotlessActionContext context) {
         EclipseWtpFormatterStep wtpType = type(context::targetFileType).toEclipseWtpType();
         EclipseBasedStepBuilder builder = wtpType.createBuilder(context.provisioner());
-        builder.setVersion(useVersion);
+        builder.setVersion(customVersion.useVersion);
         if (configFiles != null && !configFiles.isEmpty()) {
             builder.setPreferences(configFiles.stream()
                     .map(context::resolvePath)
diff --git a/app/src/main/java/com/diffplug/spotless/cli/steps/GoogleJavaFormat.java b/app/src/main/java/com/diffplug/spotless/cli/steps/GoogleJavaFormat.java
@@ -26,16 +26,18 @@
 
 import picocli.CommandLine;
 
-@CommandLine.Command(name = "google-java-format", description = "Runs google java format")
+@CommandLine.Command(
+        name = "google-java-format",
+        description = "Runs google java format",
+        defaultValueProvider = GoogleJavaFormat.DefaultValueProvider.class)
 @SupportedFileTypes("Java")
 @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());
+    static class DefaultValueProvider extends CustomVersion.CustomVersionDefaultValueProvider {
+        DefaultValueProvider() {
+            super(GoogleJavaFormatStep::defaultVersion);
+        }
     }
 
     @CommandLine.Option(
@@ -68,18 +70,14 @@ 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;
+    @CommandLine.Mixin
+    CustomVersion customVersion;
 
     @Override
     public List<FormatterStep> prepareFormatterSteps(SpotlessActionContext context) {
         return List.of(GoogleJavaFormatStep.create(
                 GoogleJavaFormatStep.defaultGroupArtifact(),
-                useVersion,
+                customVersion.useVersion,
                 style.name(),
                 context.provisioner(),
                 reflowLongStrings,
diff --git a/app/src/main/java/com/diffplug/spotless/cli/steps/PalantirJavaFormat.java b/app/src/main/java/com/diffplug/spotless/cli/steps/PalantirJavaFormat.java
@@ -28,16 +28,18 @@
 
 import picocli.CommandLine;
 
-@CommandLine.Command(name = "palantir-java-format", description = "Runs palantir java format")
+@CommandLine.Command(
+        name = "palantir-java-format",
+        description = "Runs palantir java format",
+        defaultValueProvider = PalantirJavaFormat.DefaultValueProvider.class)
 @SupportedFileTypes("Java")
 @AdditionalInfoLinks("https://github.com/palantir/palantir-java-format")
 public class PalantirJavaFormat extends SpotlessFormatterStep {
 
-    private static final String DEFAULT_VERSION_SYSPROP = "steps.palantir-java-format.default-version";
-
-    static {
-        // workaround for dynamic property values in annotations
-        System.setProperty(DEFAULT_VERSION_SYSPROP, PalantirJavaFormatStep.defaultVersion());
+    static class DefaultValueProvider extends CustomVersion.CustomVersionDefaultValueProvider {
+        DefaultValueProvider() {
+            super(PalantirJavaFormatStep::defaultVersion);
+        }
     }
 
     @CommandLine.Option(
@@ -53,11 +55,8 @@ public class PalantirJavaFormat extends SpotlessFormatterStep {
             description = "Format javadoc." + OptionConstants.DEFAULT_VALUE_SUFFIX)
     boolean formatJavadoc;
 
-    @CommandLine.Option(
-            names = {"--use-version", "-v"},
-            defaultValue = "${sys:" + DEFAULT_VERSION_SYSPROP + "}",
-            description = "The version of palantir java format to use." + OptionConstants.DEFAULT_VALUE_SUFFIX)
-    String useVersion;
+    @CommandLine.Mixin
+    CustomVersion customVersion;
 
     public enum Style {
         PALANTIR,
@@ -68,6 +67,6 @@ public enum Style {
     @Override
     public @NotNull List<FormatterStep> prepareFormatterSteps(SpotlessActionContext context) {
         return List.of(PalantirJavaFormatStep.create(
-                PalantirJavaFormatStep.defaultVersion(), style.name(), formatJavadoc, context.provisioner()));
+                customVersion.useVersion, style.name(), formatJavadoc, context.provisioner()));
     }
 }
