From 6c7f613f505217f94311d2a67bc957ad24620dee Mon Sep 17 00:00:00 2001
From: Uko Kokņevičs
Date: Tue, 20 May 2025 05:00:55 +0300
Subject: Initial commit

---
 .../enes/buildstuffs/checkstyle-suppressions.xml   |  11 +
 .../resources/lv/enes/buildstuffs/checkstyle.xml   | 223 +++++++++++++++++++++
 .../resources/lv/enes/buildstuffs/pmd-rules.xml    | 126 ++++++++++++
 .../lv/enes/buildstuffs/spotbugs-exclude.xml       |  46 +++++
 4 files changed, 406 insertions(+)
 create mode 100644 buildstuffs/src/main/resources/lv/enes/buildstuffs/checkstyle-suppressions.xml
 create mode 100644 buildstuffs/src/main/resources/lv/enes/buildstuffs/checkstyle.xml
 create mode 100644 buildstuffs/src/main/resources/lv/enes/buildstuffs/pmd-rules.xml
 create mode 100644 buildstuffs/src/main/resources/lv/enes/buildstuffs/spotbugs-exclude.xml

(limited to 'buildstuffs/src/main')

diff --git a/buildstuffs/src/main/resources/lv/enes/buildstuffs/checkstyle-suppressions.xml b/buildstuffs/src/main/resources/lv/enes/buildstuffs/checkstyle-suppressions.xml
new file mode 100644
index 0000000..dbf0b1f
--- /dev/null
+++ b/buildstuffs/src/main/resources/lv/enes/buildstuffs/checkstyle-suppressions.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ SPDX-License-Identifier: AGPL-3.0-or-later
+ SPDX-FileCopyrightText: 2025 Uko Kokņevičs <perkontevs@gmail.com>
+ -->
+<!DOCTYPE suppressions PUBLIC
+    "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+    "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+<suppressions>
+  <suppress files="[/\\]target[/\\]generated-sources[/\\]" checks=".*"/>
+</suppressions>
diff --git a/buildstuffs/src/main/resources/lv/enes/buildstuffs/checkstyle.xml b/buildstuffs/src/main/resources/lv/enes/buildstuffs/checkstyle.xml
new file mode 100644
index 0000000..6680d5d
--- /dev/null
+++ b/buildstuffs/src/main/resources/lv/enes/buildstuffs/checkstyle.xml
@@ -0,0 +1,223 @@
+<?xml version="1.0"?>
+<!--
+ SPDX-License-Identifier: AGPL-3.0-or-later
+ SPDX-FileCopyrightText: 2025 Uko Kokņevičs <perkontevs@gmail.com>
+ -->
+<!DOCTYPE module PUBLIC
+    "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+    "https://checkstyle.org/dtds/configuration_1_3.dtd">
+<module name="Checker">
+  <!-- Last Updated for 10.21.3 -->
+
+  <property name="charset" value="UTF-8"/>
+  <property name="severity" value="error"/>
+
+  <!-- Exclude all 'module-info.java' files -->
+  <module name="BeforeExecutionExclusionFileFilter">
+    <property name="fileNamePattern" value="module\-info\.java$"/>
+  </module>
+
+  <!-- ## Headers ## -->
+  <!-- No Header -->
+  <!-- No RegexpHeader, TODO -->
+
+  <!-- ## Miscellaneous ## -->
+  <module name="NewlineAtEndOfFile" />
+  <module name="OrderedProperties" />
+  <module name="Translation" />
+  <module name="UniqueProperties" />
+
+  <!-- ## Filters ## -->
+  <module name="SuppressWarningsFilter" />
+
+  <module name="TreeWalker">
+    <!-- ## Filters ## -->
+    <module name="SuppressionCommentFilter" />
+
+    <!-- ## Annotations ## -->
+    <module name="AnnotationLocation" />
+    <!-- NO AnnotationOnSameLine -->
+    <module name="AnnotationUseStyle" />
+    <module name="MissingDeprecated" />
+    <module name="MissingOverride" />
+    <module name="PackageAnnotation" />
+    <!-- NO SuppressWarnings -->
+    <module name="SuppressWarningsHolder" />
+
+    <!-- ## Block Checks ## -->
+    <module name="AvoidNestedBlocks">
+      <property name="allowInSwitchCase" value="true" />
+    </module>
+    <module name="EmptyBlock" />
+    <module name="EmptyCatchBlock" />
+    <module name="LeftCurly">
+      <property name="ignoreEnums" value="false" />
+    </module>
+    <module name="NeedBraces" />
+    <module name="RightCurly" />
+
+    <!-- ## Class Design ## -->
+    <!-- No DesignForExtension -->
+    <module name="FinalClass" />
+    <module name="HideUtilityClassConstructor" />
+    <module name="InnerTypeLast" />
+    <module name="InterfaceIsType" />
+    <module name="MutableException" />
+    <module name="OneTopLevelClass" />
+    <!-- No ThrowsCount -->
+    <module name="VisibilityModifier">
+      <property name="allowPublicImmutableFields" value="true" />
+      <property name="immutableClassCanonicalNames"
+                value="java.io.File, java.lang.Boolean, java.lang.Byte, java.lang.Character, java.lang.Double,
+                       java.lang.Float, java.lang.Integer, java.lang.Long, java.lang.Short, java.lang.StackTraceElement,
+                       java.lang.String, java.math.BigDecimal, java.math.BigInteger, java.net.Inet4Address,
+                       java.net.Inet6Address, java.net.InetSocketAddress, java.net.URI, java.net.URL, java.util.Locale,
+                       java.util.UUID" />
+      <property name="protectedAllowed" value="true" />
+    </module>
+
+    <!-- ## Coding ## -->
+    <module name="ArrayTrailingComma" />
+    <module name="AvoidDoubleBraceInitialization" />
+    <!-- No AvoidInlineConditionals -->
+    <module name="AvoidNoArgumentSuperConstructorCall" />
+    <module name="ConstructorsDeclarationGrouping" />
+    <module name="CovariantEquals" />
+    <!--
+        NOTE: I personally disagree with the "standard" declaration order of
+        1. static fields
+        2. non-static fields
+        3. constructors
+        4. methods
+
+        I would put public static methods between 1 & 2, but alas.  Maybe one day I'll go and change this heh.
+    -->
+    <module name="DeclarationOrder" />
+    <module name="DefaultComesLast" />
+    <module name="EmptyStatement" />
+    <module name="EqualsAvoidNull" />
+    <module name="EqualsHashCode" />
+    <!-- No ExplicitInitialization -->
+    <module name="FallThrough" />
+    <!-- No FinalLocalVariable -->
+    <module name="HiddenField">
+      <property name="ignoreConstructorParameter" value="true" />
+      <property name="ignoreSetter" value="true" />
+      <property name="setterCanReturnItsClass" value="true" />
+      <property name="ignoreAbstractMethods" value="true" />
+    </module>
+    <!-- NO IllegalCatch -->
+    <module name="IllegalInstantiation">
+      <property name="classes"
+                value="java.lang.Boolean, java.lang.Integer" />
+    </module>
+    <module name="IllegalThrows" />
+    <module name="IllegalToken" />
+    <!-- No IllegalTokenText -->
+    <module name="IllegalType" />
+    <module name="InnerAssignment" />
+    <module name="MagicNumber" />
+    <!-- No MatchXPath -->
+    <!-- No MissingCtor -->
+    <module name="MissingSwitchDefault" />
+    <module name="ModifiedControlVariable" />
+    <!-- No MultipleStringLiterals -->
+    <module name="MultipleVariableDeclarations" />
+    <!-- No NestedForDepth -->
+    <!-- No NestedIfDepth -->
+    <!-- No NestedTryDepth -->
+    <!-- No NoArrayTrailingComma -->
+    <module name="NoClone" />
+    <!-- No NoEnumTrailingComma -->
+    <module name="NoFinalizer" />
+    <module name="OneStatementPerLine">
+      <property name="treatTryResourcesAsStatement" value="true" />
+    </module>
+    <module name="OverloadMethodsDeclarationOrder" />
+    <module name="PackageDeclaration" />
+    <module name="ParameterAssignment" />
+    <module name="RequireThis" />
+    <!-- No ReturnCount -->
+    <module name="SimplifyBooleanExpression" />
+    <module name="SimplifyBooleanReturn" />
+    <module name="StringLiteralEquality" />
+    <!-- No SuperClone -->
+    <!-- No SuperFinalize -->
+    <module name="UnnecessaryParentheses" />
+    <module name="UnnecessarySemicolonAfterOuterTypeDeclaration" />
+    <module name="UnnecessarySemicolonAfterTypeMemberDeclaration" />
+    <module name="UnnecessarySemicolonInEnumeration" />
+    <module name="UnnecessarySemicolonInTryWithResources" />
+    <module name="UnusedCatchParameterShouldBeUnnamed" />
+    <module name="UnusedLambdaParameterShouldBeUnnamed" />
+    <module name="UnusedLocalVariable" />
+    <module name="VariableDeclarationUsageDistance" />
+    <module name="WhenShouldBeUsed" />
+
+    <!-- ## Imports ## -->
+    <module name="AvoidStarImport">
+      <property name="allowStaticMemberImports" value="true" />
+    </module>
+    <!-- No AvoidStaticImport -->
+    <!-- No CustomImportOrder -->
+    <module name="IllegalImport" />
+    <!-- No ImportControl -->
+    <module name="ImportOrder">
+      <property name="groups" value="/^java\./,javax,jakarta" />
+      <property name="option" value="bottom" />
+      <property name="separated" value="true" />
+      <property name="sortStaticImportsAlphabetically" value="true" />
+    </module>
+    <module name="RedundantImport" />
+    <module name="UnusedImports">
+      <property name="processJavadoc" value="false" />
+    </module>
+
+    <!-- ## TODO: Javadoc ## -->
+
+    <!-- ## NO Metrics ## -->
+
+    <!-- ## Modifiers ## -->
+    <!-- NO ClassMemberImpliedModifier -->
+    <!-- NO InterfaceMemberImpliedModifier -->
+    <module name="ModifierOrder" />
+    <!-- No RedundantModifier -->
+
+    <!-- ## NO Naming Conventions ## -->
+
+    <!-- ## Regexp ## -->
+    <module name="RegexpSinglelineJava">
+      <property name="format" value="^\t*[ ]+.*\t"/>
+      <property name="message" value="Tabs should only be at the start of the line!"/>
+    </module>
+
+    <!-- ## NO Size Violations ## -->
+
+    <!-- ## TODO: Whitespace ## -->
+
+    <!-- ## Miscellaneous ## -->
+    <module name="ArrayTypeStyle" />
+    <module name="AvoidEscapedUnicodeCharacters" />
+    <module name="CommentsIndentation" />
+    <!-- No DescendantToken -->
+    <!-- No FinalParameters  -->
+    <module name="Indentation">
+      <property name="arrayInitIndent" value="8"/>
+      <property name="basicOffset" value="8"/>
+      <property name="braceAdjustment" value="0"/>
+      <property name="caseIndent" value="8"/>
+      <property name="forceStrictCondition" value="false"/>
+      <property name="lineWrappingIndentation" value="4"/>
+      <property name="throwsIndent" value="8"/>
+    </module>
+    <module name="NoCodeInFile" />
+    <module name="OuterTypeFilename" />
+    <!-- No TodoComment -->
+    <!-- No TrailingComment -->
+    <module name="UncommentedMain">
+      <property name="excludedClasses" value="Main$" />
+    </module>
+    <module name="UpperEll" />
+
+  </module>
+</module>
diff --git a/buildstuffs/src/main/resources/lv/enes/buildstuffs/pmd-rules.xml b/buildstuffs/src/main/resources/lv/enes/buildstuffs/pmd-rules.xml
new file mode 100644
index 0000000..796611e
--- /dev/null
+++ b/buildstuffs/src/main/resources/lv/enes/buildstuffs/pmd-rules.xml
@@ -0,0 +1,126 @@
+<?xml version="1.0"?>
+<!--
+ SPDX-License-Identifier: AGPL-3.0-or-later
+ SPDX-FileCopyrightText: 2025 Uko Kokņevičs <perkontevs@gmail.com>
+ -->
+<ruleset name="Custom Rules"
+         xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0
+                             https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+  <description>
+    My Custom Ruleset.
+  </description>
+
+  <rule ref="category/java/bestpractices.xml">
+    <exclude name="UnitTestAssertionsShouldIncludeMessage" />
+    <exclude name="UnitTestContainsTooManyAsserts" />
+  </rule>
+  <rule ref="category/java/bestpractices.xml/UnitTestContainsTooManyAsserts">
+    <properties>
+      <property name="maximumAsserts" value="3" />
+    </properties>
+  </rule>
+
+  <rule ref="category/java/codestyle.xml">
+    <exclude name="AtLeastOneConstructor" />
+    <exclude name="BooleanGetMethodName" />
+    <exclude name="CallSuperInConstructor" />
+    <exclude name="CommentDefaultAccessModifier" />
+    <exclude name="LinguisticNaming" />
+    <exclude name="LocalVariableCouldBeFinal" />
+    <exclude name="LongVariable" />
+    <exclude name="MethodArgumentCouldBeFinal" />
+    <exclude name="MethodNamingConventions" />
+    <exclude name="OnlyOneReturn" />
+    <exclude name="ShortClassName" />
+    <exclude name="ShortMethodName" />
+    <exclude name="ShortVariable" />
+    <exclude name="TooManyStaticImports" />
+    <exclude name="UnnecessaryFullyQualifiedName" />
+    <exclude name="UseExplicitTypes" />
+  </rule>
+  <rule ref="category/java/codestyle.xml/BooleanGetMethodName">
+    <properties>
+      <property name="checkParameterizedMethods" value="true" />
+    </properties>
+  </rule>
+  <rule ref="category/java/codestyle.xml/CommentDefaultAccessModifier">
+    <properties>
+      <property name="regex" value="\/\*\s*package\s*\*\/" />
+    </properties>
+  </rule>
+  <rule ref="category/java/codestyle.xml/LinguisticNaming">
+    <properties>
+      <!-- It's allowed for setters to return the object itself -->
+      <property name="checkSetters" value="false" />
+    </properties>
+  </rule>
+  <rule ref="category/java/codestyle.xml/MethodNamingConventions">
+    <properties>
+      <property name="nativePattern" value="native[A-Z0-9][a-zA-Z0-9]*" />
+      <property name="junit3TestPattern" value="test[A-Z0-9][a-zA-Z0-9]*" />
+      <property name="junit4TestPattern" value="test[A-Z0-9][a-zA-Z0-9]*" />
+      <property name="junit5TestPattern" value="test[A-Z0-9][a-zA-Z0-9]*" />
+    </properties>
+  </rule>
+  <rule ref="category/java/codestyle.xml/UnnecessaryFullyQualifiedName">
+    <properties>
+      <property name="reportStaticMethods" value="false" />
+    </properties>
+  </rule>
+
+  <rule ref="category/java/design.xml">
+    <!-- TODO: -->
+    <exclude name="AvoidThrowingRawExceptionTypes" />
+    <exclude name="CyclomaticComplexity" />
+    <exclude name="ExcessiveImports" />
+    <exclude name="LawOfDemeter" />
+    <exclude name="LoosePackageCoupling" />
+    <exclude name="NcssCount" />
+    <exclude name="SignatureDeclareThrowsException" />
+    <exclude name="TooManyMethods" />
+  </rule>
+
+  <rule ref="category/java/documentation.xml">
+    <exclude name="CommentContent" />
+    <!-- TODO: Start using javadoc :) -->
+    <exclude name="CommentRequired" />
+    <exclude name="CommentSize" />
+  </rule>
+  <rule ref="category/java/documentation.xml/CommentSize">
+    <properties>
+      <property name="maxLineLength" value="120" />
+    </properties>
+  </rule>
+
+  <rule ref="category/java/errorprone.xml">
+    <exclude name="AvoidLiteralsInIfCondition" />
+    <exclude name="AvoidUsingOctalValues" />
+    <exclude name="CallSuperFirst" />
+    <exclude name="CallSuperLast" />
+    <exclude name="CloseResource" />
+    <exclude name="NonSerializableClass" />
+  </rule>
+  <rule ref="category/java/errorprone.xml/AvoidUsingOctalValues">
+    <properties>
+      <property name="strict" value="true" />
+    </properties>
+  </rule>
+  <rule ref="category/java/errorprone.xml/NonSerializableClass">
+    <properties>
+      <property name="checkAbstractTypes" value="true" />
+    </properties>
+  </rule>
+
+  <rule ref="category/java/multithreading.xml">
+    <exclude name="DoNotUseThreads" />
+    <exclude name="UseConcurrentHashMap" />
+  </rule>
+
+  <rule ref="category/java/performance.xml">
+    <exclude name="RedundantFieldInitializer" />
+  </rule>
+
+  <rule ref="category/java/security.xml" />
+</ruleset>
diff --git a/buildstuffs/src/main/resources/lv/enes/buildstuffs/spotbugs-exclude.xml b/buildstuffs/src/main/resources/lv/enes/buildstuffs/spotbugs-exclude.xml
new file mode 100644
index 0000000..65f2d8d
--- /dev/null
+++ b/buildstuffs/src/main/resources/lv/enes/buildstuffs/spotbugs-exclude.xml
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ SPDX-License-Identifier: AGPL-3.0-or-later
+ SPDX-FileCopyrightText: 2025 Uko Kokņevičs <perkontevs@gmail.com>
+ -->
+<FindBugsFilter xmlns="https://github.com/spotbugs/filter/4.8.4"
+                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                xsi:schemaLocation="https://github.com/spotbugs/filter/4.8.4
+                                    https://raw.githubusercontent.com/spotbugs/spotbugs/4.8.4/spotbugs/etc/findbugsfilter.xsd">
+  <!-- Auto-generated -->
+  <Match>
+    <Source name="HelpMojo.java" />
+  </Match>
+
+  <!-- Finalizer attacks...  Don't use finalizers. -->
+  <Match>
+    <Bug pattern="CT_CONSTRUCTOR_THROW" />
+  </Match>
+
+  <!-- Malicious code vulnerabilities.  Why are you running untrusted code? -->
+  <Match>
+    <Or>
+      <Bug pattern="EI_EXPOSE_REP" />
+      <Bug pattern="EI_EXPOSE_REP2" />
+      <Bug pattern="MS_EXPOSE_REP" />
+    </Or>
+  </Match>
+
+  <!-- This is a good check but Lombok's @Getter(lazy=true) generates code violating it :/ -->
+  <Match>
+    <Bug pattern="JLM_JSR166_UTILCONCURRENT_MONITORENTER" />
+  </Match>
+
+  <!-- Nullness should get caught by checkerframework.  Silencing here because Lombok generates them. -->
+  <Match>
+    <Or>
+      <Bug code="RCN" />
+      <Bug pattern="NP_NONNULL_RETURN_VIOLATION" />
+    </Or>
+  </Match>
+
+  <!-- Catch fallthrough with other tools which allow annotating accepted cases more easily -->
+  <Match>
+    <Bug pattern="SF_SWITCH_FALLTHROUGH" />
+  </Match>
+</FindBugsFilter>
-- 
cgit v1.2.3