chore: 接入 Checkstyle 门禁

This commit is contained in:
2026-11-20 09:36:46 +08:00
parent 5310f480ce
commit 5ff692b768
3 changed files with 140 additions and 0 deletions
+96
View File
@@ -0,0 +1,96 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
<module name="LineLength">
<property name="max" value="120"/>
<property name="fileExtensions" value="java"/>
</module>
<module name="FileTabCharacter"/>
<module name="FileLength">
<property name="max" value="400"/>
<property name="fileExtensions" value="java"/>
</module>
<module name="SuppressionFilter">
<property name="file" value="${checkstyle.suppressions.file}"/>
<property name="optional" value="false"/>
</module>
<module name="TreeWalker">
<module name="AvoidStarImport"/>
<module name="UnusedImports"/>
<module name="RedundantImport"/>
<module name="OneStatementPerLine"/>
<module name="NeedBraces"/>
<module name="EmptyCatchBlock">
<property name="exceptionVariableName" value="expected|ignore"/>
</module>
<module name="EmptyStatement"/>
<module name="MultipleVariableDeclarations"/>
<module name="ModifierOrder"/>
<module name="UpperEll"/>
<module name="ArrayTypeStyle"/>
<module name="OuterTypeFilename"/>
<module name="OneTopLevelClass"/>
<module name="TypeName">
<property name="format" value="^[A-Z][a-zA-Z0-9]*$"/>
</module>
<module name="MethodName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
</module>
<module name="MemberName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
</module>
<module name="LocalVariableName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
</module>
<module name="ParameterName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
</module>
<module name="ConstantName">
<property name="format" value="^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
</module>
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
</module>
<module name="StringLiteralEquality"/>
<module name="EqualsHashCode"/>
<module name="IllegalThrows"/>
<module name="MissingSwitchDefault"/>
<module name="FallThrough"/>
<module name="HideUtilityClassConstructor"/>
<module name="NestedIfDepth">
<property name="max" value="3"/>
</module>
<module name="NestedForDepth">
<property name="max" value="3"/>
</module>
<module name="NestedTryDepth">
<property name="max" value="3"/>
</module>
<module name="CyclomaticComplexity">
<property name="max" value="15"/>
</module>
<module name="MethodLength">
<property name="max" value="80"/>
</module>
<module name="ParameterNumber">
<property name="max" value="7"/>
</module>
<module name="RegexpSinglelineJava">
<property name="id" value="noSystemOut"/>
<property name="format" value="System\.(out|err)\.print"/>
<property name="maximum" value="0"/>
</module>
<module name="RegexpSinglelineJava">
<property name="id" value="noPrintStackTrace"/>
<property name="format" value="\.printStackTrace\(\)"/>
<property name="maximum" value="0"/>
</module>
<module name="RegexpSinglelineJava">
<property name="id" value="transactionRollback"/>
<property name="format" value="@Transactional\b(?![^)]*rollbackFor)"/>
<property name="maximum" value="0"/>
</module>
</module>
</module>
+15
View File
@@ -0,0 +1,15 @@
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
"https://checkstyle.org/dtds/suppressions_1_2.dtd">
<suppressions>
<!-- 设计例外:Flyway Java 迁移类的类名由 Flyway 规定(VyyyyMMdd_n__desc),不满足 TypeName 的大小写规则。
这不是存量债务,是框架约束;迁移类不可改名,改名会让 Flyway 认为已有迁移消失。 -->
<suppress files="src[\\/]main[\\/]java[\\/]db[\\/]migration[\\/].*\.java$" checks="TypeName"/>
<!-- 设计例外:Spring Boot 启动入口只有 static main,Checkstyle 按「只有静态成员」的工具类特征判它。
真给入口类加 private 构造会让 Spring 测试上下文无法实例化启动类(实测 164 个测试报
"No visible constructors in class LearningProgressTrackerApplication"),所以这里只能豁免。 -->
<suppress files="src[\\/]main[\\/]java[\\/]com[\\/]guo[\\/]learningprogresstracker[\\/]LearningProgressTrackerApplication\.java$"
checks="HideUtilityClassConstructor"/>
</suppressions>