Issue #1: Create a application what parses xdocs with example config …

…specified

extractor/src/main/java/com/example/extractor/ConfigSerializer.java

@@ -1,3 +1,4 @@
+
 package com.example.extractor;
 
 import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
@@ -15,6 +16,16 @@
 
 public class ConfigSerializer {
 
+    public static void serializeConfigToFile(String exampleFilePath, String templateFilePath, String outputFilePath) throws Exception {
+        String configContent = serializeConfigToString(exampleFilePath, templateFilePath);
+        Files.write(Path.of(outputFilePath), configContent.getBytes());
+    }
+
+    public static void serializeAllInOneConfigToFile(String[] exampleFilePaths, String templateFilePath, String outputFilePath) throws Exception {
+        String configContent = serializeAllInOneConfigToString(exampleFilePaths, templateFilePath);
+        Files.write(Path.of(outputFilePath), configContent.getBytes());
+    }
+
     public static String serializeConfigToString(String exampleFilePath, String templateFilePath) throws Exception {
         System.out.println("Loading configuration from example file...");
         TestInputConfiguration testInputConfiguration = InlineConfigParser.parseWithXmlHeader(exampleFilePath);
@@ -29,11 +40,6 @@ public static String serializeConfigToString(String exampleFilePath, String temp
         // Call replacePlaceholders to get the final config content
         String configContent = TemplateProcessor.replacePlaceholders(template, moduleContent);
 
-        // Ensure the final content ends with a newline
-        if (!configContent.endsWith("\n")) {
-            configContent += "\n";
-        }
-
         return configContent;
     }
 
@@ -64,11 +70,6 @@ public static String serializeAllInOneConfigToString(String[] exampleFilePaths,
         String template = new String(Files.readAllBytes(Path.of(templateFilePath)));
         String configContent = TemplateProcessor.replacePlaceholders(template, combinedModuleContent);
 
-        // Ensure the final content ends with a newline
-        if (!configContent.endsWith("\n")) {
-            configContent += "\n";
-        }
-
         return configContent;
     }
 
@@ -207,4 +208,4 @@ private static String buildModuleContent(Configuration config, String indent) {
         }
         return builder.toString().trim();
     }
-}
+}

extractor/src/test/java/com/example/extractor/MainTest.java

@@ -31,7 +31,7 @@ public void testParseConfigFromHeader() throws Exception {
     public void testGeneratedConfigMatchesExpectedExample1() throws Exception {
         String exampleFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Examples/Example1.java";
         String templateFilePath = "src/main/resources/config-template-treewalker.xml";
-        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/config-example1-expected.xml";
+        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/expected-config-example1.xml";
 
         String generatedContent = ConfigSerializer.serializeConfigToString(exampleFilePath, templateFilePath);
         String expectedContent = loadToString(expectedFilePath);
@@ -43,7 +43,7 @@ public void testGeneratedConfigMatchesExpectedExample1() throws Exception {
     public void testGeneratedConfigMatchesExpectedExample2() throws Exception {
         String exampleFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Examples/Example2.java";
         String templateFilePath = "src/main/resources/config-template-treewalker.xml";
-        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/config-example2-expected.xml";
+        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/expected-config-example2.xml";
 
         String generatedContent = ConfigSerializer.serializeConfigToString(exampleFilePath, templateFilePath);
         String expectedContent = loadToString(expectedFilePath);
@@ -55,7 +55,7 @@ public void testGeneratedConfigMatchesExpectedExample2() throws Exception {
     public void testGeneratedConfigMatchesExpectedExample3() throws Exception {
         String exampleFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Examples/Example3.java";
         String templateFilePath = "src/main/resources/config-template-treewalker.xml";
-        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/config-example3-expected.xml";
+        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/expected-config-example3.xml";
 
         String generatedContent = ConfigSerializer.serializeConfigToString(exampleFilePath, templateFilePath);
         String expectedContent = loadToString(expectedFilePath);
@@ -67,7 +67,7 @@ public void testGeneratedConfigMatchesExpectedExample3() throws Exception {
     public void testGeneratedConfigMatchesExpectedExample4() throws Exception {
         String exampleFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Examples/Example4.java";
         String templateFilePath = "src/main/resources/config-template-treewalker.xml";
-        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/config-example4-expected.xml";
+        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/expected-config-example4.xml";
 
         String generatedContent = ConfigSerializer.serializeConfigToString(exampleFilePath, templateFilePath);
         String expectedContent = loadToString(expectedFilePath);
@@ -79,7 +79,7 @@ public void testGeneratedConfigMatchesExpectedExample4() throws Exception {
     public void testGeneratedConfigMatchesExpectedExample5() throws Exception {
         String exampleFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Examples/Example5.java";
         String templateFilePath = "src/main/resources/config-template-treewalker.xml";
-        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/config-example5-expected.xml";
+        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/expected-config-example5.xml";
 
         String generatedContent = ConfigSerializer.serializeConfigToString(exampleFilePath, templateFilePath);
         String expectedContent = loadToString(expectedFilePath);
@@ -91,7 +91,7 @@ public void testGeneratedConfigMatchesExpectedExample5() throws Exception {
     public void testGeneratedConfigMatchesExpectedExample6() throws Exception {
         String exampleFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Examples/Example6.java";
         String templateFilePath = "src/main/resources/config-template-treewalker.xml";
-        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/config-example6-expected.xml";
+        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/expected-config-example6.xml";
 
         String generatedContent = ConfigSerializer.serializeConfigToString(exampleFilePath, templateFilePath);
         String expectedContent = loadToString(expectedFilePath);
@@ -103,7 +103,7 @@ public void testGeneratedConfigMatchesExpectedExample6() throws Exception {
     public void testGeneratedConfigMatchesExpectedExample7() throws Exception {
         String exampleFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Examples/Example7.java";
         String templateFilePath = "src/main/resources/config-template-treewalker.xml";
-        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/config-example7-expected.xml";
+        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/expected-config-example7.xml";
 
         String generatedContent = ConfigSerializer.serializeConfigToString(exampleFilePath, templateFilePath);
         String expectedContent = loadToString(expectedFilePath);
@@ -124,7 +124,7 @@ public void testGeneratedConfigMatchesExpectedAllInOne() throws Exception {
         };
 
         String templateFilePath = "src/main/resources/config-template-treewalker.xml";
-        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/config-examples-all-in-one-expected.xml";
+        String expectedFilePath = "src/test/resources/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInName/Configs/expected-config-all-in-one.xml";
 
         String generatedContent = ConfigSerializer.serializeAllInOneConfigToString(exampleFiles, templateFilePath);
         String expectedContent = loadToString(expectedFilePath);