用途:为编写 Bash 脚本提供统一结构与规范,让脚本更清晰、模块化,并具备基本错误处理。触发场景包括“write a script”“bash script”“shell script”“automate with bash”。
主要能力:给出脚本模板,要求使用 #!/usr/bin/env bash 与 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);一个函数只做一件事,若需用“and”描述就拆分;函数开头用 log 记录进度,结尾给出状态;每个函数保持 5-20 行;按逻辑分组并加节标题。
使用方式:按模板组织脚本,先声明配置与颜色,再写 main 编排流程,随后是辅助函数与核心函数,最后调用 main。
适用场景:需要编写或重构 Bash/shell 脚本、实现自动化任务时参考。
限制:资料未提供具体平台、依赖版本、测试方式或收费信息;模板中的变量名与函数名需按实际任务替换。