如何配置 ShellCheck 实现 Shell 脚本静态分析与质量把控

解决 Shell 脚本编写中常见的低级错误（如变量未加引号、语法不兼容）以及可移植性问题，通过配置 ShellCheck 静态分析工具将错误拦截在提交阶段。

为什么需要这个技能

Shell 脚本在运维和自动化中极其常见，但由于其语法灵活且缺乏强类型检查，很容易出现难以排查的 Bug。例如，一个忘记加双引号的变量在路径包含空格时会导致脚本崩溃，或者在 sh 环境下运行了 bash 特有的语法导致执行失败。

ShellCheck 能够通过预定义的 100 多个规则，在脚本运行前就检测出这些问题。掌握其配置方法，可以让开发者将质量检查标准化，避免在生产环境下因脚本低级错误导致事故。

根据操作系统安装 shellcheck，并验证版本以确保功能完整。

# macOS
brew install shellcheck

# Ubuntu/Debian
apt-get install shellcheck

# 验证安装
shellcheck --version

可以通过 .shellcheckrc 文件定义项目级的分析策略，避免在命令行中输入冗长参数。

# .shellcheckrc 示例
shell=bash
enable=avoid-nullary-conditions,require-variable-braces
disable=SC1091 # 禁用由于无法跟踪 sourced 文件而产生的警告

针对分析出的错误码（如 SC2086 变量引用未加引号），优先通过修改代码修复；对于确实不需要的警告，使用内联指令抑制。

# shellcheck disable=SC2086
for file in $(ls -la); do
    echo "$file"
done

将 ShellCheck 接入 Git Pre-commit 钩子或 GitHub Actions，确保不合格的代码无法被合入。

# GitHub Actions 示例片段
- name: Run ShellCheck
  run: |
    sudo apt-get install shellcheck
    find . -type f -name "*.sh" -exec shellcheck {} \;

解压后将目录放入你的 AI 工具 skills 文件夹，重启工具后即可使用。具体路径参考内附的 USAGE.zh.md。

暂无推荐