| API 文件 | CodeNarc |
|---|
針對某些原始碼檔案執行 CodeNarc。
| 屬性 | 描述 |
codenarcClasspath | 包含要使用的 CodeNarc 程式庫的類別路徑。 |
compilationClasspath | CodeNarc 在分析期間編譯類別時要使用的類別路徑。 |
config | 要使用的 CodeNarc 組態。取代 |
configFile | 要使用的 CodeNarc 組態檔。 |
excludes | 排除模式的集合。 |
ignoreFailures | 孵化中 指定當此任務執行的驗證失敗時，建置是否應該中斷。 |
includes | 包含模式的集合。 |
javaLauncher | 孵化中 用於啟動 worker process 的 Java 啟動器 |
maxHeapSize | 孵化中 worker process 的最大堆積大小。如果未指定，Gradle 將提供最大堆積大小。支援類似命令列選項 |
maxPriority1Violations | 在建置失敗之前允許的最大優先順序 1 違規數。 |
maxPriority2Violations | 在建置失敗之前允許的最大優先順序 2 違規數。 |
maxPriority3Violations | 在建置失敗之前允許的最大優先順序 3 違規數。 |
minHeapSize | 孵化中 worker process 的最小堆積大小。未指定時，不會設定最小堆積大小。支援類似命令列選項 |
reports | 此任務要產生的報告。 |
source | 套用包含和排除模式後，此任務的來源。忽略不存在的原始碼檔案。 |
| 方法 | 描述 |
exclude(excludeSpec) | 新增排除規格。可以多次呼叫此方法以附加新的規格。給定的閉包會傳遞一個 |
exclude(excludes) | 新增 ANT 樣式的排除模式。可以多次呼叫此方法以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供排除項目，則不會排除任何檔案。如果提供了排除項目，則檔案不得符合任何排除模式才能進行處理。 |
exclude(excludes) | 新增 ANT 樣式的排除模式。可以多次呼叫此方法以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供排除項目，則不會排除任何檔案。如果提供了排除項目，則檔案不得符合任何排除模式才能進行處理。 |
exclude(excludeSpec) | 新增排除規格。可以多次呼叫此方法以附加新的規格。如果未提供排除項目，則不會排除任何檔案。如果提供了排除項目，則檔案不得符合任何排除模式才能進行處理。 |
include(includeSpec) | 新增包含規格。可以多次呼叫此方法以附加新的規格。給定的閉包會傳遞一個 |
include(includes) | 新增 ANT 樣式的包含模式。可以多次呼叫此方法以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供包含項目，則將包含此容器中的所有檔案。如果提供了包含項目，則檔案必須符合至少一個包含模式才能進行處理。 |
include(includes) | 新增 ANT 樣式的包含模式。可以多次呼叫此方法以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供包含項目，則將包含此容器中的所有檔案。如果提供了包含項目，則檔案必須符合至少一個包含模式才能進行處理。 |
include(includeSpec) | 新增包含規格。可以多次呼叫此方法以附加新的規格。如果未提供包含項目，則將包含此容器中的所有檔案。如果提供了包含項目，則檔案必須符合至少一個包含模式或規格才能包含。 |
reports(configureAction) | 配置由此任務產生的報告。 |
source(sources) | 為此任務新增一些來源。給定的來源物件將根據 |
| 區塊 | 描述 |
reports | 配置由此任務產生的報告。 |
FileCollection codenarcClasspath
包含要使用的 CodeNarc 程式庫的類別路徑。
- 預設值與
codenarc外掛程式 project.configurations.codenarc
注意：此屬性為孵化中，並且可能在 Gradle 的未來版本中變更。
worker process 的最大堆積大小。如果未指定，Gradle 將提供最大堆積大小。支援類似命令列選項 -Xmx 的單位，例如 "1g"。
注意：此屬性為孵化中，並且可能在 Gradle 的未來版本中變更。
worker process 的最小堆積大小。未指定時，不會設定最小堆積大小。支援類似命令列選項 -Xms 的單位，例如 "1g"。
CodeNarcReports reports (唯讀)
此任務要產生的報告。
FileTree source (唯讀)
套用包含和排除模式後，此任務的來源。忽略不存在的原始碼檔案。
來源的 PathSensitivity 配置為 PathSensitivity.ABSOLUTE。如果您的來源不太嚴格，請在子類別中覆寫此方法以相應地變更它。
- 預設值與
codenarc外掛程式 sourceSet.allGroovy
SourceTask exclude(Closure excludeSpec)
新增排除規格。可以多次呼叫此方法以附加新的規格。給定的閉包會傳遞一個 FileTreeElement 作為其參數。閉包應傳回 true 或 false。範例
copySpec {
from 'source'
into 'destination'
//an example of excluding files from certain configuration:
exclude { it.file in configurations.someConf.files }
}
如果未提供排除項目，則不會排除任何檔案。如果提供了排除項目，則檔案不得符合任何排除模式才能進行處理。
SourceTask exclude(Iterable<String>
Iterable<String>新增 ANT 樣式的排除模式。可以多次呼叫此方法以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供排除項目，則不會排除任何檔案。如果提供了排除項目，則檔案不得符合任何排除模式才能進行處理。
SourceTask exclude(String...
String...新增 ANT 樣式的排除模式。可以多次呼叫此方法以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供排除項目，則不會排除任何檔案。如果提供了排除項目，則檔案不得符合任何排除模式才能進行處理。
SourceTask exclude(Spec<FileTreeElement>
Spec<FileTreeElement>新增排除規格。可以多次呼叫此方法以附加新的規格。如果未提供排除項目，則不會排除任何檔案。如果提供了排除項目，則檔案不得符合任何排除模式才能進行處理。
SourceTask include(Closure includeSpec)
新增包含規格。可以多次呼叫此方法以附加新的規格。給定的閉包會傳遞一個 FileTreeElement 作為其參數。如果未提供包含項目，則將包含此容器中的所有檔案。如果提供了包含項目，則檔案必須符合至少一個包含模式或規格才能包含。
SourceTask include(Iterable<String>
Iterable<String>新增 ANT 樣式的包含模式。可以多次呼叫此方法以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供包含項目，則將包含此容器中的所有檔案。如果提供了包含項目，則檔案必須符合至少一個包含模式才能進行處理。
SourceTask include(String...
String...新增 ANT 樣式的包含模式。可以多次呼叫此方法以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供包含項目，則將包含此容器中的所有檔案。如果提供了包含項目，則檔案必須符合至少一個包含模式才能進行處理。
SourceTask include(Spec<FileTreeElement>
Spec<FileTreeElement>新增包含規格。可以多次呼叫此方法以附加新的規格。如果未提供包含項目，則將包含此容器中的所有檔案。如果提供了包含項目，則檔案必須符合至少一個包含模式或規格才能包含。
CodeNarcReports reports(Action<? super CodeNarcReports>
Action<? super CodeNarcReports>配置由此任務產生的報告。
SourceTask source(Object...
Object...為此任務新增一些來源。給定的來源物件將根據 Project.files(java.lang.Object[]) 進行評估。