nvuillam/npm-groovy-lint

镜像概述

本镜像基于npm-groovy-lint项目构建，是一款专注于Groovy生态相关文件的代码质量工具。主要用于对Groovy脚本、Jenkinsfile（Jenkins流水线配置文件）及Gradle构建文件进行Lint静态代码检查、代码格式化与自动修复，帮助开发者提升代码规范性和质量。

核心功能和特性

• 多文件类型支持：全面支持Groovy脚本、Jenkinsfile及Gradle构建文件的处理
• Lint检查：通过静态分析识别代码中的语法错误、潜在问题及不规范写法
• 代码格式化：统一代码风格，支持按预设规则自动调整缩进、空格、换行等格式
• 自动修复：对可自动修复的代码问题（如语法错误、格式问题）提供一键修复功能

使用场景

• 本地开发环境：集成到开发流程中，在提交代码前进行本地代码质量自检
• CI/CD流水线：作为自动化构建流程的一环，在代码合并前执行Lint检查，确保代码质量
• 代码评审辅助：在代码评审阶段提供标准化的代码质量报告，减少人工检查成本

使用方法

基本使用（Docker Run）

通过挂载本地目录到容器中，对目标文件进行处理：

bash
docker run --rm -v $(pwd):/app docker.xuanyuan.run/nvuillam/npm-groovy-lint [选项] <目标文件或目录>

参数说明（常用）

• 无参数：默认对挂载目录下的所有支持文件进行Lint检查
• --format：仅执行代码格式化操作
• --fix：对检测到的可修复问题执行自动修复
• --file <路径>：指定单个文件进行处理（如--file Jenkinsfile）
• --dir <路径>：指定目录进行批量处理（如--dir src/main/groovy）

示例

1. 检查当前目录下所有支持文件：

bash
docker run --rm -v $(pwd):/app docker.xuanyuan.run/nvuillam/npm-groovy-lint

2. 格式化并修复Jenkinsfile：

bash
docker run --rm -v $(pwd):/app docker.xuanyuan.run/nvuillam/npm-groovy-lint --fix --file Jenkinsfile

3. 批量处理Groovy源码目录：

bash
docker run --rm -v $(pwd):/app docker.xuanyuan.run/nvuillam/npm-groovy-lint --format --dir src/main/groovy

更多详细配置及参数说明，请参考项目官方文档：https://github.com/nvuillam/npm-groovy-lint#readme