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 类。