用途:为 TypeScript 项目创建或修改根目录下的 konsistent.json,用 konsistent CLI 强制结构性约定(文件系统结构、导出/导入关系),不是代码风格 linter。
主要能力:基于代码库中的主导模式推断约定;支持 haveType、haveFiles、export、exportTypes、import 等谓词;支持路径 glob、占位符与大小写转换;支持 if/for/excludeFiles 条件规则与严重级别。
使用方式:若未安装,先安装并添加脚本,例如 pnpm add konsistent --save-dev,并在 package.json 加入 "konsistent": "konsistent"。读取 node_modules/konsistent/konsistent.schema.json 与 docs/ 下文档后编写配置。用 pnpm konsistent validate 校验配置,再用无参数 pnpm konsistent 审计代码库。
约定推断要求:先收集证据表,记录候选约定、相关群体、符合数、违规数、竞争模式与决策;默认主导需至少出现 3 次且占相关群体至少三分之二。遇到模糊竞争模式应询问用户。不要为让所有文件通过、减少违规数或退出码 0 而弱化约定;违规即审计结果。修改既有配置时应保留无关约定及原有 name、description、severity。
适用场景:需要以结构约定约束多包、适配器、路由、barrel 文件等 TypeScript 代码库。
限制:仅覆盖结构与导入/导出,不检查代码风格;必须完成后才能可靠推断约定;资料未提供具体版本、定价或平台信息。