热门搜索:
codacy/codacy-shellcheck
codacy
Codacy ShellCheck Docker镜像集成ShellCheck工具，用于对shell脚本进行静态分析，检测语法错误与常见问题，辅助提升代码质量。
下载次数: 0状态：社区镜像维护者：codacy仓库类型：镜像最近更新：2 个月前
让 AI 帮你使用轩辕镜像？ · 展开查看说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
Codacy ShellCheck Docker镜像
镜像概述和主要用途
Codacy ShellCheck Docker镜像是Codacy平台集成的Shell脚本静态分析引擎，基于ShellCheck工具构建，用于自动化检测Shell脚本（如bash、sh、zsh）中的语法错误、逻辑缺陷、性能问题及最佳实践违规。该镜像提供与Codacy平台兼容的报告格式，支持集成到CI/CD流程或本地开发环境，实现Shell脚本代码质量的自动化监控与审查。
核心功能和特性
- 静态代码分析：基于ShellCheck核心能力，检测Shell脚本中的语法错误、未定义变量、逻辑漏洞、性能隐患等问题。
- Codacy报告集成：输出符合Codacy平台规范的JSON报告，支持自动化代码审查流程。
- 灵活配置：支持自定义检查规则（如忽略特定错误码、调整检查级别）。
- 轻量易用：Docker化封装，无需本地安装依赖，直接通过容器运行检查。
- 多场景适配：兼容CI/CD管道、本地开发环境及Codacy平台集成。
使用场景和适用范围
- CI/CD流程集成：在代码提交或构建阶段自动运行，阻止存在Shell脚本问题的代码合并。
- Codacy平台扩展：作为Codacy代码质量分析的补充引擎，增强Shell脚本检查能力。
- 本地开发辅助：开发人员本地运行，提前发现Shell脚本问题，减少代码评审成本。
- 大型项目治理：对包含大量Shell脚本的项目（如DevOps工具链、部署脚本）进行批量质量扫描。
使用方法和配置说明
基本使用（Docker Run）
通过docker run命令挂载目标脚本目录，指定检查路径即可运行分析。基础命令格式：
bashdocker run --rm -v <本地脚本目录>:/src codacy/codacy-shellcheck --check-path /src
参数说明
| 参数 | 描述 | 示例值 |
|---|---|---|
--check-path | 指定容器内待检查的文件或目录路径（需与挂载路径对应） | /src/scripts |
--severity | 最低报告级别（error/warning/info，默认error） | warning |
--exclude | 忽略的ShellCheck错误码（逗号分隔，如SC1000,SC2001） | SC1090,SC2148 |
--output-format | 报告输出格式（codacy/json/text，默认codacy） | json |
--debug | 启用调试模式，输出详细检查过程日志（可选，默认关闭） | true |
环境变量
部分配置可通过环境变量传递，适用于CI/CD等自动化场景：
| 环境变量 | 描述 | 示例值 |
|---|---|---|
SHELLCHECK_OPTS | 传递给ShellCheck的原生参数（覆盖镜像默认配置） | --severity=warning |
CODACY_REPORT_PATH | 指定报告输出文件路径（容器内路径，需挂载目录以持久化） | /src/codacy-report.json |
Docker部署方案示例
Docker Run 示例
1. 本地检查单个脚本
检查本地./scripts/deploy.sh脚本，输出文本格式报告：
bashdocker 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）错误：
bashdocker 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
- 构建流水线：[***]
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 codacy-shellcheck 镜像标签
docker pull docker.xuanyuan.run/codacy/codacy-shellcheck:<标签>
DockerHub 原生拉取命令
docker pull codacy/codacy-shellcheck:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"