Begin work on checkstyle

.github/workflows/checkstyle.yml

@@ -0,0 +1,15 @@
+name: checkstyle
+on: [pull_request, push, workflow_dispatch]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+        - uses: actions/checkout@v2
+        - name: Set up JDK 8
+          uses: actions/[email protected]
+          with:
+              java-version: 8
+              distribution: zulu
+        - name: Run checkstyle with Maven
+          run: mvn -Dcheckstyle.violationSeverity=warning checkstyle:check

.vscode/settings.json

@@ -1,3 +1,9 @@
 {
-    "java.configuration.updateBuildConfiguration": "interactive"
+    "java.configuration.updateBuildConfiguration": "interactive",
+    "java.format.settings.url": ".vscode/java-formatter.xml",
+    "java.checkstyle.configuration": "${workspaceFolder}\\checkstyle.xml",
+    "java.checkstyle.version": "9.3",
+    "java.checkstyle.properties": {
+        "severity": "error"
+    }
 }

checkstyle.xml

@@ -0,0 +1,55 @@
+<!DOCTYPE module PUBLIC
+  "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+  "https://checkstyle.org/dtds/configuration_1_3.dtd">
+
+<module name="Checker">
+  <property name="severity" value="warning"/>
+  <property name="cacheFile" value="target/cachefile"/>
+  <property name="fileExtensions" value="java"/>
+
+  <module name="BeforeExecutionExclusionFileFilter">
+    <property name="fileNamePattern" value=".*[\\/]src[\\/]main[\\/]java[\\/]io[\\/]github[\\/]arrayv[\\/]sorts.*$"/>
+  </module>
+
+  <module name="NewlineAtEndOfFile"/>
+
+  <module name="TreeWalker">
+    <module name="SuppressionCommentFilter">
+      <property name="offCommentFormat" value="@checkstyle\:off ([\w\|]+)"/>
+      <property name="onCommentFormat" value="@checkstyle\:on ([\w\|]+)"/>
+      <property name="checkFormat" value="$1"/>
+    </module>
+    <module name="SuppressionCommentFilter">
+      <!-- This second one allows for general exclusions -->
+      <property name="offCommentFormat" value="@checkstyle\:off"/>
+      <property name="onCommentFormat" value="@checkstyle\:on"/>
+    </module>
+
+    <!-- Enforces that constants are in SHOUTING_SNAKE_CASE -->
+    <module name="ConstantName"/>
+
+    <!-- Handles the mistake described here: https://checkstyle.sourceforge.io/config_coding.html#CovariantEquals_Description -->
+    <module name="CovariantEquals"/>
+
+    <module name="FinalClass"/>
+
+    <module name="GenericWhitespace"/>
+
+    <module name="HideUtilityClassConstructor"/>
+
+    <module name="Indentation">
+      <property name="basicOffset" value="4"/>
+    </module>
+
+    <module name="InvalidJavadocPosition"/>
+
+    <module name="JavadocMissingLeadingAsterisk"/>
+
+    <module name="JavadocMissingWhitespaceAfterAsterisk"/>
+
+    <module name="LeftCurly">
+      <property name="option" value="eol"/>
+      <property name="ignoreEnums" value="false"/>
+    </module>
+  </module>
+</module>

pom.xml

@@ -108,8 +108,25 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+        <version>3.1.2</version>
+        <configuration>
+          <configLocation>checkstyle.xml</configLocation>
+          <consoleOutput>true</consoleOutput>
+          <failsOnError>true</failsOnError>
+        </configuration>
+        <dependencies>
+          <dependency>
+            <groupId>com.puppycrawl.tools</groupId>
+            <artifactId>checkstyle</artifactId>
+            <version>9.3</version>
+          </dependency>
+        </dependencies>
+      </plugin>
     </plugins>
-    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
+    <pluginManagement>
       <plugins>
         <plugin>
           <artifactId>maven-clean-plugin</artifactId>

src/main/java/io/github/arrayv/threads/RunSort.java

@@ -196,7 +196,7 @@ public void run() {
                                 if (warning == 0) goAhead = true;
                                 else goAhead = false;
                             }
-                    }
+                        }
                     } else {
                         goAhead = true;
                     }

src/main/java/io/github/arrayv/visuals/Visual.java

