安装
npx skills add vercel-labs/konsistent --skill konsistent-config适合谁
适合 TypeScript 仓库已经有(或准备写下)项目级结构约定,并希望用 CLI 检查文件和目录是否符合这些模式的人。官方仓库是 https://github.com/vercel-labs/konsistent ,说明它检查 files and directories 是否 match declared structural patterns,补上 ESLint、Biome、oxlint 只覆盖文件内风格、不验证项目级结构的缺口。例子包括 every provider package must export the same shape,或 every adapter must extend the base class。它不是又一个代码风格器。
更适合先写 konsistent.json、再 validate / check 的人。若仓库还没有结构约定,不要把第一次尝试理解成自动改完所有文件。材料没有写必须使用哪一个代理产品。
3 分钟完成第一次尝试
技能主路径先装配置技能:
npx skills add vercel-labs/konsistent --skill konsistent-config
前置条件:当前环境能执行 npx,并且你准备在 TypeScript 仓库里写入或检查 konsistent.json。材料没有写 Node 版本。先确认目录允许写入配置,再执行;副作用是装上 konsistent-config 技能。装完后先让技能帮你核对或起草配置,不要直接批量改业务代码。
低风险任务:在已能使用该技能的代理里,只生成或检查 konsistent.json,然后运行官方校验:
konsistent validate
成功信号是配置文件通过 Validate the konsistent.json configuration file,而不是已经改掉一堆源码。若还没有 CLI,材料给出的开发依赖安装示例是 npm install konsistent --save-dev;先确认这是你允许写入的仓库再执行。不要在这一步跑修复技能。
若界面索要材料未出现的密钥,或要把所有包管理器安装命令一起跑,立刻停。
使用案例
案例一:声明并校验结构约定。对应 konsistent-config 技能与 konsistent validate。适合还没有稳定 konsistent.json、只想先把模式写对的人。材料没有写配置字段清单;能确认的是先有配置,再用 validate。不要把案例一写成已经全仓库通过。
案例二:按约定检查或逐条看违规。对应 konsistent / konsistent check(Check structural conventions),以及第二条技能 npx skills add vercel-labs/konsistent --skill konsistent-fix-violations。适合配置已通过校验、只想看哪些文件不合模式的人。check 相对可逆;fix-violations 会 walks violations,有改文件风险,执行前先确认当前分支允许修改。材料没有写自动修复一定安全。
使用边界
它不替代 ESLint、Biome 或 oxlint 的文件内规则,只补项目级结构。材料同时给出 NPM、PNPM、Bun 三种开发依赖装法,第一次尝试只选你正在用的一种,不要当三条都要执行。konsistent 是 konsistent check 的缩写,两者都需要可用的 konsistent.json。没有出现发布、格式化或非 TypeScript 仓库的承诺。没有出现的安装方式一律不要补。