SuperAPI AI 工具集

unjs-citty

通用与其它

查看项目

更新于 10-16 05:51

技能介绍

citty 是 unjs 维护的命令行工具库,用于定义命令与解析参数。当前版本 0.2.1。

用途与主要能力:通过 defineCommand 定义命令,支持 args、run、setup、cleanup 等钩子,并支持子命令、帮助与版本号输出;提供 runMain 与 runCommand 入口。

使用方式要点:v0.2.0 起仅支持 ESM,require('citty') 不再可用,内部改用 node:util.parseArgs,部分参数解析边界行为可能与 0.1.x 不同;可选参数现在正确推断为 T | undefined。新增 enum 参数类型,需提供 options 字符串数组;新增 meta.hidden 隐藏子命令、negativeDescription 为布尔参数的 --no- 变体设置说明,且 --no- 仅在设置 negativeDescription 时显示。cleanup 钩子在 run 完成后执行(finally 中运行,出错也会执行)。createMain(cmd) 返回可复用的包装函数;设置 meta.version 后自动处理 --version,但仅作为唯一参数时生效。

子命令建议使用箭头函数延迟加载以支持代码分割;参数名会在 camelCase 与 kebab-case 间自动互建别名,无需重复添加。

适用场景:编写 Node.js CLI、需要类型安全的参数定义、需要子命令与帮助输出、按需加载子命令。

限制:仅 ESM;v0.2.0 解析行为存在变化;带子命令的命令应避免使用位置参数,否则与子命令同名的值会被路由到子命令;runMain 出错时会调用 process.exit(1),程序化调用建议使用 runCommand。其余细节资料暂未提供。