groovylint Docker镜像文档

镜像概述

groovylint是CODENARC的Docker化版本，专为Groovy文件的静态代码分析设计。该镜像封装了CODENARC代码质量工具，提供便捷的容器化部署方式，无需本地配置Java或Groovy环境，即可快速对Groovy项目进行代码质量检查，帮助开发者识别潜在问题、规范代码风格。

核心功能与特性

• 基于CODENARC：集成CODENARC核心功能，支持对Groovy代码进行静态分析，覆盖代码风格、错误风险、性能问题等多维度检查
• 规则灵活配置：支持使用内置规则集（如basic、naming、design等）或自定义规则文件，满足不同项目的代码规范需求
• 容器化部署：无需本地安装依赖，通过Docker快速启动，简化环境配置，提升跨平台一致性
• 多场景适配：支持多种输出格式（文本、XML、HTML），可灵活集成到本地开发流程或CI/CD流水线

使用场景与适用范围

• 本地开发：开发者在提交代码前进行本地代码质量自检，提前发现问题
• CI/CD集成：作为自动化流水线的环节，在代码提交或合并时自动执行，确保代码质量符合团队标准
• 团队协作：统一代码检查规则，减少团队协作中的代码风格分歧
• 项目审计：对现有Groovy项目进行批量代码质量评估，辅助重构或优化

使用方法与配置说明

基本用法

通过docker run命令启动容器，挂载本地Groovy文件目录至容器内工作区，执行代码检查：

docker run --rm -v /本地/groovy文件目录:/workspace abletondevtools/groovylint codenarc /workspace

参数说明：

• --rm：容器运行结束后自动删除，避免残留容器文件
• -v /本地/groovy文件目录:/workspace：将本地Groovy项目目录挂载到容器内的/workspace目录（容器内默认工作目录）
• abletondevtools/groovylint：镜像名称
• codenarc /workspace：执行CODENARC命令，检查/workspace目录下的Groovy文件

自定义规则配置

通过挂载自定义规则文件，实现个性化代码检查规则。规则文件采用Groovy语法定义，示例如下：

1. 创建自定义规则文件（rules.groovy）

ruleset {
    description '项目自定义Groovy代码检查规则'
    // 引入内置基础规则集
    ruleSet('rulesets/basic.xml')
    ruleSet('rulesets/naming.xml')
    // 自定义规则参数
    rule('UnusedVariable') { 
        priority 1  // 高优先级（1-3，1为最高）
        enabled true 
    }
    rule('EmptyCatchBlock') { 
        enabled false  // 禁用空catch块检查
    }
}

2. 挂载规则文件并执行检查

docker run --rm \
  -v /本地/groovy文件目录:/workspace \
  -v /本地/规则文件目录/rules.groovy:/config/rules.groovy \
  abletondevtools/groovylint \
  codenarc -rulesetfiles:/config/rules.groovy /workspace

高级配置选项

输出格式指定

通过-format参数设置检查结果输出格式，支持text（默认）、xml、html等：

# 输出XML格式结果到文件
docker run --rm -v $(pwd):/workspace abletondevtools/groovylint codenarc -format xml -report /workspace/lint-result.xml /workspace

文件过滤

使用-includes和-excludes参数指定检查范围：

# 仅检查src目录下的.groovy文件，排除test目录
docker run --rm -v $(pwd):/workspace abletondevtools/groovylint codenarc -includes "src/**/*.groovy" -excludes "test/**/*" /workspace

CI/CD集成示例

GitHub Actions配置

在项目根目录创建.github/workflows/groovylint.yml，实现代码提交时自动检查：

name: Groovy Code Quality Check
on: [push, pull_request]

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      
      - name: Run groovylint
        run: |
          docker run --rm -v $(pwd):/workspace abletondevtools/groovylint codenarc -format text /workspace

常用内置规则集

CODENARC提供多种内置规则集，可直接通过规则文件引入：

• rulesets/basic.xml：基础语法与错误检查
• rulesets/naming.xml：命名规范检查（类名、方法名等）
• rulesets/design.xml：设计原则检查（如单例模式、循环依赖）
• rulesets/security.xml：安全风险检查（如硬编码密码）
• rulesets/performance.xml：性能优化相关检查

更多规则集及详细说明可参考CODENARC官方文档。