Enable Spotless in POMs generated (#4484)

Co-authored-by: Weidong Xu <weidxu@microsoft.com>
microsoft · Sep 26, 2024 · ea724f5 · ea724f5
1 parent bcee728
commit ea724f5
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/.../main/java/com/microsoft/typespec/http/client/generator/core/model/xmlmodel/XmlBlock.java b/.../main/java/com/microsoft/typespec/http/client/generator/core/model/xmlmodel/XmlBlock.java
@@ -46,11 +46,12 @@ public final void block(String text, Consumer<XmlBlock> bodyAction) {
     }
 
     public final void tagWithInlineComment(String tag, String value, String comment) {
-        contents.line("<%1$s>%2$s</%1$s> <!-- %3$s -->", tag, CodeNamer.escapeXmlComment(value),
-            CodeNamer.escapeXmlComment(comment));
+        String escapedValue = CodeNamer.escapeXmlComment(value);
+        String escapedComment = CodeNamer.escapeXmlComment(comment);
+        contents.line("<" + tag + ">" + escapedValue + "</" + tag + "> <!-- " + escapedComment + " -->");
     }
 
     public final void tagCData(String tag, String value) {
-        contents.line("<%1$s><![CDATA[%2$s]]></%1$s>", tag, value);
+        contents.line("<" + tag + "><![CDATA[" + value + "]]></" + tag + ">");
     }
 }
diff --git a/...src/main/java/com/microsoft/typespec/http/client/generator/core/template/PomTemplate.java b/...src/main/java/com/microsoft/typespec/http/client/generator/core/template/PomTemplate.java
@@ -119,6 +119,7 @@ public final void write(Pom pom, XmlFile xmlFile) {
                 propertiesBlock.tag("project.build.sourceEncoding", "UTF-8");
                 writeJacoco(propertiesBlock);
                 writeRevapi(propertiesBlock, pom);
+                writeSpotless(propertiesBlock);
             });
 
             if (!CoreUtils.isNullOrEmpty(pom.getDependencyIdentifiers())) {
@@ -179,6 +180,16 @@ protected void writeRevapi(XmlBlock propertiesBlock, Pom pom) {
         // NOOP for data-plane
     }
 
+    /**
+     * Extension for writing Spotless configuration.
+     *
+     * @param propertiesBlock The {@code <properties></properties>} XML block within the {@code pom.xml}.
+     */
+    protected void writeSpotless(XmlBlock propertiesBlock) {
+        // For now all generation will enable Spotless running.
+        propertiesBlock.tag("spotless.skip", "false");
+    }
+
     /**
      * Extension for writing a "build" block, with array of "plugin" within.
      *

diff --git a/...om/microsoft/typespec/http/client/generator/core/template/example/ProtocolTestWriter.java b/...om/microsoft/typespec/http/client/generator/core/template/example/ProtocolTestWriter.java
@@ -43,7 +43,7 @@ public ProtocolTestWriter(TestContext testContext) {
             HttpLogOptions.class.getName(), Configuration.class.getName(),
             "com.azure.core.test.utils.MockTokenCredential", "com.azure.identity.DefaultAzureCredentialBuilder",
             "com.azure.core.test.TestProxyTestBase", "com.azure.core.test.TestMode",
-//                "com.azure.core.test.annotation.DoNotRecord",
+            // "com.azure.core.test.annotation.DoNotRecord",
             "org.junit.jupiter.api.Disabled", "org.junit.jupiter.api.Test"));
         // client and builder
         syncClients.forEach(c -> {