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 函式庫

組態

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