docs: document eclipse wtp formatter

Author: simschla

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Added formatter [`eclipse-wtp`](https://github.com/diffplug/spotless/tree/main/plugin-gradle#eclipse-web-tools-platform)
+
 ## [0.2.0] - 2025-07-31
 
 ### Fixed

README.md

@@ -187,6 +187,7 @@ Spotless CLI supports the following formatter steps in alphabetical order:
 
 - [clang-format](#clang-format)
 - [clean-that](#clean-that)
+- [eclipse-wtp](#eclipse-wtp)
 - [format-annotations](#format-annotations)
 - [google-java-format](#google-java-format)
 - [license-header](#license-header)
@@ -312,6 +313,74 @@ Example usage:
 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).
+
+To see usage instructions for the eclipse-wtp formatter, run: `spotless eclipse-wtp --help`
+
+<!---freshmark usage_eclipse_wtp
+output =
+   '```\n' +
+   {{usage.eclipse-wtp.array}}.join('\n') +
+    '\n```';
+-->
+
+```
+Usage: spotless eclipse-wtp [-hV] [-f]... [-t=<type>]
+Runs Eclipse WTP formatter (4.21.0)
+  -f, --config-file   The path to the Eclipse WTP configuration file. For
+                        supported config file options see spotless
+                        documentation (additional info links).
+  -h, --help          Show this help message and exit.
+  -t, --type=<type>   The type of the Eclipse WTP formatter. If not provided,
+                        the type will be guessed based on the first few files
+                        we find. If that does not work, we fail the formatting
+                        run.
+                      One of: CSS, HTML, JS, JSON, XML, XHTML
+  -V, --version       Print version information and exit.
+
+✅ This step supports the following file types:
+   * css
+   * html
+   * js
+   * json
+   * xml
+   * xhtml
+
+🌎 Additional info:
+   * https://github.com/diffplug/spotless/tree/main/plugin-gradle#eclipse-web-to
+    ols-platform
+
+   * https://projects.eclipse.org/projects/webtools
+```
+
+<!---freshmark /usage_eclipse_wtp -->
+
+Example usage:
+
+```shell
+# format all js files using (multiple) project-specific configuration files
+# for details regarding the configuration files see the spotless documentation
+spotless --target '**/*.js' eclipse-wtp --type js --config-file spotless.xml.prefs --config-file spotless.common.properties
+# or use defaults and infer type from files
+spotless --target '**/*.css' eclipse-wtp
+```
+
 ### format-annotations
 
 In Java, type annotations should be on the same line as the type that they qualify. This formatter fixes this for you.

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

@@ -26,7 +26,9 @@
 import com.diffplug.spotless.FormatterStep;
 import com.diffplug.spotless.cli.core.SpotlessActionContext;
 import com.diffplug.spotless.cli.core.TargetFileTypeInferer;
+import com.diffplug.spotless.cli.help.AdditionalInfoLinks;
 import com.diffplug.spotless.cli.help.OptionConstants;
+import com.diffplug.spotless.cli.help.SupportedFileTypes;
 import com.diffplug.spotless.extra.EclipseBasedStepBuilder;
 import com.diffplug.spotless.extra.wtp.EclipseWtpFormatterStep;
 
@@ -35,16 +37,20 @@
 @CommandLine.Command(
         name = "eclipse-wtp",
         description = "Runs Eclipse WTP formatter (" + EclipseWtp.ECLIPSE_WTP_VERSION + ")")
+@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
 
     @CommandLine.Option(
             names = {"-f", "--config-file"},
             arity = "0",
-            description =
-                    "The path to the Eclipse WTP configuration file.\n"
-                            + "For supported config file options see <https://github.com/diffplug/spotless/tree/main/plugin-gradle#eclipse-web-tools-platform>")
+            description = "The path to the Eclipse WTP configuration file. "
+                    + "For supported config file options see spotless documentation (additional info links).")
     List<Path> configFiles;
 
     @CommandLine.Option(

build-logic/src/main/groovy/com/diffplug/spotless/cli/picocli/usage/DocumentedUsages.groovy

@@ -4,6 +4,7 @@ enum DocumentedUsages {
 
 	CLANG_FORMAT(),
 	CLEAN_THAT(),
+	ECLIPSE_WTP(),
 	FORMAT_ANNOTATIONS(),
 	MAIN(""),
 	GOOGLE_JAVA_FORMAT(),

gradle/libs.versions.toml

@@ -12,6 +12,7 @@ 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
 native-include-spotlessEclipseWtp = "3.23.0"
+native-include-spotlessEclipseWtpFormatter = "4.21.0"
 picocli = "4.7.6"
 selfie = "2.5.1"
 slf4j = "2.0.17"