SuperAPI AI 工具集

clack-guidelines

编程与开发

查看项目

更新于 11-15 01:39

技能介绍

Clack Guidelines 是一份面向开发者的技能指南,主题是使用 Clack(@clack/prompts)构建美观的交互式命令行界面(CLI)。资料以代码示例和常见模式为主线,覆盖从基础输入到完整安装向导的多类交互场景。\n\n用途与定位:该指南用于指导开发者创建带文本输入、选项选择、自动补全、进度显示和流式输出的 CLI 工具,适合构建项目脚手架、安装向导、配置生成器等交互式命令行应用。\n\n主要能力(以资料所列示例为准):\n- 文本输入 text:支持占位符、初始值和 validate 校验。\n- 密码输入 password:支持掩码显示和长度校验。\n- 自动补全单选 autocomplete 与多选 autocompleteMultiselect:支持输入过滤、maxItems 和初始值。\n- 单选菜单 select 与多选菜单 multiselect:支持选项 hint、required 和初始选中值。\n- 确认对话框 confirm:可自定义 active/inactive 文案与默认值。\n- 进度条 progress:支持 block 样式、最大值、尺寸、advance 与消息更新。\n- 加载指示器 spinner:支持启动、状态消息与停止。\n- 任务日志 taskLog:可承接子进程流式输出,成功时清除、失败时保留日志。\n- 流式输出 stream.step:可从异步迭代器逐步输出内容,资料示例用于 LLM 式逐词输出。\n- 分组提示 p.group:按顺序执行多个提示并共享结果状态,支持 onCancel。\n- 任务执行 p.tasks:自动管理多个任务的 spinner 与消息。\n- 日志 log:提供 info、step、success、warn、error 和自定义 symbol 消息。\n- 会话框架 intro、outro、note:用于 CLI 开场、结尾和下一步提示。\n- 自定义按键 updateSettings:示例将 WASD 映射为方向导航。\n- 非交互模式:资料称在 CI 环境提示会自动使用默认值,并提供 block() 用于非 TTY 环境阻止输入。\n- 取消与错误处理:通过 isCancel、cancel 和 try/catch 处理用户取消与校验错误。\n- 高级定制:基于 @clack/core 的 TextPrompt 自定义 render 函数,以及订阅 value、submit、cancel 事件。\n\n使用方式:先执行 npm install @clack/prompts 安装依赖,再从 @clack/prompts 导入 text、select、confirm、group 等函数,以 await 方式获取用户输入;资料还展示了结合 picocolors、node:child_process 和 node:timers/promises 的完整示例。更详细的 API 参考指向 references/clack-api.md,涵盖各提示类型的配置项、校验与错误处理、流式与异步模式、自定义按键、@clack/core 集成和 TypeScript 支持等。\n\n适用场景:项目初始化向导、依赖安装与构建流程中的交互确认、需要实时展示子进程输出的 CLI、以及需要分组收集配置的交互式工具。\n\n限制与缺失信息:资料未说明 Clack 的收费模式、价格、支持的 Node.js 版本范围、浏览器或平台兼容性、性能指标及许可证信息,这些内容暂未提供;指南本身是用法说明,不承诺具体效果。