Gradle Checkstyle 插件

2022-08-03 15:39 更新

Checkstyle 插件使用 Checkstyle 對你的項目的 Java 源文件執(zhí)行質(zhì)量檢查,并從檢查結(jié)果中生成報告。

用法

要使用 Checkstyle 插件,請在構(gòu)建腳本中包含以下語句:

使用 Checkstyle 插件

build.gradle

apply plugin: 'checkstyle'  

該插件向你的項目添加了大量的執(zhí)行質(zhì)量檢查的任務。你可以通過運行 gradle check 執(zhí)行檢查。

Tasks

Checkstyle 插件向 project 中添加了以下 tasks:

表 29.1. Checkstyle 插件 - tasks

任務名稱 依賴于 類型 描述
checkstyleMain classes checkstyle 針對生產(chǎn)Java 源文件運行 Checkstyle。
checkstyleTest testClasses checkstyle 針對測試 Java 源文件運行 Checkstyle。
SourceSet sourceSetClasses 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 庫
以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號