feat: introduce file type inferring to eclipse wtp

simschla · simschla · commit cc3b05155e35 · 2025-08-20T06:08:03.000+02:00
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
@@ -17,11 +17,15 @@
 
 import java.nio.file.Path;
 import java.util.List;
+import java.util.Locale;
+import java.util.function.Supplier;
 
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 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.OptionConstants;
 import com.diffplug.spotless.extra.EclipseBasedStepBuilder;
 import com.diffplug.spotless.extra.wtp.EclipseWtpFormatterStep;
@@ -45,9 +49,10 @@ public class EclipseWtp extends SpotlessFormatterStep {
 
     @CommandLine.Option(
             names = {"-t", "--type"},
-            description = "The type of the Eclipse WTP formatter." + OptionConstants.VALID_VALUES_SUFFIX,
-            required = true)
-    Type type; // TODO: might trying inferring type
+            description =
+                    "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."
+                            + OptionConstants.VALID_VALUES_SUFFIX)
+    Type type;
 
     public enum Type {
         CSS(EclipseWtpFormatterStep.CSS),
@@ -66,11 +71,23 @@ public enum Type {
         public @NotNull EclipseWtpFormatterStep toEclipseWtpType() {
             return this.backendEclipseWtpType;
         }
+
+        public static @Nullable Type fromTargetFileType(@NotNull TargetFileTypeInferer.TargetFileType targetFileType) {
+            return switch (targetFileType.fileExtension().toLowerCase(Locale.getDefault())) {
+                case "css" -> CSS;
+                case "html", "htm" -> HTML;
+                case "js" -> JS;
+                case "json" -> JSON;
+                case "xml" -> XML;
+                case "xhtml" -> XHTML;
+                default -> null;
+            };
+        }
     }
 
     @Override
     public @NotNull List<FormatterStep> prepareFormatterSteps(SpotlessActionContext context) {
-        EclipseWtpFormatterStep wtpType = type.toEclipseWtpType();
+        EclipseWtpFormatterStep wtpType = type(context::targetFileType).toEclipseWtpType();
         EclipseBasedStepBuilder builder = wtpType.createBuilder(context.provisioner());
         builder.setVersion(ECLIPSE_WTP_VERSION);
         if (configFiles != null && !configFiles.isEmpty()) {
@@ -81,4 +98,19 @@ public enum Type {
         }
         return List.of(builder.build());
     }
+
+    private Type type(Supplier<TargetFileTypeInferer.TargetFileType> targetFileTypeSupplier) {
+        if (type != null) {
+            return type;
+        }
+        // try type inferring
+        TargetFileTypeInferer.TargetFileType targetFileType = targetFileTypeSupplier.get();
+        Type inferredType = Type.fromTargetFileType(targetFileType);
+        if (inferredType != null) {
+            return inferredType;
+        } else {
+            throw new IllegalArgumentException("Could not infer Eclipse WTP type from target file type: "
+                    + targetFileType.fileExtension() + " - workaround by specifying the --type option.");
+        }
+    }
 }
diff --git a/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpCssTest.java b/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpCssTest.java
@@ -33,4 +33,10 @@ void itSupportsFormattingCssFileType() {
         String fileName = runEclipseWtpWithType(EclipseWtp.Type.CSS, "body {\n" + "a: v;   b:   \n" + "v;\n" + "}  \n");
         selfie().expectResource(fileName).toMatchDisk();
     }
+
+    @Test
+    void itInfersCssFileTypeFromFileExtension() {
+        String fileName = runEclipseWtpWithTypeInferred("css", "body {\n" + "a: v;   b:   \n" + "v;\n" + "}  \n");
+        selfie().expectResource(fileName).toMatchDisk();
+    }
 }
diff --git a/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpHtmlTest.java b/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpHtmlTest.java
@@ -35,4 +35,18 @@ void itSupportsFormattingHtmlFileType() {
                 "<!DOCTYPE html> <html>\t<head> <meta   charset=\"UTF-8\"></head>\n" + "</html>  ");
         selfie().expectResource(fileName).toMatchDisk();
     }
+
+    @Test
+    void itInfersHtmlFileTypeFromFileExtension() {
+        String fileName = runEclipseWtpWithTypeInferred(
+                "html", "<!DOCTYPE html> <html>\t<head> <meta   charset=\"UTF-8\"></head>\n" + "</html>  ");
+        selfie().expectResource(fileName).toMatchDisk();
+    }
+
+    @Test
+    void itInfersHtmlFileTypeFromShortFileExtension() {
+        String fileName = runEclipseWtpWithTypeInferred(
+                "htm", "<!DOCTYPE html> <html>\t<head> <meta   charset=\"UTF-8\"></head>\n" + "</html>  ");
+        selfie().expectResource(fileName).toMatchDisk();
+    }
 }
diff --git a/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpJsTest.java b/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpJsTest.java
@@ -33,4 +33,10 @@ void itSupportsFormattingJsFileType() {
         String fileName = runEclipseWtpWithType(EclipseWtp.Type.JS, "function f(  )   {\n" + "a.b(1,\n" + "2);}");
         selfie().expectResource(fileName).toMatchDisk();
     }
+
+    @Test
+    void itInfersJsFileTypeFromFileExtension() {
+        String fileName = runEclipseWtpWithTypeInferred("js", "function f(  )   {\n" + "a.b(1,\n" + "2);}");
+        selfie().expectResource(fileName).toMatchDisk();
+    }
 }
diff --git a/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpJsonTest.java b/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpJsonTest.java
@@ -34,4 +34,11 @@ void itSupportsFormattingJsonFileType() {
                 runEclipseWtpWithType(EclipseWtp.Type.JSON, "{\"a\": \"b\",\t\"c\":   { \"d\": \"e\",\"f\": \"g\"}}");
         selfie().expectResource(fileName).toMatchDisk();
     }
+
+    @Test
+    void itInfersJsonFileTypeFromFileExtension() {
+        String fileName =
+                runEclipseWtpWithTypeInferred("json", "{\"a\": \"b\",\t\"c\":   { \"d\": \"e\",\"f\": \"g\"}}");
+        selfie().expectResource(fileName).toMatchDisk();
+    }
 }
diff --git a/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpTestBase.java b/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpTestBase.java
@@ -32,4 +32,14 @@ protected String runEclipseWtpWithType(EclipseWtp.Type type, String unformatted)
 
         return fileName;
     }
+
+    protected String runEclipseWtpWithTypeInferred(String fileExtension, String unformatted) {
+        String fileName = "test." + fileExtension;
+        setFile(fileName).toContent(unformatted);
+
+        SpotlessCLIRunner.Result result =
+                cliRunner().withTargets(fileName).withStep(EclipseWtp.class).run();
+
+        return fileName;
+    }
 }
diff --git a/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpXhtmlTest.java b/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpXhtmlTest.java
@@ -35,4 +35,11 @@ void itSupportsFormattingXhtmlFileType() {
                 "<!DOCTYPE html> <html>\t<head> <meta   charset=\"UTF-8\"></head>\n" + "</html>  ");
         selfie().expectResource(fileName).toMatchDisk();
     }
+
+    @Test
+    void itInfersXhtmlFileTypeFromFileExtension() {
+        String fileName = runEclipseWtpWithTypeInferred(
+                "xhtml", "<!DOCTYPE html> <html>\t<head> <meta   charset=\"UTF-8\"></head>\n" + "</html>  ");
+        selfie().expectResource(fileName).toMatchDisk();
+    }
 }
diff --git a/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpXmlTest.java b/app/src/test/java/com/diffplug/spotless/cli/steps/EclipseWtpXmlTest.java
@@ -33,4 +33,10 @@ void itSupportsFormattingXmlFileType() {
         String fileName = runEclipseWtpWithType(EclipseWtp.Type.XML, "<a><b>   c</b></a>");
         selfie().expectResource(fileName).toMatchDisk();
     }
+
+    @Test
+    void itInfersXmlFileTypeFromFileExtension() {
+        String fileName = runEclipseWtpWithTypeInferred("xml", "<a><b>   c</b></a>");
+        selfie().expectResource(fileName).toMatchDisk();
+    }
 }
