| API 文件 | CheckstyleExtension |
|---|
Checkstyle 外掛的組態選項。
| 屬性 | 描述 |
config | 要使用的 Checkstyle 組態。取代 |
configDirectory | 其他 Checkstyle 組態檔的路徑。預設情況下，此路徑為 |
configFile | 要使用的 Checkstyle 組態檔。 |
configProperties | 組態檔中可用的屬性。這些屬性會被替換到組態檔中。 |
enableExternalDtdLoad | 實驗性功能 啟用在本專案的所有 checkstyle 任務中使用自訂 DTD 檔案，並從某些位置載入它們的功能。預設為停用，因為有安全疑慮。 詳情請參閱 Checkstyle 文件。 |
ignoreFailures | 是否允許在出現警告時繼續建置。範例：ignoreFailures = true |
maxErrors | 在建置中斷或設定失敗屬性之前，容許的最大錯誤數。預設值為 |
maxWarnings | 在建置中斷或設定失敗屬性之前，容許的最大警告數。預設值為 |
reportsDir | 將產生報告的目錄。 |
showViolations | 是否在主控台上顯示規則違規。預設值為 |
sourceSets | 要作為 |
toolVersion | 要使用的程式碼品質工具版本。 |
TextResource config
要使用的 Checkstyle 組態。取代 configFile 屬性。
- 使用
checkstyle外掛的預設值 ${configDirectory}/checkstyle.xml
DirectoryProperty configDirectory
其他 Checkstyle 組態檔的路徑。預設情況下，此路徑為 $rootProject.projectDir/config/checkstyle
此路徑將作為變數 config_loc 在 Checkstyle 的組態檔中公開。
- 使用
checkstyle外掛的預設值 ${rootProject.projectDir}/config/checkstyle
注意：此屬性為實驗性功能，在 Gradle 未來版本中可能會變更。
啟用在本專案的所有 checkstyle 任務中使用自訂 DTD 檔案，並從某些位置載入它們的功能。預設為停用，因為有安全疑慮。 詳情請參閱 Checkstyle 文件。
- 使用
checkstyle外掛的預設值 false
在建置中斷或設定失敗屬性之前，容許的最大警告數。預設值為 Integer.MAX_VALUE。
範例：maxWarnings = 1000
- 使用
checkstyle外掛的預設值 Integer.MAX_VALUE
File reportsDir
將產生報告的目錄。
String toolVersion
要使用的程式碼品質工具版本。