29、Gradle CodeNarc 插件

本文详细介绍了Gradle构建工具中的CodeNarc插件,用于对Groovy源代码执行静态代码分析和质量检查。内容包括插件用法、任务配置、项目布局、依赖管理以及如何集成到Gradle的check任务中,帮助开发者提升代码质量。

文章永久链接:https://ddkk.com/?p=9435

CodeNarc 插件

CodeNarc 插件使用 CodeNarc 对项目的 Groovy 源文件执行质量检查并生成报告。

用法

要使用CodeNarc 插件,请在构建脚本中包含以下语句:

使用 CodeNarc 插件

build.gradle

apply plugin: 'codenarc'  

该插件向你的项目添加了大量的执行质量检查的任务。你可以通过运行 gradle check 执行检查。

任务

CodeNarc 插件向project 中添加了以下任务:

表30.1. CodeNarc 插件 – 任务

任务名称依赖于类型描述
codenarcMaincodenarc针对生产 Groovy 源文件运行 CodeNarc。
codenarcTestcodenarc针对测试 Groovy 源文件运行 CodeNarc。
SourceSetcodenarc针对给定的source set 的 Groovy 源文件运行 CodeNarc。

CodeNarc 插件向 Groovy 插件所加入的任务添加了以下的依赖。

表30.2. CodeNarc 插件 – 附加的任务依赖

任务名称依赖于
check所有的 CodeNarc 任务,包括codenarcTest

项目布局

CodeNarc 插件预计是以下的项目布局:

表30.3. CodeNarc 插件 – 项目布局

File意义
config/codenarc/codenarc.xmlCodeNarc 配置文件

依赖管理

CodeNarc 插件添加了下列的依赖配置:

表30、4. CodeNarc 插件 – 依赖配置

名称意义
codenarc使用的 CodeNarc 库