编程开发 通用 中文 English CLI 工具构建 在本仓库中为 [该工具的功能] 构建一个命令行工具。目标:一个经验丰富的用户可以毫无意外地运行的 CLI…… 生成后的提示词 在本仓库中为 `[该工具的功能]` 构建一个命令行工具。目标:一个经验丰富的用户可以无意外运行的 CLI——正确的退出码、干净的 `--help`、在管道和脚本下行为合理,以及直接覆盖逻辑的测试套件。 ## 步骤 1. **阅读项目的 CLI 约定** - 检查现有 CLI 框架(argparse、click、cobra、commander、clap)和入口点,并沿用其声明选项、打印错误和安装工具的方式。 2. **先设计接口** - 在编码前写下标志和参数:必需与可选、默认值、别名、冲突规则。优先使用小接口和显式标志,而不是位置参数魔法,让每件事都有一种显而易见的做法。 3. **将解析与运行分离** - 按解析、运行、渲染来组织,使核心逻辑位于测试可直接调用的普通函数中。入口点是一个薄包装器,将失败映射为退出码。 4. **对输入保持防御** - 仅在接口明确要求时读取 stdin,绝不要阻塞在用户从未打开的管道上。以清晰消息处理缺失文件、无效值、空输入和非 UTF-8 数据,而不是 traceback。 5. **让退出码有意义** - 成功时退出 0,每类失败(用法、运行时、输入)使用不同的非零码,并分别记录。遵守 `SIGPIPE`,使关闭的管道不会表现为错误。 6. **区分 TTY 与管道** - 在打印颜色、加载动画或进度条之前检测 TTY,否则降级为纯文本。绝不将控制字符或 ANSI 转义写入管道流。 7. **验证** - 针对真实和边缘输入运行:空 stdin、大输入、无效标志、缺失参数、unicode 路径。确认退出码、`--help`,以及干净地管道到另一个命令,然后运行测试套件和代码检查工具。 ## 验证 - [ ] 每个退出码都有文档记录,并且可由测试触达。 - [ ] 将输出管道到另一个命令可以正常工作,并且在管道关闭时不会挂起或报错。 - [ ] 错误标志或缺失参数会打印用法消息,绝不打印 traceback。 - [ ] 核心逻辑由直接调用该函数的测试覆盖,而不仅仅通过子进程测试。 ## 规则 - 绝不向用户打印原始 traceback;将错误格式化为 `tool: message`。 - 绝不使用全局可变状态;保持 run 函数纯粹且可注入。 - 绝不添加无法记录和测试的标志。 - 优先匹配仓库现有的 CLI 约定,而不是你的偏好。 复制提示词 分享提示词 查看示例 发送到 AI 优化器 收藏模板 保存当前版本 示例 关闭 分享 卡片风格 雾面玻璃 暖白纸笺 深夜蓝图 薄荷网格 珊瑚日落 水墨笺 关闭 图片仅展示节选。