Gradle Checkstyle 插件
2022-08-03 15:39 更新
Checkstyle 插件使用 Checkstyle 对你的项目的 Java 源文件执行质量检查,并从检查结果中生成报告。
用法
要使用 Checkstyle 插件,请在构建脚本中包含以下语句:
使用 Checkstyle 插件
build.gradle
apply plugin: 'checkstyle'
该插件向你的项目添加了大量的执行质量检查的任务。你可以通过运行 gradle check 执行检查。
Tasks
Checkstyle 插件向 project 中添加了以下 tasks:
表 29.1. Checkstyle 插件 - tasks
任务名称 | 依赖于 | 类型 | 描述 |
checkstyleMain
|
classes
|
checkstyle | 针对生产Java 源文件运行 Checkstyle。 |
checkstyleTest
|
testClasses
|
checkstyle | 针对测试 Java 源文件运行 Checkstyle。 |
SourceSet
|
sourceSet Classes |
checkstyle | 针对source set 的 Java 源文件运行 Checkstyle。 |
Checkstyle 插件向 Java 插件所加入的 tasks 添加了以下的依赖。
表 29.2. Checkstyle 插件 - 额外的 task 依赖
任务名称 | 依赖于 |
check
|
所有 Checkstyle tasks,包括checkstyleTest 。 |
项目布局
Checkstyle 插件预计是以下的项目布局:
表 29.3. Checkstyle 插件 - 项目布局
File | 意义 |
config/checkstyle/checkstyle.xml
|
Checkstyle 配置文件 |
依赖管理
Checkstyle 插件添加了下列的依赖配置:
表29.4. Checkstyle 插件 - 依赖配置
名称 | 意义 |
checkstyle
|
用到的 Checkstyle 库 |
以上内容是否对您有帮助:
更多建议: