用途:为使用 Ink 和 Clack 构建 TypeScript 终端用户界面(TUI)的开发者提供开发体验(DevEx)最佳实践,覆盖构建交互式 CLI 工具、React 风格终端界面、键盘输入处理、终端渲染优化与防闪烁,以及开发者友好的 CLI 体验设计,并可用于指导自动化重构与代码生成。\n\n主要能力:按影响力分 8 类共 42 条规则,前缀标识如下——渲染与输出(CRITICAL,render-)、输入与键盘(CRITICAL,input-)、组件模式(HIGH,tuicomp-)、状态与生命周期(HIGH,tuistate-)、提示设计(MEDIUM-HIGH,prompt-)、体验与反馈(MEDIUM,ux-)、配置与 CLI(MEDIUM,tuicfg-)、健壮性与兼容性(LOW-MEDIUM,robust-)。示例规则包括单次批量写入终端输出、覆盖而非清屏重绘、动画使用同步输出协议、以 60fps 为基线、仅更新变化区域、延迟生成 ANSI 转义码;使用 useInput 钩子、即时视觉反馈、正确处理修饰键、isActive 焦点管理、始终提供退出路径;Box 与 Flexbox 布局、Text 组件、measureElement 动态尺寸、Static 组件输出日志、百分比宽度响应式布局、边框样式;useApp 生命周期、卸载清理副作用、函数式状态更新、useCallback 与 useMemo;Clack group() 多步提示、输入校验、isCancel 优雅取消、Spinner 与任务、基于 @clack/core 的自定义提示;一秒以上操作显示进度、颜色语义化、可操作错误信息、完成后的后续步骤提示、intro/outro 会话框定;合理默认值、环境变量、优先使用标志而非位置参数、完整帮助系统、机器可读输出;TTY 检测、信号处理、有意义的退出码、退出时恢复终端状态、受限终端下优雅降级。\n\n使用方式:可按单个参考文件查阅详细说明与代码示例,资料给出的入口包括章节定义、规则模板、示例规则 render-single-write 与 input-useinput-hook;完整展开版见 AGENTS.md。具体安装命令、依赖版本、许可证与价格暂未提供。\n\n限制:资料未说明支持的操作系统、终端种类与最低版本、规则可否裁剪或自定义、维护与更新频率,也未提供收费、平台或效果数据,均以实际项目与官方文档为准。
terminal-ui
编程与开发
更新于 10-16 06:14