SuperAPI AI 工具集

bash-script-writer

编程与开发

查看项目

更新于 11-05 10:24

技能介绍

用途 bash-script-writer 是一个面向 Bash 与 Zsh 脚本的 AI 提示技能,用于编写、审查并可选测试 shell 脚本,使其符合项目编码标准。它适合任何 shell 脚本任务,包括新建脚本、修改现有脚本以及判断是否值得编写 ShellSpec 测试。

主要能力 该技能以工作流形式组织:先进行 Shell 选择,再按需加载 Zsh 指引,随后按脚本结构与编码规范编写代码,接着决定测试策略,最后执行验证。它默认使用 Bash,因为 Bash 几乎随处可用且受 ShellCheck 完整支持。只有在脚本会大量使用 Zsh 特有优势(如 glob 限定符、原生浮点运算、参数展开标志、zparseopts、可加载模块、嵌套递归 globbing)且运行环境可保证 Zsh 可用时,才建议用户确认改用 Zsh。

编码规范方面,要求脚本以 set -Eeuo pipefail 开头,使用 #!/usr/bin/env bash 以提高可移植性;提供颜色码定义、依赖检查、错误输出到 stderr、失败即停等约定。还强调使用 [[ ... ]] 与 (( ... )) 进行测试和整数运算、为所有展开加引号、用 local 声明函数变量、用数组传递参数、安全读取行、启用 nullglob、优先使用 printf 与 $(),并注意 Bash 数组从 0 开始以及 macOS 自带 Bash 3.2 的限制。函数组织建议分为工具函数、内容处理函数、主执行函数与参数处理,并以 main "$@" 结尾且加来源守卫。

使用方式 在技能流程中,若编辑现有脚本则保持其当前 shell;若用户明确指定 shell 或上下文强制(如 Dockerfile RUN、GitHub Actions run、容器入口、Makefile、CI 镜像)则直接使用对应 shell;Zsh 插件与补全函数等场景固有使用 Zsh。否则默认 Bash,仅在 Zsh 明显能降低复杂度或减少外部依赖时向用户说明具体收益与代价并请求确认,未获明确确认则使用 Bash。测试决策上,若项目本身以 shell 脚本为主要产物或用户明确要求测试,则使用 ShellSpec 并目标 85% 以上覆盖率;若脚本只是其他语言项目中的小型辅助,则不引入 ShellSpec,仅做验证。

验证步骤 无论是否使用 ShellSpec,都应执行:bash -n 语法检查、shellcheck 静态检查(若已安装)以及 ./script --help 冒烟测试。Zsh 脚本则改用 references/zsh.md 中列出的检查方式,因为 ShellCheck 不支持 Zsh。使用 ShellSpec 时,须通过 When run script 运行脚本以保证覆盖率被测量,并参考 references/testing-shellspec.md 了解结构、mock 与覆盖率规则。

适用场景与限制 适用于需要遵循统一编码标准的 shell 脚本创建与审查、shell 选择决策、测试投入判断以及基础验证的场景。限制包括:Zsh 可能未安装在服务器、容器、CI 或同事机器上;ShellCheck 不支持 Zsh;同一项目混用 shell 会增加认知负担;set -e 在 if、&&、|| 条件及由其调用的函数中会被抑制,需显式检查关键命令。该技能本身不提供收费、价格或平台信息——资料中暂未提供相关内容。