SuperAPI AI 工具集

migrate-to-spec

通用与其它

查看项目

更新于 10-15 22:34

技能介绍

用途:把仓库中已有的手写 CLAUDE.md(或 AGENTS.md)转换为 vigiles 类型化的 CLAUDE.md.spec.ts,属于渐进式采用路径,保留原指令文件作为起点,后续获得类型安全。适合需要编译器级保证的用户;若只需验证规则而不想引入构建步骤,可先用 markdown 模式(内联 <!-- vigiles:enforce ... --> 注释或 vigiles: YAML frontmatter 配合 vigiles generate-schema),由 vigiles lint 用同一引擎验证。

主要能力:读取目标指令文件,解析其中 Commands、Key files、Rules 与散文段落;将带有 Enforced by linter/rule 的规则转为 enforce(),非 linter 的审阅类转为 guidance(),仅有 Guidance only 的转为 guidance(),无标注的标记 TODO;使用 file()、cmd()、ref()、instructions() 等引用以便检测失效引用;保留 Why 文本作为第二参数;规则 ID 采用标题的 kebab-case。

使用方式:先确认是否安装 vigiles(查看 package.json devDependencies),未安装可执行 npm install -D vigiles;生成 CLAUDE.md.spec.ts 后运行 npm run build 与 npx vigiles compile CLAUDE.md.spec.ts,比对输出与原文;并可用 npx vigiles check 验证。可选 CI 配置:在 GitHub Actions 中运行 npx vigiles compile 与 npx vigiles check,或使用 zernie/vigiles@main 并设 command: check。

适用场景:把已有 markdown 指令文件升级为类型化规范,或对规则做机械化强制与跨文件引用校验。限制:迁移是承诺最深的一级,需要构建步骤;code review 类规则只能作为 guidance;无标注规则需用户自行分类;官方未提供更多平台或收费信息。