dcycle/shell-lint

Dcycle Shell Lint 镜像文档

镜像概述

Dcycle Shell Lint是一个基于https://github.com/koalaman/shellcheck%E7%9A%84Docker%E9%95%9C%E5%83%8F%EF%BC%8C%E4%B8%93%E9%97%A8%E7%94%A8%E4%BA%8E%E5%AF%B9Shell%E8%84%9A%E6%9C%AC%E8%BF%9B%E8%A1%8C%E9%9D%99%E6%80%81%E4%BB%A3%E7%A0%81%E5%88%86%E6%9E%90%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E6%97%A0%E9%9C%80%E5%9C%A8%E6%9C%AC%E5%9C%B0%E5%AE%89%E8%A3%85shellcheck%EF%BC%8C%E9%80%9A%E8%BF%87%E5%AE%B9%E5%99%A8%E5%8C%96%E6%96%B9%E5%BC%8F%E6%8F%90%E4%BE%9B%E4%BE%BF%E6%8D%B7%E7%9A%84Shell%E8%84%9A%E6%9C%AC%E6%A3%80%E6%9F%A5%E8%83%BD%E5%8A%9B%EF%BC%8C%E5%B8%AE%E5%8A%A9%E5%BC%80%E5%8F%91%E8%80%85%E5%BF%AB%E9%80%9F%E8%AF%86%E5%88%AB%E8%84%9A%E6%9C%AC%E4%B8%AD%E7%9A%84%E8%AF%AD%E6%B3%95%E9%94%99%E8%AF%AF%E3%80%81%E6%BD%9C%E5%9C%A8%E7%BC%BA%E9%99%B7%E5%92%8C%E4%B8%8D%E7%AC%A6%E5%90%88%E6%9C%80%E4%BD%B3%E5%AE%9E%E8%B7%B5%E7%9A%84%E4%BB%A3%E7%A0%81%E3%80%82

核心功能与特性

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

使用场景

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

使用方法

基本检查命令

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

bash
docker run --rm -v "$(pwd):/app" 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" 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" dcycle/shell-lint:latest /app/your-script.sh

更多资源

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