Merge pull request #916 from hazendaz/main

[ci] formatting based on current rules
revelc · Jul 14, 2024 · 0fc0e11 · 0fc0e11
2 parents bfa9cb1 + 827f23d
commit 0fc0e11
Show file tree

Hide file tree

Showing 12 changed files with 26 additions and 47 deletions.
diff --git a/pom.xml b/pom.xml
@@ -68,7 +68,6 @@
       <url>scm:git:ssh://[email protected]/revelc/formatter-maven-plugin.git</url>
     </site>
   </distributionManagement>
-
   <properties>
     <formatter.configFile>${project.basedir}/src/main/resources/formatter-maven-plugin/eclipse/java.xml</formatter.configFile>
     <formatter.css.skip>true</formatter.css.skip>
@@ -82,11 +81,10 @@
     <impsort.groups>java.,javax.,org.,com.,net.</impsort.groups>
     <javadoc.doclint>all</javadoc.doclint>
     <maven.compiler.release>17</maven.compiler.release>
-
     <!-- Remove the following after next parent update includes these major updates -->
+    <maven.site.deploy.skip>false</maven.site.deploy.skip>
     <version.maven-fluido-skin>2.0.0-M9</version.maven-fluido-skin>
     <version.maven-site-plugin>4.0.0-M15</version.maven-site-plugin>
-    <maven.site.deploy.skip>false</maven.site.deploy.skip>
   </properties>
   <dependencyManagement>
     <dependencies>

