Add checkstyle (FabricMC#460)

NebelNidas · Sep 14, 2022 · 9c73684 · 9c73684
1 parent 0a80622
commit 9c73684
Show file tree

Hide file tree

Showing 328 changed files with 7,514 additions and 6,406 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,5 @@
+[*.{gradle,java,kotlin}]
+indent_style = tab
+ij_continuation_indent_size = 8
+ij_java_imports_layout = $*, |, java.**, |, javax.**, |, *, |, cuchaz.enigma.**
+ij_java_class_count_to_use_import_on_demand = 999
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,10 +1,10 @@
 name: Build
-on: [push, pull_request]
+on: [ push, pull_request ]
 jobs:
   build:
     strategy:
       matrix:
-        java: [17-jdk]
+        java: [ 17-jdk ]
     runs-on: ubuntu-20.04
     container:
       image: openjdk:${{ matrix.java }}
@@ -13,3 +13,8 @@ jobs:
       - uses: actions/checkout@v1
       - uses: gradle/wrapper-validation-action@v1
       - run: ./gradlew build --stacktrace --warning-mode fail
+      - uses: Juuxel/publish-checkstyle-report@v1
+        if: ${{ failure() }}
+        with:
+          reports: |
+            **/build/reports/checkstyle/*.xml
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,5 +1,5 @@
 name: Release
-on: [workflow_dispatch] # Manual trigger
+on: [ workflow_dispatch ] # Manual trigger
 jobs:
   build:
     runs-on: ubuntu-20.04

diff --git a/README.md b/README.md
@@ -7,13 +7,14 @@ A tool for deobfuscation of Java bytecode. Forked from <https://bitbucket.org/cu
 Enigma is distributed under the [LGPL-3.0](LICENSE).
 
 Enigma includes the following open-source libraries:
- - A [modified version](https://github.com/FabricMC/procyon) of [Procyon](https://bitbucket.org/mstrobel/procyon) (Apache-2.0)
- - A [modified version](https://github.com/FabricMC/cfr) of [CFR](https://github.com/leibnitz27/cfr) (MIT)
- - [Guava](https://github.com/google/guava) (Apache-2.0)
- - [SyntaxPane](https://github.com/Sciss/SyntaxPane) (Apache-2.0)
- - [FlatLaf](https://github.com/JFormDesigner/FlatLaf) (Apache-2.0)
- - [jopt-simple](https://github.com/jopt-simple/jopt-simple) (MIT)
- - [ASM](https://asm.ow2.io/) (BSD-3-Clause)
+
+- A [modified version](https://github.com/FabricMC/procyon) of [Procyon](https://bitbucket.org/mstrobel/procyon) (Apache-2.0)
+- A [modified version](https://github.com/FabricMC/cfr) of [CFR](https://github.com/leibnitz27/cfr) (MIT)
+- [Guava](https://github.com/google/guava) (Apache-2.0)
+- [SyntaxPane](https://github.com/Sciss/SyntaxPane) (Apache-2.0)
+- [FlatLaf](https://github.com/JFormDesigner/FlatLaf) (Apache-2.0)
+- [jopt-simple](https://github.com/jopt-simple/jopt-simple) (MIT)
+- [ASM](https://asm.ow2.io/) (BSD-3-Clause)
 
 ## Usage
 

diff --git a/build.gradle b/build.gradle
@@ -1,89 +1,95 @@
 plugins {
-    id 'maven-publish'
+	id 'maven-publish'
 }
 
 subprojects {
-    apply plugin: 'java'
-    apply plugin: 'maven-publish'
-
-    sourceCompatibility = JavaVersion.VERSION_17
-    targetCompatibility = JavaVersion.VERSION_17
-
-    repositories {
-        mavenLocal()
-        mavenCentral()
-        maven { url 'https://maven.fabricmc.net/' }
-    }
-
-    dependencies {
-        implementation 'com.google.guava:guava:30.1.1-jre'
-        implementation 'com.google.code.gson:gson:2.8.7'
-
-        testImplementation 'junit:junit:4.13.2'
-        testImplementation 'org.hamcrest:hamcrest:2.2'
-    }
-
-    group = 'cuchaz'
-    version = '2.1.0'
-
-    version = version + (System.getenv("GITHUB_ACTIONS") ? "" : "+local")
-
-    task sourcesJar(type: Jar, dependsOn: classes) {
-        classifier = 'sources'
-        from sourceSets.main.allSource
-    }
-
-    java {
-        withSourcesJar()
-    }
-
-    tasks.withType(JavaCompile).configureEach {
-        it.options.encoding = "UTF-8"
-
-        it.options.release = 17
-    }
-
-    publishing {
-        publications {
-            "$project.name"(MavenPublication) {
-                groupId project.group
-                artifactId project.name
-                version project.version
-                from components.java
-            }
-        }
-    }
+	apply plugin: 'java'
+	apply plugin: 'maven-publish'
+	apply plugin: 'checkstyle'
+
+	sourceCompatibility = JavaVersion.VERSION_17
+	targetCompatibility = JavaVersion.VERSION_17
+
+	repositories {
+		mavenLocal()
+		mavenCentral()
+		maven { url 'https://maven.fabricmc.net/' }
+	}
+
+	dependencies {
+		implementation 'com.google.guava:guava:30.1.1-jre'
+		implementation 'com.google.code.gson:gson:2.8.7'
+
+		testImplementation 'junit:junit:4.13.2'
+		testImplementation 'org.hamcrest:hamcrest:2.2'
+	}
+
+	group = 'cuchaz'
+	version = '2.1.1'
+
+	version = version + (System.getenv("GITHUB_ACTIONS") ? "" : "+local")
+
+	task sourcesJar(type: Jar, dependsOn: classes) {
+		classifier = 'sources'
+		from sourceSets.main.allSource
+	}
+
+	java {
+		withSourcesJar()
+	}
+
+	tasks.withType(JavaCompile).configureEach {
+		it.options.encoding = "UTF-8"
+
+		it.options.release = 17
+	}
+
+	checkstyle {
+		configFile = rootProject.file('checkstyle.xml')
+		toolVersion = '10.3.3'
+	}
+
+	publishing {
+		publications {
+			"$project.name"(MavenPublication) {
+				groupId project.group
+				artifactId project.name
+				version project.version
+				from components.java
+			}
+		}
+	}
 }
 
 allprojects {
-    publishing {
-        repositories {
-            mavenLocal()
-
-            def ENV = System.getenv()
-            if (ENV.MAVEN_URL) {
-                maven {
-                    url ENV.MAVEN_URL
-                    credentials {
-                        username ENV.MAVEN_USERNAME
-                        password ENV.MAVEN_PASSWORD
-                    }
-                }
-            }
-        }
-    }
+	publishing {
+		repositories {
+			mavenLocal()
+
+			def ENV = System.getenv()
+			if (ENV.MAVEN_URL) {
+				maven {
+					url ENV.MAVEN_URL
+					credentials {
+						username ENV.MAVEN_USERNAME
+						password ENV.MAVEN_PASSWORD
+					}
+				}
+			}
+		}
+	}
 }
 
 // A task to ensure that the version being released has not already been released.
 task checkVersion {
-    doFirst {
-        def xml = new URL("https://maven.fabricmc.net/cuchaz/enigma/maven-metadata.xml").text
-        def metadata = new XmlSlurper().parseText(xml)
-        def versions = metadata.versioning.versions.version*.text();
-        if (versions.contains(version)) {
-            throw new RuntimeException("${version} has already been released!")
-        }
-    }
+	doFirst {
+		def xml = new URL("https://maven.fabricmc.net/cuchaz/enigma/maven-metadata.xml").text
+		def metadata = new XmlSlurper().parseText(xml)
+		def versions = metadata.versioning.versions.version*.text();
+		if (versions.contains(version)) {
+			throw new RuntimeException("${version} has already been released!")
+		}
+	}
 }
 
 publish.mustRunAfter checkVersion
diff --git a/checkstyle.xml b/checkstyle.xml
@@ -0,0 +1,170 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
+<module name="Checker">
+    <property name="charset" value="UTF-8"/>
+    <property name="fileExtensions" value="java"/>
+    <property name="localeLanguage" value="en"/>
+    <property name="localeCountry" value="US"/>
+
+    <module name="NewlineAtEndOfFile"/>
+
+    <!-- disallow trailing whitespace -->
+    <module name="RegexpSingleline">
+        <property name="format" value="\s+$"/>
+        <property name="message" value="trailing whitespace"/>
+    </module>
+
+    <!-- note: RegexpMultiline shows nicer messages than Regexp, but has to be outside TreeWalker -->
+    <!-- disallow multiple consecutive blank lines -->
+    <module name="RegexpMultiline">
+        <property name="format" value="\n[\t ]*\r?\n[\t ]*\r?\n"/>
+        <property name="message" value="adjacent blank lines"/>
+    </module>
+
+    <!-- disallow blank after { -->
+    <module name="RegexpMultiline">
+        <property name="format" value="\{[\t ]*\r?\n[\t ]*\r?\n"/>
+        <property name="message" value="blank line after '{'"/>
+    </module>
+
+    <!-- disallow blank before } -->
+    <module name="RegexpMultiline">
+        <property name="format" value="\n[\t ]*\r?\n[\t ]*\}"/>
+        <property name="message" value="blank line before '}'"/>
+    </module>
+
+    <!-- require blank before { in the same indentation level -->
+    <module name="RegexpMultiline">
+        <!-- the regex works as follows:
+        It matches (=fails) for \n<indentation><something>\n<same indentation><control statement>[...]{\n
+        while <something> is a single line comment, it'll look for a blank line one line earlier
+        if <something> is a space, indicating a formatting error or ' */', it'll ignore the instance
+        if <something> is a tab, indicating a continued line, it'll ignore the instance
+        <control statement> is 'if', 'do', 'while', 'for', 'try' or nothing (instance initializer block)
+
+        - first \n: with positive lookbehind (?<=\n) to move the error marker to a more reasonable place
+        - capture tabs for <indentation>, later referenced via \1
+        - remaining preceding line as a non-comment (doesn't start with '/', '//', ' ' or '\t') or multiple lines where all but the first are a single line comment with the same indentation
+        - new line
+        - <indentation> as captured earlier
+        - <control statement> as specified above
+        - { before the next new line -->
+        <property name="format" value="(?&lt;=\n)([\t]+)(?:[^/\r\n \t][^\r\n]*|/[^/\r\n][^\r\n]*|[^/\r\n][^\r\n]*(\r?\n\1//[^\r\n]*)+)\r?\n\1(|(if|do|while|for|try)[^\r\n]+)\{[\t ]*\r?\n"/>
+        <property name="message" value="missing blank line before block at same indentation level"/>
+    </module>
+
+    <!-- require blank after } in the same indentation level -->
+    <module name="RegexpMultiline">
+        <!-- \n<indentation>}\n<same indentation><whatever unless newline, '}' or starting with cas(e) or def(ault)> -->
+        <property name="format" value="(?&lt;=\n)([\t]+)\}\r?\n\1(?:[^\r\n\}cd]|c[^\r\na]|ca[^\r\ns]|d[^\r\ne]|de[^\r\nf])"/>
+        <property name="message" value="missing blank line after block at same indentation level"/>
+    </module>
+
+    <module name="TreeWalker">
+        <!-- Ensure all imports are ship shape -->
+        <module name="AvoidStarImport"/>
+        <module name="IllegalImport"/>
+        <module name="RedundantImport"/>
+        <module name="UnusedImports"/>
+
+        <module name="ImportOrder">
+            <property name="groups" value="java,javax,*,cuchaz.enigma"/>
+            <property name="ordered" value="false"/><!-- the plugin orders alphabetically without considering separators.. -->
+            <property name="separated" value="true"/>
+            <property name="option" value="top"/>
+            <property name="sortStaticImportsAlphabetically" value="true"/>
+        </module>
+
+        <!-- Ensures braces are at the end of a line -->
+        <module name="LeftCurly"/>
+        <module name="RightCurly"/>
+
+        <!-- single line statements on one line, -->
+        <module name="NeedBraces">
+            <property name="tokens" value="LITERAL_IF,LITERAL_FOR,LITERAL_WHILE"/>
+            <property name="allowSingleLineStatement" value="true"/>
+        </module>
+        <module name="NeedBraces">
+            <property name="tokens" value="LITERAL_ELSE,LITERAL_DO"/>
+            <property name="allowSingleLineStatement" value="false"/>
+        </module>
+
+        <module name="EmptyLineSeparator">
+            <property name="allowNoEmptyLineBetweenFields" value="true"/>
+            <property name="allowMultipleEmptyLines" value="false"/>
+            <!-- exclude  METHOD_DEF and VARIABLE_DEF -->
+            <property name="tokens" value="PACKAGE_DEF,IMPORT,STATIC_IMPORT,CLASS_DEF,INTERFACE_DEF,ENUM_DEF,STATIC_INIT,INSTANCE_INIT,CTOR_DEF"/>
+        </module>
+
+        <module name="OperatorWrap"/>
+        <module name="SeparatorWrap">
+            <property name="tokens" value="DOT,ELLIPSIS,AT"/>
+            <property name="option" value="nl"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="tokens" value="COMMA,SEMI"/>
+            <property name="option" value="eol"/>
+        </module>
+
+        <module name="Indentation">
+            <property name="basicOffset" value="8"/>
+            <property name="caseIndent" value="0"/>
+            <property name="throwsIndent" value="8"/>
+            <property name="arrayInitIndent" value="8"/>
+            <property name="lineWrappingIndentation" value="16"/>
+        </module>
+
+        <module name="ParenPad"/>
+        <module name="NoWhitespaceBefore"/>
+        <module name="NoWhitespaceAfter">
+            <!-- allow ARRAY_INIT -->
+            <property name="tokens" value="AT,INC,DEC,UNARY_MINUS,UNARY_PLUS,BNOT,LNOT,DOT,ARRAY_DECLARATOR,INDEX_OP"/>
+        </module>
+        <module name="WhitespaceAfter"/>
+        <module name="WhitespaceAround">
+            <!-- Allow PLUS, MINUS, MUL, DIV as they may be more readable without spaces in some cases -->
+            <property name="tokens"
+                      value="ASSIGN,BAND,BAND_ASSIGN,BOR,BOR_ASSIGN,BSR,BSR_ASSIGN,BXOR,BXOR_ASSIGN,COLON,DIV_ASSIGN,DO_WHILE,EQUAL,GE,GT,LAMBDA,LAND,LCURLY,LE,LITERAL_CATCH,LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_FOR,LITERAL_IF,LITERAL_RETURN,LITERAL_SWITCH,LITERAL_SYNCHRONIZED,LITERAL_TRY,LITERAL_WHILE,LOR,LT,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS_ASSIGN,QUESTION,RCURLY,SL,SLIST,SL_ASSIGN,SR,SR_ASSIGN,STAR,STAR_ASSIGN,LITERAL_ASSERT,TYPE_EXTENSION_AND"/>
+        </module>
+        <module name="SingleSpaceSeparator"/>
+        <module name="GenericWhitespace"/>
+        <module name="CommentsIndentation"/>
+
+        <module name="ArrayTypeStyle"/>
+        <module name="DefaultComesLast">
+            <property name="skipIfLastAndSharedWithCase" value="true"/>
+        </module>
+        <module name="SimplifyBooleanExpression"/>
+        <module name="SimplifyBooleanReturn"/>
+        <module name="StringLiteralEquality"/>
+
+        <module name="ModifierOrder"/>
+        <module name="RedundantModifier"/>
+
+        <module name="AnnotationLocation"/>
+        <module name="MissingOverride"/>
+
+        <!-- By default this allows catch blocks with only comments -->
+        <module name="EmptyCatchBlock"/>
+
+        <!-- Enforce tabs -->
+        <module name="RegexpSinglelineJava">
+            <property name="format" value="^\t* ([^*]|\*[^ /])"/>
+            <property name="message" value="non-tab indentation"/>
+        </module>
+
+        <module name="OuterTypeFilename"/>
+
+        <!--<module name="InvalidJavadocPosition"/>-->
+        <module name="JavadocParagraph"/>
+        <module name="JavadocStyle"/>
+        <module name="AtclauseOrder">
+            <property name="tagOrder" value="@param,@return,@throws,@deprecated"/>
+        </module>
+
+        <!-- Prevent var for all cases other than new instance creation -->
+        <module name="MatchXpath">
+            <property name="query" value="//VARIABLE_DEF[./TYPE/IDENT[@text='var'] and not(./ASSIGN/EXPR/LITERAL_NEW)]"/>
+        </module>
+    </module>
+</module>