chore: maven formatter plugin with org.fugerit.java:fugerit-code-rules

Author: fugerit79

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* maven formatter plugin with org.fugerit.java:fugerit-code-rules
 * dependabot workflow
 
 ## Fixed

pom.xml

@@ -10,6 +10,10 @@
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <fj-doc-version>8.16.9</fj-doc-version>
     <jacoco-plugin-version>0.8.14</jacoco-plugin-version>
+      <!-- formatter plugin -->
+      <mvn-formatter-plugin-version>2.29.0</mvn-formatter-plugin-version>
+      <fugerit-code-rules-version>0.1.1</fugerit-code-rules-version>
+      <format.skip>false</format.skip>
   </properties>
   <dependencyManagement>
     <dependencies>
@@ -88,6 +92,31 @@
                 </execution>
             </executions>
         </plugin>
+        <plugin>
+            <groupId>net.revelc.code.formatter</groupId>
+            <artifactId>formatter-maven-plugin</artifactId>
+            <version>${mvn-formatter-plugin-version}</version>
+            <dependencies>
+                <dependency>
+                    <groupId>org.fugerit.java</groupId>
+                    <artifactId>fugerit-code-rules</artifactId>
+                    <version>${fugerit-code-rules-version}</version>
+                </dependency>
+            </dependencies>
+            <configuration>
+                <configFile>org/fugerit/java/coderules/eclipse-format.xml</configFile>
+                <skip>${format.skip}</skip>
+            </configuration>
+            <executions>
+                <execution>
+                    <id>format-sources</id>
+                    <phase>process-sources</phase>
+                    <goals>
+                        <goal>format</goal>
+                    </goals>
+                </execution>
+            </executions>
+        </plugin>
     </plugins>
   </build>
 </project>

src/main/java/org/fugerit/java/demo/bareminimumgithubrepojavamaven/DocHelper.java

@@ -8,18 +8,21 @@
  */
 public class DocHelper {
 
-     /*
-      * FreemarkerDocProcessConfig is thread-safe and should be initialized once for each config file.
-      * 
-      * Consider using a @ApplicationScoped or Singleton approach.
-      */
-     private FreemarkerDocProcessConfig docProcessConfig = FreemarkerDocProcessConfigFacade.loadConfigSafe( "cl://bare-minimum-github-repo-java-maven/fm-doc-process-config.xml" );
+    /*
+     * FreemarkerDocProcessConfig is thread-safe and should be initialized once for each config file.
+     *
+     * Consider using a @ApplicationScoped or Singleton approach.
+     */
+    private FreemarkerDocProcessConfig docProcessConfig = FreemarkerDocProcessConfigFacade
+            .loadConfigSafe("cl://bare-minimum-github-repo-java-maven/fm-doc-process-config.xml");
 
-     /**
-      * Accessor for FreemarkerDocProcessConfig configuration.
-      *
-      * @return the FreemarkerDocProcessConfig instance associated with this helper.
-      */
-     public FreemarkerDocProcessConfig getDocProcessConfig() { return this.docProcessConfig; }
+    /**
+     * Accessor for FreemarkerDocProcessConfig configuration.
+     *
+     * @return the FreemarkerDocProcessConfig instance associated with this helper.
+     */
+    public FreemarkerDocProcessConfig getDocProcessConfig() {
+        return this.docProcessConfig;
+    }
 
 }

src/test/java/test/org/fugerit/java/demo/bareminimumgithubrepojavamaven/DocHelperTest.java

@@ -29,28 +29,29 @@
  * https://github.com/fugerit-org/fj-doc
  *
  * NOTE: This is a 'Hello World' style example, adapt it to your scenario, especially :
- *  - change the doc handler and the output mode (here a ByteArrayOutputStream buffer is used)
+ * - change the doc handler and the output mode (here a ByteArrayOutputStream buffer is used)
  */
 @Slf4j
 class DocHelperTest {
 
     @Test
     void testDocProcess() throws Exception {
-        try ( ByteArrayOutputStream baos = new ByteArrayOutputStream() ) {
+        try (ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
             // creates the doc helper
             DocHelper docHelper = new DocHelper();
             // create custom data for the fremarker template 'document.ftl'
-            List<People> listPeople = Arrays.asList( new People( "Luthien", "Tinuviel", "Queen" ), new People( "Thorin", "Oakshield", "King" ) );
-            
-            
+            List<People> listPeople = Arrays.asList(new People("Luthien", "Tinuviel", "Queen"),
+                    new People("Thorin", "Oakshield", "King"));
+
             String chainId = "document";
             // handler id
             String handlerId = DocConfig.TYPE_MD;
             // output generation
-            docHelper.getDocProcessConfig().fullProcess( chainId, DocProcessContext.newContext( "listPeople", listPeople ), handlerId, baos );
+            docHelper.getDocProcessConfig().fullProcess(chainId, DocProcessContext.newContext("listPeople", listPeople),
+                    handlerId, baos);
             // print the output
-            log.info( "{} output : \n{}", handlerId, new String( baos.toByteArray(), StandardCharsets.UTF_8 ) );
-            Assertions.assertNotEquals( 0, baos.size() );
+            log.info("{} output : \n{}", handlerId, new String(baos.toByteArray(), StandardCharsets.UTF_8));
+            Assertions.assertNotEquals(0, baos.size());
         }
     }