diff --git a/app/src/test/resources/com/diffplug/spotless/cli/steps/EclipseWtpCssTest.ss b/app/src/test/resources/com/diffplug/spotless/cli/steps/EclipseWtpCssTest.ss
@@ -1,3 +1,8 @@
+╔═ itInfersCssFileTypeFromFileExtension ═╗
+body {
+	a: v;
+	b: v;
+}
 ╔═ itSupportsFormattingCssFileType ═╗
 body {
 	a: v;
diff --git a/app/src/test/resources/com/diffplug/spotless/cli/steps/EclipseWtpHtmlTest.ss b/app/src/test/resources/com/diffplug/spotless/cli/steps/EclipseWtpHtmlTest.ss
@@ -1,3 +1,19 @@
+╔═ itInfersHtmlFileTypeFromFileExtension ═╗
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+</head>
+</html>
+
+╔═ itInfersHtmlFileTypeFromShortFileExtension ═╗
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+</head>
+</html>
+
 ╔═ itSupportsFormattingHtmlFileType ═╗
 <!DOCTYPE html>
 <html>
diff --git a/app/src/test/resources/com/diffplug/spotless/cli/steps/EclipseWtpJsTest.ss b/app/src/test/resources/com/diffplug/spotless/cli/steps/EclipseWtpJsTest.ss
@@ -1,3 +1,7 @@
+╔═ itInfersJsFileTypeFromFileExtension ═╗
+function f() {
+    a.b(1, 2);
+}
 ╔═ itSupportsFormattingJsFileType ═╗
 function f() {
     a.b(1, 2);
diff --git a/app/src/test/resources/com/diffplug/spotless/cli/steps/EclipseWtpJsonTest.ss b/app/src/test/resources/com/diffplug/spotless/cli/steps/EclipseWtpJsonTest.ss
@@ -1,3 +1,11 @@
+╔═ itInfersJsonFileTypeFromFileExtension ═╗
+{
+	"a": "b",
+	"c": {
+		"d": "e",
+		"f": "g"
+	}
+}
 ╔═ itSupportsFormattingJsonFileType ═╗
 {
 	"a": "b",
diff --git a/app/src/test/resources/com/diffplug/spotless/cli/steps/EclipseWtpXhtmlTest.ss b/app/src/test/resources/com/diffplug/spotless/cli/steps/EclipseWtpXhtmlTest.ss
@@ -1,3 +1,11 @@
+╔═ itInfersXhtmlFileTypeFromFileExtension ═╗
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+</head>
+</html>
+
 ╔═ itSupportsFormattingXhtmlFileType ═╗
 <!DOCTYPE html>
 <html>
diff --git a/app/src/test/resources/com/diffplug/spotless/cli/steps/EclipseWtpXmlTest.ss b/app/src/test/resources/com/diffplug/spotless/cli/steps/EclipseWtpXmlTest.ss
@@ -1,3 +1,7 @@
+╔═ itInfersXmlFileTypeFromFileExtension ═╗
+<a>
+	<b> c</b>
+</a>
 ╔═ itSupportsFormattingXmlFileType ═╗
 <a>
 	<b> c</b>

Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,10 @@ void itSupportsFormattingCssFileType() {`
`33`	`33`	`String fileName = runEclipseWtpWithType(EclipseWtp.Type.CSS, "body {\n" + "a: v; b: \n" + "v;\n" + "} \n");`
`34`	`34`	`selfie().expectResource(fileName).toMatchDisk();`
`35`	`35`	`}`
	`36`	`+`
	`37`	`+ @Test`
	`38`	`+ void itInfersCssFileTypeFromFileExtension() {`
	`39`	`+ String fileName = runEclipseWtpWithTypeInferred("css", "body {\n" + "a: v; b: \n" + "v;\n" + "} \n");`
	`40`	`+ selfie().expectResource(fileName).toMatchDisk();`
	`41`	`+ }`
`36`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,4 +34,11 @@ void itSupportsFormattingJsonFileType() {`
`34`	`34`	`runEclipseWtpWithType(EclipseWtp.Type.JSON, "{\"a\": \"b\",\t\"c\": { \"d\": \"e\",\"f\": \"g\"}}");`
`35`	`35`	`selfie().expectResource(fileName).toMatchDisk();`
`36`	`36`	`}`
	`37`	`+`
	`38`	`+ @Test`
	`39`	`+ void itInfersJsonFileTypeFromFileExtension() {`
	`40`	`+ String fileName =`
	`41`	`+ runEclipseWtpWithTypeInferred("json", "{\"a\": \"b\",\t\"c\": { \"d\": \"e\",\"f\": \"g\"}}");`
	`42`	`+ selfie().expectResource(fileName).toMatchDisk();`
	`43`	`+ }`
`37`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,4 +32,14 @@ protected String runEclipseWtpWithType(EclipseWtp.Type type, String unformatted)`
`32`	`32`
`33`	`33`	`return fileName;`
`34`	`34`	`}`
	`35`	`+`
	`36`	`+ protected String runEclipseWtpWithTypeInferred(String fileExtension, String unformatted) {`
	`37`	`+ String fileName = "test." + fileExtension;`
	`38`	`+ setFile(fileName).toContent(unformatted);`
	`39`	`+`
	`40`	`+ SpotlessCLIRunner.Result result =`
	`41`	`+ cliRunner().withTargets(fileName).withStep(EclipseWtp.class).run();`
	`42`	`+`
	`43`	`+ return fileName;`
	`44`	`+ }`
`35`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,4 +35,11 @@ void itSupportsFormattingXhtmlFileType() {`
`35`	`35`	`"<!DOCTYPE html> <html>\t<head> <meta charset=\"UTF-8\"></head>\n" + "</html> ");`
`36`	`36`	`selfie().expectResource(fileName).toMatchDisk();`
`37`	`37`	`}`
	`38`	`+`
	`39`	`+ @Test`
	`40`	`+ void itInfersXhtmlFileTypeFromFileExtension() {`
	`41`	`+ String fileName = runEclipseWtpWithTypeInferred(`
	`42`	`+ "xhtml", "<!DOCTYPE html> <html>\t<head> <meta charset=\"UTF-8\"></head>\n" + "</html> ");`
	`43`	`+ selfie().expectResource(fileName).toMatchDisk();`
	`44`	`+ }`
`38`	`45`	`}`
-Original file line number
+Diff line change
@@ @@ -1,3 +1,8 @@ @@
 +╔═ itInfersCssFileTypeFromFileExtension ═╗
 +body {
 +	a: v;
 +	b: v;
 +}
 ╔═ itSupportsFormattingCssFileType ═╗
 body {
 	a: v;