SuperAPI AI 工具集

writing-clean-shell

写作与研究

查看项目

更新于 10-15 17:24

技能介绍

用途:该技能用于组织和重构 Shell 脚本,使脚本可读、可更新、可维护,目标是让读取编排函数等同于读取脚本大纲。它教授的是组织方式而非语法,对平台(Linux、macOS、Windows)和 shell(bash、zsh、sh、PowerShell)保持中立;示例使用 bash 仅因其为参考材料,需将结构转译为目标 shell 的惯用写法。

主要能力:固定脚本布局,顶部依次为 shebang、配置与标志默认值、输出词汇层,随后是参数解析、帮助界面、守卫检查、单一任务的函数,最后是编排器与主流程。核心规则包括:不写注释(唯一例外是临时 TODO);让每种行为都成为函数;使用动词优先的 snake_case 命名;每个函数只做一件事;守卫子句置于函数开头;编排器置于底部,用步骤数组循环调用;接受参数时提供 -h/--help;保持统一的输出词汇;函数内变量用 local,标志变量用 UPPER_CASE 在顶层声明;简单解析参数。

使用方式:提供命令 commands/cleanup.md,用于对照规则做完整清单式审查与清理,适用于用户说“cleanup this script”“clean up this shell script”“review this script”等场景。重构流程为:读一遍脚本列出所有动词,转为动词优先函数;将前提条件转为守卫子句;按阶段分组并建立 run_* 编排器;上提标志变量并替换为 parse_arguments;参数存在则添加 print_usage 并将未知参数导向它;所有消息经打印层;删除注释。

适用场景:任何需要编写或创建 shell 脚本的场合,尤其是希望脚本结构清晰、便于团队维护和后续更新的项目。

限制:该技能不涉及具体语法教学,需按目标 shell 转译示例结构;文档未提供独立安装命令或平台兼容性细节;不含收费、价格、效果等信息。文中提到“Bash appears in the examples only because it is the reference material”,并给出无依赖 bash 示例,可直接运行。