diff --git a/src/main/java/net/revelc/code/formatter/AbstractCacheableFormatter.java b/src/main/java/net/revelc/code/formatter/AbstractCacheableFormatter.java
@@ -130,7 +130,7 @@ private static String fixLineEnding(String code, final LineEnding ending) {
 
     /**
      * Do format.
-     *
+     * <p>
      * notice that when calling this function, {@code ending} here MUST equals lineending in config when
      * {@link #init(Map, ConfigurationSource)} init.
      *

diff --git a/src/main/java/net/revelc/code/formatter/FormatterMojo.java b/src/main/java/net/revelc/code/formatter/FormatterMojo.java
@@ -775,7 +775,8 @@ protected void doFormatFile(final File file, final ResultCollector rc, final Pro
 
         // Process the result type
         if (Result.SKIPPED.equals(result)) {
-            // Use unchanged count for files that either 'skipFormattingCache' or cache missed but flagged to skip formatting.
+            // Use unchanged count for files that either 'skipFormattingCache' or cache missed but flagged to skip
+            // formatting.
             rc.unchangedCount++;
         } else if (Result.SUCCESS.equals(result)) {
             rc.successCount++;
@@ -1112,7 +1113,10 @@ static class ResultCollector {
         /** The skipped count is incremented for cached files that haven't changed since being cached. */
         int skippedCount;
 
-        /** Use unchanged count for files that either 'skipFormattingCache' or cache missed but flagged to skip formatting. */
+        /**
+         * Use unchanged count for files that either 'skipFormattingCache' or cache missed but flagged to skip
+         * formatting.
+         */
         int unchangedCount;
 
         /** The read only count. */

diff --git a/src/test/java/net/revelc/code/formatter/AbstractFormatterTest.java b/src/test/java/net/revelc/code/formatter/AbstractFormatterTest.java
@@ -200,16 +200,16 @@ private void doTestFormat(final Map<String, String> options, final Formatter for
         // Set the used output directory for test (either first pass or second pass)
         File testOutputDir;
         switch (formatCycle) {
-        case 1:
-            resourceLocation = AbstractFormatterTest.RESOURCE_LOCATION_PRIMARY;
-            testOutputDir = AbstractFormatterTest.TEST_OUTPUT_PRIMARY_DIR;
-            break;
-        case 2:
-            resourceLocation = AbstractFormatterTest.RESOURCE_LOCATION_SECONDARY;
-            testOutputDir = AbstractFormatterTest.TEST_OUTPUT_SECONDARY_DIR;
-            break;
-        default:
-            throw new IllegalStateException("Unrecognized format cycle: " + formatCycle);
+            case 1:
+                resourceLocation = AbstractFormatterTest.RESOURCE_LOCATION_PRIMARY;
+                testOutputDir = AbstractFormatterTest.TEST_OUTPUT_PRIMARY_DIR;
+                break;
+            case 2:
+                resourceLocation = AbstractFormatterTest.RESOURCE_LOCATION_SECONDARY;
+                testOutputDir = AbstractFormatterTest.TEST_OUTPUT_SECONDARY_DIR;
+                break;
+            default:
+                throw new IllegalStateException("Unrecognized format cycle: " + formatCycle);
         }
 
         // Set original file and file to use for test
@@ -234,14 +234,14 @@ private void doTestFormat(final Map<String, String> options, final Formatter for
         // Run assertions on formatted file, if not valid, reject and tester can look at resulting files
         // to debug issue.
         switch (formatCycle) {
-        case 1:
-            Assertions.assertNotEquals(originalCode, formattedCode);
-            break;
-        case 2:
-            Assertions.assertEquals(originalCode, formattedCode);
-            break;
-        default:
-            throw new IllegalStateException("Unrecognized format cycle: " + formatCycle);
+            case 1:
+                Assertions.assertNotEquals(originalCode, formattedCode);
+                break;
+            case 2:
+                Assertions.assertEquals(originalCode, formattedCode);
+                break;
+            default:
+                throw new IllegalStateException("Unrecognized format cycle: " + formatCycle);
         }
 
         // We are hashing this as set in stone in case for some reason our source file changes unexpectedly.

diff --git a/src/test/java/net/revelc/code/formatter/LineEndingTest.java b/src/test/java/net/revelc/code/formatter/LineEndingTest.java
@@ -24,7 +24,6 @@ class LineEndingTest {
 
     /**
      * Test successfully determining CRLF line ending.
-     *
      */
     @Test
     void test_success_read_line_endings_crlf() {
@@ -35,7 +34,6 @@ void test_success_read_line_endings_crlf() {
 
     /**
      * Test successfully determining LF line ending.
-     *
      */
     @Test
     void test_success_read_line_endings_lf() {
@@ -46,7 +44,6 @@ void test_success_read_line_endings_lf() {
 
     /**
      * Test successfully determining CR line ending.
-     *
      */
     @Test
     void test_success_read_line_endings_cr() {
@@ -57,7 +54,6 @@ void test_success_read_line_endings_cr() {
 
     /**
      * Test successfully determining LF line ending with mixed endings.
-     *
      */
     @Test
     void test_success_read_line_endings_mixed_lf() {
@@ -68,7 +64,6 @@ void test_success_read_line_endings_mixed_lf() {
 
     /**
      * Test successfully determining AUTO line ending with mixed endings and no clear majority.
-     *
      */
     @Test
     void test_success_read_line_endings_mixed_auto() {
@@ -79,7 +74,6 @@ void test_success_read_line_endings_mixed_auto() {
 
     /**
      * Test successfully determining AUTO line ending with no endings.
-     *
      */
     @Test
     void test_success_read_line_endings_none_auto() {

diff --git a/src/test/java/net/revelc/code/formatter/TimeUtilTest.java b/src/test/java/net/revelc/code/formatter/TimeUtilTest.java
@@ -24,7 +24,6 @@ class TimeUtilTest {
 
     /**
      * Test print duration.
-     *
      */
     @Test
     void testPrintDuration() {

diff --git a/src/test/java/net/revelc/code/formatter/css/CssFormatterTest.java b/src/test/java/net/revelc/code/formatter/css/CssFormatterTest.java
@@ -29,7 +29,6 @@ class CssFormatterTest extends AbstractFormatterTest {
 
     /**
      * Test do format file.
-     *
      */
     @Test
     void testDoFormatFile() {
@@ -43,7 +42,6 @@ void testDoFormatFile() {
 
     /**
      * Test is initialized.
-     *
      */
     @Test
     void testIsInitialized() {

diff --git a/src/test/java/net/revelc/code/formatter/html/HTMLFormatterTest.java b/src/test/java/net/revelc/code/formatter/html/HTMLFormatterTest.java
@@ -29,7 +29,6 @@ class HTMLFormatterTest extends AbstractFormatterTest {
 
     /**
      * Test do format file.
-     *
      */
     @Test
     void testDoFormatFile() {
@@ -43,7 +42,6 @@ void testDoFormatFile() {
 
     /**
      * Test is initialized.
-     *
      */
     @Test
     void testIsInitialized() {

diff --git a/src/test/java/net/revelc/code/formatter/java/JavaFormatterTest.java b/src/test/java/net/revelc/code/formatter/java/JavaFormatterTest.java
@@ -29,7 +29,6 @@ class JavaFormatterTest extends AbstractFormatterTest {
 
     /**
      * Test do format file.
-     *
      */
     @Test
     void testDoFormatFile() {
@@ -42,7 +41,6 @@ void testDoFormatFile() {
 
     /**
      * Test do format file keep line feed LF.
-     *
      */
     @Test
     void testDoFormatFileKeepLineFeedLF() {
@@ -52,7 +50,6 @@ void testDoFormatFileKeepLineFeedLF() {
 
     /**
      * Test do format file keep line feed CR.
-     *
      */
     @Test
     void testDoFormatFileKeepLineFeedCR() {
@@ -62,7 +59,6 @@ void testDoFormatFileKeepLineFeedCR() {
 
     /**
      * Test do format file keep line feed CRLF.
-     *
      */
     @Test
     void testDoFormatFileKeepLineFeedCRLF() {
@@ -73,7 +69,6 @@ void testDoFormatFileKeepLineFeedCRLF() {
 
     /**
      * Test is initialized.
-     *
      */
     @Test
     void testIsInitialized() {
@@ -86,7 +81,6 @@ void testIsInitialized() {
 
     /**
      * Test do format file with exclusions.
-     *
      */
     @Test
     void testDoFormatFileWithExclusions() {

diff --git a/src/test/java/net/revelc/code/formatter/javascript/JavascriptFormatterTest.java b/src/test/java/net/revelc/code/formatter/javascript/JavascriptFormatterTest.java
@@ -29,7 +29,6 @@ class JavascriptFormatterTest extends AbstractFormatterTest {
 
     /**
      * Test do format file.
-     *
      */
     @Test
     void testDoFormatFile() {
@@ -42,7 +41,6 @@ void testDoFormatFile() {
 
     /**
      * Test is initialized.
-     *
      */
     @Test
     void testIsInitialized() {

diff --git a/src/test/java/net/revelc/code/formatter/json/JsonFormatterTest.java b/src/test/java/net/revelc/code/formatter/json/JsonFormatterTest.java
@@ -36,7 +36,6 @@ class JsonFormatterTest extends AbstractFormatterTest {
 
     /**
      * Test do format file.
-     *
      */
     @Test
     void testDoFormatFile() {
@@ -64,7 +63,6 @@ void testIsInitialized() {
 
     /**
      * Test do format file with config.
-     *
      */
     @Test
     void testDoFormatFileWithConfig() {

diff --git a/src/test/java/net/revelc/code/formatter/xml/XMLFormatterTest.java b/src/test/java/net/revelc/code/formatter/xml/XMLFormatterTest.java
@@ -29,7 +29,6 @@ class XMLFormatterTest extends AbstractFormatterTest {
 
     /**
      * Test do format file.
-     *
      */
     @Test
     void testDoFormatFile() {
@@ -45,7 +44,6 @@ void testDoFormatFile() {
 
     /**
      * Test is initialized.
-     *
      */
     @Test
     void testIsInitialized() {
-Original file line number
+Diff line change
@@ Expand Up @@
         /**
          * Do format.
-         *
+         * <p>
          * notice that when calling this function, {@code ending} here MUST equals lineending in config when
          * {@link #init(Map, ConfigurationSource)} init.
          *
@@ Expand Down @@