dcycle/shell-lint

Dcycle Shell Lint 镜像文档

镜像概述

Dcycle Shell Lint是一个基于https://github.com/koalaman/shellcheck的Docker镜像，专门用于对Shell脚本进行静态代码分析。该镜像无需在本地安装shellcheck，通过容器化方式提供便捷的Shell脚本检查能力，帮助开发者快速识别脚本中的语法错误、潜在缺陷和不符合最佳实践的代码。

核心功能与特性

• 基于shellcheck：集成shellcheck工具，支持bash、sh、ksh等多种Shell方言的检查
• 静态代码分析：检测语法错误、未定义变量、数组索引错误等编译时问题
• 潜在问题识别：发现逻辑缺陷、资源泄漏风险、性能隐患等运行时潜在问题
• 最佳实践检查：提供符合Shell脚本开发规范的建议，如引用变量、避免全局变量等
• 容器化优势：无需本地配置依赖，跨平台一致性，简化CI/CD集成流程

使用场景

• 本地开发：编写Shell脚本时即时检查，提前发现并修复问题
• 代码审查：作为提交前检查工具，确保脚本质量符合团队规范
• CI/CD流程：集成到自动化构建 pipeline 中，实现脚本质量的自动化把关
• 教学培训：帮助新手学习Shell脚本最佳实践，理解常见错误类型

使用方法

基本检查命令

通过docker run运行镜像，挂载本地脚本目录并指定目标脚本：

bash
docker run --rm -v "$(pwd):/app" docker.xuanyuan.run/dcycle/shell-lint:latest /app/your-script.sh

参数说明：

• --rm：容器运行结束后自动删除，避免残留容器实例
• -v "$(pwd):/app"：将当前工作目录挂载到容器内的/app目录，使容器可访问本地脚本文件
• dcycle/shell-lint:latest：镜像名称及标签（建议使用特定版本号代替latest以确保稳定性）
• /app/your-script.sh：容器内的目标脚本路径（对应本地挂载目录中的脚本文件）

检查目录下所有脚本

如需批量检查目录中的所有Shell脚本，可结合find命令使用：

bash
docker run --rm -v "$(pwd):/app" docker.xuanyuan.run/dcycle/shell-lint:latest find /app -name "*.sh" -exec shellcheck {} +

指定shellcheck配置

如需使用自定义shellcheck配置（如.shellcheckrc文件），可将配置文件一同挂载到容器中：

bash
docker run --rm -v "$(pwd):/app" -v "$(pwd)/.shellcheckrc:/root/.shellcheckrc" docker.xuanyuan.run/dcycle/shell-lint:latest /app/your-script.sh

更多资源

完整文档及高级用法（如CI集成示例、自定义规则配置等）请参考 https://github.com/dcycle/docker-shell-lint