[PATCH] 规范化补丁 #6
42
.github/workflows/code-check.yaml
vendored
42
.github/workflows/code-check.yaml
vendored
|
@ -1,34 +1,16 @@
|
||||||
name: 代码检查
|
on: pull_request
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
- develop
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
checkstyle_job:
|
||||||
name: 代码检查
|
runs-on: ubuntu-latest
|
||||||
runs-on: ubuntu-22.04
|
name: Checkstyle job
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
packages: read
|
|
||||||
statuses: write
|
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v2
|
||||||
|
- name: Run check style
|
||||||
|
uses: nikitasavinov/checkstyle-action@master
|
||||||
with:
|
with:
|
||||||
# super-linter needs the full git history to get the
|
github_token: ${{ secrets.MyGitHubToken }}
|
||||||
# list of files that changed across commits
|
reporter: 'github-pr-check'
|
||||||
fetch-depth: 0
|
tool_name: 'testtool'
|
||||||
|
checkstyle_config: 'checkstyle.xml'
|
||||||
- name: Super-linter
|
|
||||||
uses: super-linter/super-linter@v6.3.1
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.MyGitHubToken }}
|
|
||||||
CHECKSTYLE_FILTER_PATH: ".github/workflows/checkstyle.xml"
|
|
|
@ -13,17 +13,15 @@
|
||||||
<property name="max" value="1500"/>
|
<property name="max" value="1500"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
|
<!-- 长度检查 -->
|
||||||
|
<!-- 每行不超过140个字符 -->
|
||||||
|
<module name="LineLength">
|
||||||
|
<property name="max" value="120" />
|
||||||
|
</module>
|
||||||
|
|
||||||
<!-- 每个java文件一个语法树 -->
|
<!-- 每个java文件一个语法树 -->
|
||||||
<module name="TreeWalker">
|
<module name="TreeWalker">
|
||||||
<!-- import检查-->
|
<!-- import检查-->
|
||||||
<!-- 避免使用* -->
|
|
||||||
<module name="AvoidStarImport">
|
|
||||||
<property name="excludes" value="java.io,java.net,java.lang.Math"/>
|
|
||||||
<!-- 实例;import java.util.*;.-->
|
|
||||||
<property name="allowClassImports" value="false"/>
|
|
||||||
<!-- 实例 ;import static org.junit.Assert.*;-->
|
|
||||||
<property name="allowStaticMemberImports" value="true"/>
|
|
||||||
</module>
|
|
||||||
<!-- 检查是否从非法的包中导入了类 -->
|
<!-- 检查是否从非法的包中导入了类 -->
|
||||||
<module name="IllegalImport"/>
|
<module name="IllegalImport"/>
|
||||||
<!-- 检查是否导入了多余的包 -->
|
<!-- 检查是否导入了多余的包 -->
|
||||||
|
@ -31,19 +29,12 @@
|
||||||
<!-- 没用的import检查,比如:1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->
|
<!-- 没用的import检查,比如:1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->
|
||||||
<module name="UnusedImports" />
|
<module name="UnusedImports" />
|
||||||
|
|
||||||
|
|
||||||
<!-- 注释检查 -->
|
<!-- 注释检查 -->
|
||||||
<!-- 检查方法和构造函数的javadoc -->
|
<!-- 检查构造函数的javadoc -->
|
||||||
<module name="JavadocType">
|
<module name="JavadocType">
|
||||||
<property name="allowUnknownTags" value="true"/>
|
<property name="allowUnknownTags" value="true"/>
|
||||||
<message key="javadoc.missing" value="类注释:缺少Javadoc注释。"/>
|
<message key="javadoc.missing" value="类注释:缺少Javadoc注释。"/>
|
||||||
</module>
|
</module>
|
||||||
<module name="JavadocMethod">
|
|
||||||
<property name="tokens" value="METHOD_DEF" />
|
|
||||||
<!--允许get set 方法没有注释-->
|
|
||||||
<property name="allowMissingPropertyJavadoc" value="true"/>
|
|
||||||
<message key="javadoc.missing" value="方法注释:缺少Javadoc注释。"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<!-- 命名检查 -->
|
<!-- 命名检查 -->
|
||||||
<!-- 局部的final变量,包括catch中的参数的检查 -->
|
<!-- 局部的final变量,包括catch中的参数的检查 -->
|
||||||
|
@ -77,11 +68,6 @@
|
||||||
<!-- 检查long型定义是否有大写的“L” -->
|
<!-- 检查long型定义是否有大写的“L” -->
|
||||||
<module name="UpperEll"/>
|
<module name="UpperEll"/>
|
||||||
|
|
||||||
<!-- 长度检查 -->
|
|
||||||
<!-- 每行不超过120个字符 -->
|
|
||||||
<module name="LineLength">
|
|
||||||
<property name="max" value="120" />
|
|
||||||
</module>
|
|
||||||
<!-- 方法不超过50行 -->
|
<!-- 方法不超过50行 -->
|
||||||
<module name="MethodLength">
|
<module name="MethodLength">
|
||||||
<property name="tokens" value="METHOD_DEF" />
|
<property name="tokens" value="METHOD_DEF" />
|
||||||
|
@ -139,15 +125,8 @@
|
||||||
<module name="HiddenField">
|
<module name="HiddenField">
|
||||||
<property name="tokens" value="VARIABLE_DEF"/>
|
<property name="tokens" value="VARIABLE_DEF"/>
|
||||||
</module>
|
</module>
|
||||||
<!-- 检查是否使用工厂方法实例化 -->
|
|
||||||
<module name="IllegalInstantiation"/>
|
|
||||||
<!-- 检查子表达式中是否有赋值操作 -->
|
<!-- 检查子表达式中是否有赋值操作 -->
|
||||||
<module name="InnerAssignment"/>
|
<module name="InnerAssignment"/>
|
||||||
<!-- 检查是否有"魔术"数字 -->
|
|
||||||
<module name="MagicNumber">
|
|
||||||
<property name="ignoreNumbers" value="0, 1"/>
|
|
||||||
<property name="ignoreAnnotation" value="true"/>
|
|
||||||
</module>
|
|
||||||
<!-- 检查switch语句是否有default -->
|
<!-- 检查switch语句是否有default -->
|
||||||
<module name="MissingSwitchDefault"/>
|
<module name="MissingSwitchDefault"/>
|
||||||
<!-- 检查是否有过度复杂的布尔表达式 -->
|
<!-- 检查是否有过度复杂的布尔表达式 -->
|
||||||
|
@ -159,8 +138,6 @@
|
||||||
<!-- 检查类是否为扩展设计l -->
|
<!-- 检查类是否为扩展设计l -->
|
||||||
<!-- 检查只有private构造函数的类是否声明为final -->
|
<!-- 检查只有private构造函数的类是否声明为final -->
|
||||||
<module name="FinalClass"/>
|
<module name="FinalClass"/>
|
||||||
<!-- 检查工具类是否有putblic的构造器 -->
|
|
||||||
<module name="HideUtilityClassConstructor"/>
|
|
||||||
<!-- 检查接口是否仅定义类型 -->
|
<!-- 检查接口是否仅定义类型 -->
|
||||||
<module name="InterfaceIsType"/>
|
<module name="InterfaceIsType"/>
|
||||||
<!-- 检查类成员的可见度 检查类成员的可见性。只有static final 成员是public的
|
<!-- 检查类成员的可见度 检查类成员的可见性。只有static final 成员是public的
|
||||||
|
@ -183,7 +160,7 @@
|
||||||
</module>
|
</module>
|
||||||
<!-- 检查未被注释的main方法,排除以Appllication结尾命名的类 -->
|
<!-- 检查未被注释的main方法,排除以Appllication结尾命名的类 -->
|
||||||
<module name="UncommentedMain">
|
<module name="UncommentedMain">
|
||||||
<property name="excludedClasses" value=".*Application$"/>
|
<property name="excludedClasses" value=".*[Application,Test]$"/>
|
||||||
</module>
|
</module>
|
||||||
<!-- 禁止使用System.out.println -->
|
<!-- 禁止使用System.out.println -->
|
||||||
<module name="Regexp">
|
<module name="Regexp">
|
Loading…
Reference in New Issue
Block a user