codacy/codacy-shellcheck

Codacy ShellCheck Docker镜像

镜像概述和主要用途

Codacy ShellCheck Docker镜像是Codacy平台集成的Shell脚本静态分析引擎，基于ShellCheck工具构建，用于自动化检测Shell脚本（如bash、sh、zsh）中的语法错误、逻辑缺陷、性能问题及最佳实践违规。该镜像提供与Codacy平台兼容的报告格式，支持集成到CI/CD流程或本地开发环境，实现Shell脚本代码质量的自动化监控与审查。

核心功能和特性

1. 静态代码分析：基于ShellCheck核心能力，检测Shell脚本中的语法错误、未定义变量、逻辑漏洞、性能隐患等问题。
2. Codacy报告集成：输出符合Codacy平台规范的JSON报告，支持自动化代码审查流程。
3. 灵活配置：支持自定义检查规则（如忽略特定错误码、调整检查级别）。
4. 轻量易用：Docker化封装，无需本地安装依赖，直接通过容器运行检查。
5. 多场景适配：兼容CI/CD管道、本地开发环境及Codacy平台集成。

使用场景和适用范围

• CI/CD流程集成：在代码提交或构建阶段自动运行，阻止存在Shell脚本问题的代码合并。
• Codacy平台扩展：作为Codacy代码质量分析的补充引擎，增强Shell脚本检查能力。
• 本地开发辅助：开发人员本地运行，提前发现Shell脚本问题，减少代码评审成本。
• 大型项目治理：对包含大量Shell脚本的项目（如DevOps工具链、部署脚本）进行批量质量扫描。

使用方法和配置说明

基本使用（Docker Run）

通过docker run命令挂载目标脚本目录，指定检查路径即可运行分析。基础命令格式：

bash
docker run --rm -v <本地脚本目录>:/src codacy/codacy-shellcheck --check-path /src

参数说明

环境变量

部分配置可通过环境变量传递，适用于CI/CD等自动化场景：

Docker部署方案示例

Docker Run 示例

1. 本地检查单个脚本

检查本地./scripts/deploy.sh脚本，输出文本格式报告：

bash
docker run --rm \
  -v "$(pwd)/scripts:/src" \
  codacy/codacy-shellcheck \
  --check-path /src/deploy.sh \
  --output-format text

2. CI/CD集成（忽略指定错误码）

在CI流程中检查./ci目录下所有脚本，忽略SC1090（未找到源文件）和SC2148（缺少shebang）错误：

bash
docker run --rm \
  -v "$(pwd)/ci:/src" \
  codacy/codacy-shellcheck \
  --check-path /src \
  --exclude SC1090,SC2148 \
  --output-format codacy > codacy-shellcheck-report.json

源码和构建信息

• 源码仓库：https://github.com/codacy/codacy-shellcheck
• 构建流水线：[***]