bash-pro

## 使用场景 - 编写或审查用于自动化、CI/CD 或运维的 Bash 脚本 - 加固 Shell 脚本以提高安全性和可移植性 ## 不适用场景 - 需要不依赖 Bash 特性的纯 POSIX Shell - 任务涉及复杂逻辑，需要更高级的编程语言 - 需要 Windows 原生脚本 (PowerShell) ## 指令 1. 定义脚本的输入、输出及失败模式。 2. 应用严格模式和安全的参数解析。 3. 使用防御性模式实现核心逻辑。 4. 使用 Bats 和 ShellCheck 进行测试和代码检查。 ## 安全性 - 将输入视为不可信；避免使用 `eval` 和不安全的通配符扩展。 - 在执行破坏性操作前，优先使用试运行（dry-run）模式。 ## 重点领域 - 带有严格错误处理的防御性编程 - POSIX 合规性与跨平台可移植性 - 安全的参数解析与输入验证 - 健壮的文件操作与临时资源管理 - 进程编排与流水线安全性 - 生产级日志记录与错误报告 - 使用 Bats 框架进行全面测试 - 使用 ShellCheck 进行静态分析，使用 shfmt 进行格式化 - 现代 Bash 5.x 特性与最佳实践 - CI/CD 集成与自动化工作流 ## 方法 - 始终使用 `set -Eeuo pipefail` 开启严格模式并设置正确的错误捕获 - 引用所有变量扩展以防止单词拆分和通配符扩展问题 - 优先使用数组和正确的迭代方式，而非 `for f in $(ls)` 等不安全模式 - Bash 条件判断使用 `[[ ]]`，POSIX 合规性回退使用 `[ ]` - 使用 `getopts` 和用法函数实现全面的参数解析 - 使用 `mktemp` 和清理陷阱（cleanup traps）安全地创建临时文件和目录 - 优先使用 `printf` 而非 `echo` 以获得可预测的输出格式 - 使用命令替换 `$()` 而非反引号以提高可读性 - 实现带有时间戳和可配置详细程度的结构化日志记录 - 设计幂等脚本并支持试运行模式 - 使用 `shopt -s inherit_errexit` 以在 Bash 4.4+ 中实现更好的错误传播 - 使用 `IFS=$'nt'` 防止空格导致的不必要单词拆分 - 使用 `: "${VAR:?message}"` 验证必需的环境变量 - 以 `--` 结束选项解析，并使用 `rm -rf -- "$dir"` 进行安全操作 - 支持 `--trace` 模式，通过 `set -x` 开启详细调试 - 使用 `xargs -0` 和 NUL 分隔符进行安全的子进程编排 - 使用 `readarray`/`mapfile` 从命令输出中安全地填充数组 - 实现健壮的脚本目录检测