CodeNarc 外掛程式使用 CodeNarc 對您專案的 Groovy 原始碼檔案執行品質檢查，並從這些檢查產生報告。

用法

若要使用 CodeNarc 外掛程式，請在您的建置腳本中包含以下內容

範例 1. 使用 CodeNarc 外掛程式
build.gradle.kts
plugins {
    codenarc
}
build.gradle
plugins {
    id 'codenarc'
}

當與 Groovy 外掛程式一起使用時，此外掛程式會將許多任務新增至專案，以執行品質檢查。您可以透過執行 gradle check 來執行檢查。

任務

CodeNarc 外掛程式將以下任務新增至專案

codenarcMain — CodeNarc

對生產 Groovy 原始碼檔案執行 CodeNarc。

codenarcTest — CodeNarc

對測試 Groovy 原始碼檔案執行 CodeNarc。

codenarcSourceSet — CodeNarc

對給定來源集的 Groovy 原始碼檔案執行 CodeNarc。

新增至其他任務的依賴

CodeNarc 外掛程式將以下依賴新增至 Groovy 外掛程式定義的任務。

check

依賴於：所有 CodeNarc 任務，包括 codenarcMain 和 codenarcTest。

專案佈局

CodeNarc 外掛程式預期以下專案佈局

<root>
└── config
    └── codenarc           (1)
        └── codenarc.xml   (2)
1 CodeNarc 配置檔案放在這裡
2 主要 CodeNarc 配置檔案

依賴管理

CodeNarc 外掛程式新增以下依賴配置

表 1. CodeNarc 外掛程式 - 依賴配置
名稱 含義

codenarc

要使用的 CodeNarc 函式庫

如果 CodeNarc 需要與用於編譯 Groovy 原始碼的版本不同的 Groovy 版本，您可以使用 codenarc 配置提供一個。
範例 2. 指定 Groovy 版本
build.gradle.kts
dependencies {
    "codenarc"("org.codehaus.groovy:groovy-all:3.0.3")
    "codenarc"("org.codenarc:CodeNarc:1.6.1")
}
build.gradle
dependencies {
    codenarc 'org.codehaus.groovy:groovy-all:3.0.3'
    codenarc 'org.codenarc:CodeNarc:1.6.1'
}

配置

請參閱 API 文件中的 CodeNarcExtension 類別。