- GUI (phases 7-8): BuilderScreen, Panel, NumberSlider, CycleButton, BuilderUi keybinds (Right Shift menu, P pause macro), lang entries, README - ConfigStore.loadOrEmpty/saveQuietly; BuildSettings.Range; BuilderFeature settings()/stage()/togglePause() - Checks: ~60 Checkstyle rules (errors), PMD with 7 categories, checkArchitecture (layer rules + max 4 files per package, with baseline), javac -Xlint:all -Werror, rule rejecting non-English comments - File length limit raised to 250 lines - License: GPL-3.0-only (LICENSE, fabric.mod.json) - All code comments and log messages translated to English
196 lines
8.3 KiB
XML
196 lines
8.3 KiB
XML
<?xml version="1.0"?>
|
||
<!DOCTYPE module PUBLIC
|
||
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
|
||
"https://checkstyle.org/dtds/configuration_1_3.dtd">
|
||
|
||
<!-- Правила проекта satura. Любое нарушение — error и валит ./gradlew check. -->
|
||
<module name="Checker">
|
||
<property name="charset" value="UTF-8"/>
|
||
<property name="severity" value="error"/>
|
||
|
||
<!-- ===== Файл ===== -->
|
||
<module name="FileLength">
|
||
<property name="max" value="250"/>
|
||
<property name="fileExtensions" value="java"/>
|
||
</module>
|
||
<module name="FileTabCharacter">
|
||
<property name="eachLine" value="true"/>
|
||
</module>
|
||
<module name="NewlineAtEndOfFile"/>
|
||
<module name="LineLength">
|
||
<property name="max" value="120"/>
|
||
<property name="ignorePattern" value="^package.*|^import.*|https?://"/>
|
||
</module>
|
||
<module name="RegexpSingleline">
|
||
<property name="format" value="\s+$"/>
|
||
<property name="message" value="Пробелы в конце строки"/>
|
||
</module>
|
||
<module name="RegexpSingleline">
|
||
<property name="format" value="^\s*(//|/\*|\*).*[А-Яа-яЁё]|\s//.*[А-Яа-яЁё]"/>
|
||
<property name="message" value="Comments must be in English (Russian only in user-facing strings)"/>
|
||
<property name="fileExtensions" value="java"/>
|
||
</module>
|
||
<module name="RegexpSingleline">
|
||
<property name="format" value="System\.(out|err)\.print|printStackTrace\("/>
|
||
<property name="message" value="Вывод в консоль запрещён — используй логгер"/>
|
||
<property name="fileExtensions" value="java"/>
|
||
</module>
|
||
|
||
<!-- Тесты: упрощённые правила (магические числа, поля-стабы, однострочные лямбды) -->
|
||
<module name="SuppressionFilter">
|
||
<property name="file" value="${config_loc}/suppressions.xml"/>
|
||
</module>
|
||
|
||
<module name="TreeWalker">
|
||
<!-- ===== Импорты ===== -->
|
||
<module name="UnusedImports"/>
|
||
<module name="RedundantImport"/>
|
||
<module name="AvoidStarImport"/>
|
||
<module name="IllegalImport"/>
|
||
|
||
<!-- ===== Нейминг ===== -->
|
||
<module name="PackageName">
|
||
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
|
||
</module>
|
||
<module name="TypeName"/>
|
||
<module name="MethodName">
|
||
<property name="format" value="^[a-z][a-zA-Z0-9]*(\$[a-z][a-zA-Z0-9]*)?$"/>
|
||
</module>
|
||
<module name="MemberName"/>
|
||
<module name="LocalVariableName"/>
|
||
<module name="LocalFinalVariableName"/>
|
||
<module name="ParameterName"/>
|
||
<module name="LambdaParameterName"/>
|
||
<module name="StaticVariableName"/>
|
||
<module name="ConstantName"/>
|
||
<module name="ClassTypeParameterName"/>
|
||
<module name="MethodTypeParameterName"/>
|
||
<module name="RecordComponentName"/>
|
||
<module name="AbbreviationAsWordInName">
|
||
<property name="allowedAbbreviationLength" value="2"/>
|
||
<property name="ignoreFinal" value="false"/>
|
||
<property name="ignoreStaticFinal" value="true"/>
|
||
</module>
|
||
|
||
<!-- ===== Структура и инкапсуляция ===== -->
|
||
<module name="OneTopLevelClass"/>
|
||
<module name="OuterTypeFilename"/>
|
||
<module name="FinalClass"/>
|
||
<module name="HideUtilityClassConstructor"/>
|
||
<module name="InterfaceIsType"/>
|
||
<module name="VisibilityModifier">
|
||
<property name="packageAllowed" value="false"/>
|
||
<property name="protectedAllowed" value="false"/>
|
||
<property name="ignoreAnnotationCanonicalNames" value="Shadow, org.spongepowered.asm.mixin.Shadow"/>
|
||
</module>
|
||
<module name="ModifierOrder"/>
|
||
<module name="RedundantModifier"/>
|
||
<module name="MutableException"/>
|
||
<module name="ThrowsCount">
|
||
<property name="max" value="2"/>
|
||
</module>
|
||
|
||
<!-- ===== Размер и сложность (KISS) ===== -->
|
||
<module name="MethodLength">
|
||
<property name="max" value="50"/>
|
||
<property name="countEmpty" value="false"/>
|
||
</module>
|
||
<module name="ParameterNumber">
|
||
<property name="max" value="8"/>
|
||
<property name="ignoreOverriddenMethods" value="true"/>
|
||
</module>
|
||
<module name="RecordComponentNumber">
|
||
<property name="max" value="14"/>
|
||
</module>
|
||
<module name="AnonInnerLength">
|
||
<property name="max" value="30"/>
|
||
</module>
|
||
<module name="CyclomaticComplexity">
|
||
<property name="max" value="10"/>
|
||
</module>
|
||
<module name="NPathComplexity">
|
||
<property name="max" value="100"/>
|
||
</module>
|
||
<module name="BooleanExpressionComplexity">
|
||
<property name="max" value="4"/>
|
||
</module>
|
||
<module name="NestedIfDepth">
|
||
<property name="max" value="2"/>
|
||
</module>
|
||
<module name="NestedForDepth">
|
||
<property name="max" value="2"/>
|
||
</module>
|
||
<module name="NestedTryDepth">
|
||
<property name="max" value="1"/>
|
||
</module>
|
||
<module name="ReturnCount">
|
||
<property name="max" value="5"/>
|
||
<property name="maxForVoid" value="3"/>
|
||
</module>
|
||
|
||
<!-- ===== Магические числа (правило 7) ===== -->
|
||
<module name="MagicNumber">
|
||
<property name="ignoreNumbers" value="-1, 0, 1, 2"/>
|
||
<property name="ignoreHashCodeMethod" value="true"/>
|
||
<property name="ignoreAnnotation" value="true"/>
|
||
<property name="ignoreFieldDeclaration" value="false"/>
|
||
<property name="constantWaiverParentToken"
|
||
value="TYPECAST, METHOD_CALL, EXPR, ARRAY_INIT, UNARY_MINUS, UNARY_PLUS,
|
||
ELIST, STAR, ASSIGN, PLUS, MINUS, DIV, LITERAL_NEW"/>
|
||
</module>
|
||
|
||
<!-- ===== Корректность ===== -->
|
||
<module name="StringLiteralEquality"/>
|
||
<module name="EqualsHashCode"/>
|
||
<module name="CovariantEquals"/>
|
||
<module name="EmptyBlock">
|
||
<property name="option" value="text"/>
|
||
</module>
|
||
<module name="EmptyCatchBlock">
|
||
<property name="exceptionVariableName" value="expected|ignore|ignored"/>
|
||
</module>
|
||
<module name="EmptyStatement"/>
|
||
<module name="FallThrough"/>
|
||
<module name="MissingSwitchDefault"/>
|
||
<module name="DefaultComesLast"/>
|
||
<module name="InnerAssignment"/>
|
||
<module name="MultipleVariableDeclarations"/>
|
||
<module name="OneStatementPerLine"/>
|
||
<module name="IllegalInstantiation">
|
||
<property name="classes" value="java.lang.Boolean, java.lang.Integer, java.lang.Long,
|
||
java.lang.Double, java.lang.Float"/>
|
||
</module>
|
||
<module name="IllegalCatch">
|
||
<property name="illegalClassNames" value="Throwable, Error"/>
|
||
</module>
|
||
<module name="IllegalThrows"/>
|
||
<module name="ExplicitInitialization"/>
|
||
<module name="UnnecessaryParentheses"/>
|
||
<module name="SimplifyBooleanExpression"/>
|
||
<module name="SimplifyBooleanReturn"/>
|
||
<module name="OverloadMethodsDeclarationOrder"/>
|
||
<module name="PackageDeclaration"/>
|
||
<module name="MissingOverride"/>
|
||
|
||
<!-- ===== Оформление ===== -->
|
||
<module name="NeedBraces"/>
|
||
<module name="LeftCurly"/>
|
||
<module name="RightCurly"/>
|
||
<module name="UpperEll"/>
|
||
<module name="ArrayTypeStyle"/>
|
||
<module name="GenericWhitespace"/>
|
||
<module name="MethodParamPad"/>
|
||
<module name="NoWhitespaceAfter"/>
|
||
<module name="NoWhitespaceBefore"/>
|
||
<module name="WhitespaceAround">
|
||
<property name="allowEmptyLambdas" value="true"/>
|
||
<property name="allowEmptyMethods" value="true"/>
|
||
<property name="allowEmptyTypes" value="true"/>
|
||
<property name="allowEmptyConstructors" value="true"/>
|
||
</module>
|
||
<module name="CommentsIndentation"/>
|
||
<module name="TodoComment">
|
||
<property name="format" value="FIXME|XXX"/>
|
||
</module>
|
||
</module>
|
||
</module>
|