shellcheck Docker镜像文档

镜像概述和主要用途

shellcheck Docker镜像是一个预配置的容器化环境，集成了静态分析工具shellcheck，用于检查shell脚本中的语法错误、常见陷阱及最佳实践问题。该镜像无需本地安装shellcheck，可直接通过Docker运行，提供便捷、一致的脚本检查环境，适用于各类shell脚本开发与质量保障场景。

核心功能和特性

核心功能

• 静态分析shell脚本：自动检测bash、sh、ksh等多种shell脚本的语法错误
• 多类型问题识别：覆盖语法错误（如未闭合引号）、运行时陷阱（如未定义变量引用）、逻辑缺陷（如死代码）及最佳实践问题（如低效命令使用）
• 支持多种shell方言：兼容bash、POSIX sh、ksh、zsh等常见shell语法

镜像特性

• 即开即用：无需手动配置依赖，拉取镜像后可直接运行检查
• 工具版本动态更新：镜像中集成的shellcheck及相关工具可能随机更新，保持较新版本特性
• 跨平台兼容：基于Docker容器化，支持Linux、macOS、Windows等所有Docker兼容系统

使用场景和适用范围

适用场景

• 开发环境脚本检查：本地开发时快速验证shell脚本语法正确性
• CI/CD流程集成：作为代码提交或构建环节的前置检查，确保脚本质量
• 自动化测试环节：在测试流程中集成，避免因脚本错误导致测试失败
• 临时脚本检查：快速检查单个或多个临时编写的shell脚本文件

适用范围

• 支持检查.sh、.bash等扩展名的shell脚本文件
• 兼容个人开发、团队协作及企业级自动化流程
• 适用于需要保障shell脚本稳定性与可维护性的场景

详细使用方法和配置说明

基本使用方法

通过docker run命令直接运行镜像，挂载本地脚本目录至容器内，并指定待检查的脚本文件路径：

# 检查单个脚本文件（假设脚本位于当前目录）
docker run --rm -v $(pwd):/workspace toolhippie/shellcheck shellcheck /workspace/your_script.sh

# 检查目录下所有.sh文件
docker run --rm -v $(pwd):/workspace toolhippie/shellcheck find /workspace -name "*.sh" -exec shellcheck {} +

说明：--rm参数确保容器退出后自动清理；-v $(pwd):/workspace将当前目录挂载至容器内/workspace目录，使容器可访问本地脚本文件。

高级配置与参数传递

shellcheck支持通过命令行参数自定义检查行为，可直接在docker run命令中传递：

示例1：指定shell类型（如bash）

docker run --rm -v $(pwd):/workspace toolhippie/shellcheck shellcheck --shell=bash /workspace/script.bash

示例2：输出JSON格式检查结果（便于自动化解析）

docker run --rm -v $(pwd):/workspace toolhippie/shellcheck shellcheck --format=json /workspace/script.sh

示例3：忽略特定错误（如允许未定义变量）

docker run --rm -v $(pwd):/workspace toolhippie/shellcheck shellcheck --exclude=SC2154 /workspace/script.sh

注：完整参数列表可通过shellcheck --help查看，或参考shellcheck官方文档。

版本信息

镜像的可用版本标签可通过以下链接查看，列表实时更新：

• DockerHub tags
• Quay.io tags

贡献指南

贡献流程：Fork → 提交补丁 → 推送分支 → 提交Pull Request

作者

• Thomas Boerger

许可证

MIT

版权信息

Copyright (c) 2018 Thomas Boerger <[***]>