用途
Google Shell Style Guide 是一个 Shell 脚本规范技能,在用户要求重构 Shell 脚本、修复 Bash 风格、套用 Google 风格指南、审查脚本风格或格式化 Bash 脚本时使用。目标是以 Google 的 Shell 风格指南为基础,形成一致、安全、可读的 Shell 脚本实践。
核心原则
- 一致性:修改文件时遵循该文件已有的风格。
- 安全性:变量加引号、使用 [[ ]]、避免 eval。
- 可读性:2 空格缩进、80 字符行长、清晰命名。
主要能力
格式与结构
- 缩进使用 2 个空格,不用制表符(例外:<<- 的 heredoc)。
- 行长最大 80 字符,长字符串可用 heredoc 或内嵌换行。
- 管道能放一行就放一行,否则在换行处用 | 拆分。
- if/for/while 的 ; then 与 ; do 与关键字同行。
- case 分支缩进 2 空格,简单分支写一行。
- 函数放在常量之后、顶部区域,函数之间不写可执行代码;多函数脚本必须有 main 函数并以 main "$@" 调用。
变量与展开
- 含变量、命令替换或特殊字符的字符串始终加引号。
- 优先使用 "${var}" 带花括号;单字符位置参数($1、$@)例外。
- 列表(尤其命令参数)使用数组,通过 "${flags[@]}" 传递。
- 函数变量始终用 local 声明,声明与命令替换分开。
- 常量用大写加下划线,并用 readonly 或 declare -xr。
命令替换、测试与算术
- 命令替换始终用 $(command),不用反引号。
- 测试一律用 [[ ]],字符串用 -z/-n,数值用 (( ))。
- 算术用 (( )) 或 $(( )),不用 let、expr、$[ ]。
命名约定
- 函数:小写加下划线,花括号同行;支持 namespaced 函数写法。
- 局部变量:小写加下划线。
- 常量:大写加下划线,配合 readonly。
常见反模式
- 避免 eval。
- 脚本中避免别名,改用函数。
- 避免管道到 while,改用进程替换以保留变量。
- 避免 mapfile/readarray(macOS 的 Bash 3.2 不支持),改用 while read 循环。
- 通配符使用显式路径前缀,如 rm -v ./*。
错误处理
- 检查返回值,失败时向 stderr 输出并以非零退出。
- 用 PIPESTATUS 检查管道各组件失败。
安全模式
- 临时文件用 mktemp 并配合 trap 清理。
- 输入校验:拒绝空值、拒绝路径穿越(..)、要求位于允许目录内。
- 防命令注入:不以 eval 处理外部输入,动态命令用数组;变量展开加引号;用户提供的文件名前加 -- 防止选项注入。
问题严重程度分级
- 严重(必须修复):rm/mv 或路径操作中未加引号的变量、对外部输入使用 eval、破坏性操作缺少错误处理、命令注入漏洞。
- 重要(应当修复):用 [ ] 而非 [[ ]]、函数缺少 local、用反引号而非 $()、多函数脚本缺少 main 函数。
- 次要(建议):缩进不一致、行长超过 80 字符、简单变量缺少花括号、注释格式。
使用方式
在需要重构、修复、格式化或审查 Shell 脚本时启用该技能,按上述规则检查并调整脚本;审查时可依据严重程度分级组织问题清单。完整指南见 https://google.github.io/styleguide/shellguide.html。
适用场景
Bash/Shell 脚本重构与风格统一、代码审查、安全加固(引号、eval、注入、临时文件、输入校验)、跨平台可移植性修正(如 macOS 兼容)。
限制
资料仅给出规范内容与严重程度分级,未提供安装方式、运行命令、平台支持范围、收费或效果说明,这些暂未提供。