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