CodeNarc 插件使用 CodeNarc 对您的项目的 Groovy 源代码文件执行质量检查,并从这些检查生成报告。

用法

要使用 CodeNarc 插件,请在您的构建脚本中包含以下内容

build.gradle.kts
plugins {
    codenarc
}
build.gradle
plugins {
    id 'codenarc'
}

该插件向项目添加了许多 Task,当与 Groovy 插件 一起使用时,这些 Task 将执行质量检查。您可以通过运行 gradle check 来执行检查。

Task

CodeNarc 插件向项目添加了以下 Task

codenarcMainCodeNarc

对生产 Groovy 源代码文件运行 CodeNarc。

codenarcTestCodeNarc

对测试 Groovy 源代码文件运行 CodeNarc。

codenarcSourceSetCodeNarc

对给定源集(source set)的 Groovy 源代码文件运行 CodeNarc。

添加到其他 Task 的依赖

CodeNarc 插件将以下依赖添加到 Groovy 插件定义的 Task。

check

依赖于:所有 CodeNarc Task,包括 codenarcMaincodenarcTest

项目布局

CodeNarc 插件期望以下项目布局

<root>
└── config
    └── codenarc           (1)
        └── codenarc.xml   (2)
1 CodeNarc 配置文件放在这里
2 主要的 CodeNarc 配置文件

依赖管理

CodeNarc 插件添加了以下依赖配置

表 1. CodeNarc 插件 - 依赖配置
名称 含义

codenarc

要使用的 CodeNarc 库

如果 CodeNarc 需要与用于编译 Groovy 源代码不同的 Groovy 版本,您可以使用 codenarc 配置来提供一个。

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