feat: allow dynamic version selection for eclipse-wtp

Author: simschla

README.md

@@ -154,7 +154,7 @@ or apply the formatting to the files.
 Available formatting steps:
   clang-format           Runs clang-format
   clean-that             CleanThat enables automatic refactoring of Java code.
-  eclipse-wtp            Runs Eclipse WTP formatter (4.21.0)
+  eclipse-wtp            Runs Eclipse WTP formatter.
   format-annotations     Corrects line break formatting of type annotations in
                            java files.
   google-java-format     Runs google java format
@@ -309,18 +309,6 @@ spotless --target '**/src/**/*.java' clean-that --exclude-mutator=StreamAnyMatch
 
 ### eclipse-wtp
 
-<!---freshmark eclipsewtpshields
-output = [
-  link(shield('spotless eclipse wtp version', 'spotless-eclipse-wtp', '{{libs.versions.native.include.spotlessEclipseWtp}}', 'blue'), 'https://central.sonatype.com/artifact/com.diffplug.spotless/spotless-eclipse-wtp/{{libs.versions.native.include.spotlessEclipseWtp}}'),
-  link(shield('eclipse wtp version', 'eclipse-wtp-formatter', '{{libs.versions.native.include.spotlessEclipseWtpFormatter}}', 'blue'), 'https://github.com/diffplug/spotless/blob/main/lib-extra/src/main/resources/com/diffplug/spotless/extra/eclipse_wtp_formatter/v{{libs.versions.native.include.spotlessEclipseWtpFormatter}}'),
-  ].join('\n')
--->
-
-[![spotless eclipse wtp version](https://img.shields.io/badge/spotless--eclipse--wtp-3.23.0-blue.svg)](https://central.sonatype.com/artifact/com.diffplug.spotless/spotless-eclipse-wtp/3.23.0)
-[![eclipse wtp version](https://img.shields.io/badge/eclipse--wtp--formatter-4.21.0-blue.svg)](https://github.com/diffplug/spotless/blob/main/lib-extra/src/main/resources/com/diffplug/spotless/extra/eclipse_wtp_formatter/v4.21.0)
-
-<!---freshmark /eclipsewtpshields -->
-
 The [eclipse web tools platform (WTP)](https://projects.eclipse.org/projects/webtools) formatter is a formatter for web files such as HTML, CSS, JavaScript, JSON, XML and XHTML.
 
 It comes with reasonable defaults but can be configured using configuration files. For details see the [spotless documentation](https://github.com/diffplug/spotless/tree/main/plugin-gradle#eclipse-web-tools-platform).
@@ -335,8 +323,8 @@ output =
 -->
 
 ```
-Usage: spotless eclipse-wtp [-hV] [-f]... [-t=<type>]
-Runs Eclipse WTP formatter (4.21.0)
+Usage: spotless eclipse-wtp [-hV] [-f]... [-t=<type>] [-v=<useVersion>]
+Runs Eclipse WTP formatter.
   -f, --config-file   The path to the Eclipse WTP configuration file. For
                         supported config file options see spotless
                         documentation (additional info links).
@@ -346,6 +334,9 @@ Runs Eclipse WTP formatter (4.21.0)
                         we find. If that does not work, we fail the formatting
                         run.
                       One of: CSS, HTML, JS, JSON, XML, XHTML
+  -v, --use-version=<useVersion>
+                      The version of Eclipse WTP formatter to use.
+                      (default: 4.21.0)
   -V, --version       Print version information and exit.
 
 ✅ This step supports the following file types:

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

@@ -34,17 +34,20 @@
 
 import picocli.CommandLine;
 
-@CommandLine.Command(
-        name = "eclipse-wtp",
-        description = "Runs Eclipse WTP formatter (" + EclipseWtp.ECLIPSE_WTP_VERSION + ")")
+@CommandLine.Command(name = "eclipse-wtp", description = "Runs Eclipse WTP formatter.")
 @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 {
 
-    public static final String ECLIPSE_WTP_VERSION = "4.21.0"; // TODO we need to slurp in the lock file also
+    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());
+    }
 
     @CommandLine.Option(
             names = {"-f", "--config-file"},
@@ -60,6 +63,12 @@ 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;
+
     public enum Type {
         CSS(EclipseWtpFormatterStep.CSS),
         HTML(EclipseWtpFormatterStep.HTML),
@@ -95,7 +104,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(ECLIPSE_WTP_VERSION);
+        builder.setVersion(useVersion);
         if (configFiles != null && !configFiles.isEmpty()) {
             builder.setPreferences(configFiles.stream()
                     .map(context::resolvePath)

gradle/libs.versions.toml

@@ -7,10 +7,6 @@ durian = "1.2.0"
 junit = "5.8.1"
 maven-resolver = "2.0.13"
 mockito = "5.17.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
-native-include-spotlessEclipseWtp = "3.23.0"
-native-include-spotlessEclipseWtpFormatter = "4.21.0"
 picocli = "4.7.6"
 selfie = "2.5.5"
 slf4j = "2.0.17"
@@ -36,7 +32,6 @@ maven-resolver-transport-apache = { module = "org.apache.maven.resolver:maven-re
 maven-resolver-transport-file = { module = "org.apache.maven.resolver:maven-resolver-transport-file" } # version from bom
 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-spotlessEclipseWtp = { module = "com.diffplug.spotless:spotless-eclipse-wtp", version.ref = "native-include-spotlessEclipseWtp" }
 picocli = { module = "info.picocli:picocli", version.ref = "picocli" }
 picocli-codegen = { module = "info.picocli:picocli-codegen", version.ref = "picocli" }
 selfie = { module = "com.diffplug.selfie:selfie-runner-junit5", version.ref = "selfie" }
@@ -59,7 +54,6 @@ maven-resolver-impl-libs = [
     "maven-resolver-supplier-mvn4",
 ]
 native-includes = [
-    "native-include-spotlessEclipseWtp",
 ]
 spotless-libs = ["spotless-lib", "spotless-lib-extra"]
 test-libs = ["assertj-core", "junit-jupiter-api", "selfie", "mockito"]