用途
bash-script-template 用于生成遵循最佳实践的 Bash 脚本模板,帮助开发者在新建 Shell 脚本时直接获得统一的错误处理、参数解析、日志输出与可移植性配置,减少重复搭建脚手架的工作。
主要能力
- 生成健壮的 Bash 脚本模板
- 设置正确的错误处理机制
- 使用 getopts 实现参数解析(含短选项与长选项)
- 创建日志工具函数
- 配置严格模式设置
- 生成可复用的函数库
使用方式
在以下场景调用该技能:创建遵循最佳实践的新 Bash 脚本、建立正确的错误处理模式、实现参数解析、创建可移植的 Shell 脚本。
输入参数:
- scriptName(字符串,必填):脚本名称
- description(字符串,必填):脚本描述
- arguments(数组,可选):脚本参数
- functions(数组,可选):要包含的函数
生成的模板结构
模板包含以下组成部分:
- Shebang 与头部注释(脚本名、描述、用法行)
- 严格模式:
set -euo pipefail与IFS=$'\n\t' - 只读的
SCRIPT_DIR与SCRIPT_NAME变量 - 终端颜色变量(仅在支持颜色时启用,否则置空)
- 日志函数:
log_info、log_success、log_warn、log_error、die - 退出清理:
cleanup函数配合trap cleanup EXIT usage帮助信息函数parse_args参数解析函数,支持-h/--help、-v/--verbose、-d/--dry-run、-f/--force、-o/--output,并处理缺失参数与未知选项- 默认值设置(VERBOSE、DRY_RUN、FORCE、OUTPUT)
main主函数与入口调用
适用场景
- 新建命令行 Bash 脚本时快速获得规范骨架
- 统一团队内脚本的错误处理与日志风格
- 需要同时支持短选项和长选项的 CLI 工具
- 需要在退出时执行清理任务的脚本
限制
资料未说明该技能的安装方式、运行环境要求、支持的平台范围、是否收费及许可信息,这些内容暂未提供。模板中的具体业务逻辑需使用者自行填充。