@@ -65,62 +65,68 @@ public static void setRectColor(Graphics2D rect, boolean color, boolean analysis
     //The longer the array length, the more bars marked. Makes the visual easier to see when bars are thinner.
     public static void colorMarkedBars(int logOfLen, int index, Highlights Highlights, Graphics2D mainRender, boolean colorEnabled, boolean rainbowEnabled, boolean analysis) {
         switch(logOfLen) {
-        case 15: if (Highlights.containsPosition(index - 15)) { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-                 if (Highlights.containsPosition(index - 14)) { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-                 if (Highlights.containsPosition(index - 13)) { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-                 if (Highlights.containsPosition(index - 12)) { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-                 if (Highlights.containsPosition(index - 11)) { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-        case 14: if (Highlights.containsPosition(index - 10)) { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-                 if (Highlights.containsPosition(index - 9))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-                 if (Highlights.containsPosition(index - 8))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-        case 13: if (Highlights.containsPosition(index - 7))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-                 if (Highlights.containsPosition(index - 6))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-                 if (Highlights.containsPosition(index - 5))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-        case 12: if (Highlights.containsPosition(index - 4))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-                 if (Highlights.containsPosition(index - 3))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-        case 11: if (Highlights.containsPosition(index - 2))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-        case 10: if (Highlights.containsPosition(index - 1))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
-        default: if (Highlights.containsPosition(index))        markBar(mainRender, colorEnabled, rainbowEnabled, analysis);
+            // @checkstyle:off LeftCurlyCheck
+            case 15: if (Highlights.containsPosition(index - 15)) { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+                     if (Highlights.containsPosition(index - 14)) { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+                     if (Highlights.containsPosition(index - 13)) { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+                     if (Highlights.containsPosition(index - 12)) { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+                     if (Highlights.containsPosition(index - 11)) { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+            case 14: if (Highlights.containsPosition(index - 10)) { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+                     if (Highlights.containsPosition(index - 9))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+                     if (Highlights.containsPosition(index - 8))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+            case 13: if (Highlights.containsPosition(index - 7))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+                     if (Highlights.containsPosition(index - 6))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+                     if (Highlights.containsPosition(index - 5))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+            case 12: if (Highlights.containsPosition(index - 4))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+                     if (Highlights.containsPosition(index - 3))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+            case 11: if (Highlights.containsPosition(index - 2))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+            case 10: if (Highlights.containsPosition(index - 1))  { markBar(mainRender, colorEnabled, rainbowEnabled, analysis); break; }
+            default: if (Highlights.containsPosition(index))        markBar(mainRender, colorEnabled, rainbowEnabled, analysis);
+            // @checkstyle:on LeftCurlyCheck
         }
     }
 
     public static void drawFancyFinish(int logOfLen, int index, int position, Graphics2D mainRender, boolean colorEnabled, boolean rainbowEnabled) {
         switch(logOfLen) {
-        case 15: if (index == position - 14) { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 14: if (index == position - 13) { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 13: if (index == position - 12) { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 12: if (index == position - 11) { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 11: if (index == position - 10) { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 10: if (index == position - 9)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 9:  if (index == position - 8)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 8:  if (index == position - 7)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 7:  if (index == position - 6)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 6:  if (index == position - 5)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 5:  if (index == position - 4)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 4:  if (index == position - 3)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 3:  if (index == position - 2)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        case 2:  if (index == position - 1)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
-        default: if (index == position)        markBarFancy(mainRender, colorEnabled, rainbowEnabled);
+            // @checkstyle:off LeftCurlyCheck
+            case 15: if (index == position - 14) { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 14: if (index == position - 13) { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 13: if (index == position - 12) { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 12: if (index == position - 11) { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 11: if (index == position - 10) { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 10: if (index == position - 9)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 9:  if (index == position - 8)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 8:  if (index == position - 7)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 7:  if (index == position - 6)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 6:  if (index == position - 5)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 5:  if (index == position - 4)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 4:  if (index == position - 3)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 3:  if (index == position - 2)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            case 2:  if (index == position - 1)  { markBarFancy(mainRender, colorEnabled, rainbowEnabled); break; }
+            default: if (index == position)        markBarFancy(mainRender, colorEnabled, rainbowEnabled);
+            // @checkstyle:on LeftCurlyCheck
         }
     }
 
     public static void drawFancyFinishLine(int logOfLen, int index, int position, Graphics2D mainRender, double width, boolean colorEnabled) {
         switch(logOfLen) {
-        case 15: if (index == position - 14) { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 14: if (index == position - 13) { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 13: if (index == position - 12) { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 12: if (index == position - 11) { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 11: if (index == position - 10) { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 10: if (index == position - 9)  { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 9:  if (index == position - 8)  { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 8:  if (index == position - 7)  { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 7:  if (index == position - 6)  { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 6:  if (index == position - 5)  { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 5:  if (index == position - 4)  { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 4:  if (index == position - 3)  { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 3:  if (index == position - 2)  { lineMark(mainRender, width, colorEnabled, false); break; }
-        case 2:  if (index == position - 1)  { lineMark(mainRender, width, colorEnabled, false); break; }
-        default: if (index == position)        lineMark(mainRender, width, colorEnabled, false);
+            // @checkstyle:off LeftCurlyCheck
+            case 15: if (index == position - 14) { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 14: if (index == position - 13) { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 13: if (index == position - 12) { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 12: if (index == position - 11) { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 11: if (index == position - 10) { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 10: if (index == position - 9)  { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 9:  if (index == position - 8)  { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 8:  if (index == position - 7)  { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 7:  if (index == position - 6)  { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 6:  if (index == position - 5)  { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 5:  if (index == position - 4)  { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 4:  if (index == position - 3)  { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 3:  if (index == position - 2)  { lineMark(mainRender, width, colorEnabled, false); break; }
+            case 2:  if (index == position - 1)  { lineMark(mainRender, width, colorEnabled, false); break; }
+            default: if (index == position)        lineMark(mainRender, width, colorEnabled, false);
+            // @checkstyle:on LeftCurlyCheck
         }
     }