用途:该技能面向 Bash 脚本编写,目标是产出结构清晰、可维护、接近生产可用的 shell 脚本,遵循现代最佳实践。
主要能力与原则:
- 严格模式:每个脚本以 set -euo pipefail 开头,尽早捕获错误,避免静默失败。
- 函数优先:把脚本拆成聚焦的单一职责函数,主流程像目录一样易读。
- 顶部文档:用头部注释说明用途、用法、配置与工作流,使脚本自文档化。
- 快速失败:错误信息要描述清楚,告诉用户哪里出错、如何修复。
脚本结构:
- 变量之后立即放置 main(),让工作流在文件顶部可见,实现细节放在后面。
- 提供标准头部注释块,包含 OVERVIEW、USAGE、CONFIGURATION。
- 定义颜色变量与配置变量,例如 VAR_ONE=${VAR_ONE:-default}、VAR_TWO=${VAR_TWO:?VAR_TWO is required}。
- 提供 log、info、warn、error 等辅助函数,error 输出到 stderr 并退出。
- 核心逻辑放在具名函数中,按用途分组并加分区注释。
- 脚本末尾以 main "$@" 执行。
函数与错误处理指南:
- 函数名用动词,如 setup_directory、validate_config、pull_images。
- 一个函数只做一件事,若需用“and”描述就应拆分。
- 函数开始记录进度,结束确认状态;用 return 0 成功、return 1 失败,由调用方决定处理。
- 函数保持 5-20 行,过长则考虑拆分。
- 检查命令结果,避免静默失败,错误信息包含上下文。
质量清单:启用严格模式、头部注释、辅助函数、核心逻辑具名化、main() 流程清晰、错误信息含上下文与修复建议、无静默失败、变量命名有意义、2 空格缩进、函数按逻辑分组。
限制:资料未提供该技能的具体安装方式、运行环境要求、收费信息或平台支持范围,暂未提供。