用途:新增或修改 conformetry 生成器,并编写其渲染的模板。生成器把名称与模板(一个普通文件夹)及渲染所需输入配对;配置声明生成器,模板文件夹即产出物的完整定义,同时也是实例被度量的标准。
配置:配置文件默认导出一个数组,每项一个生成器。必填字段为 name(调用名)与 templatePath(相对工作区根目录的模板文件夹);可选 inputs、instances、description、threshold。未知键会被拒绝,拼错字段会导致加载失败。可用 conformetry templates 列出生成器确认生效。配置拒绝四类冲突:重名、同一 templatePath、名称含路径分隔符或为空、名称为 all。
实例分组:instances 是分组列表,每组可含 patterns、exclude、tags、substitutions、threshold。exclude 列出永不作为实例的工作区相对 glob。在 Nx 插件下,带 tags 的组是项目选择器,无 tags 的组是普通工作区 glob。
输入:每个输入是 JSON Schema 片段,仅 description、enum、minLength/maxLength、pattern 生效。Nx 插件将所有声明输入视为必填,命令行宿主则都不必填。project、module、type、directory 在 Nx 插件下有额外含义;config、help、instancePath、template 为保留名。
模板:文件夹即定义。渲染使用 mustache 且关闭 HTML 转义,写 {{field}}。始终提供 nameCamelCase、nameKebabCase、namePascalCase、nameSnakeCase 四种变体。生成时缺失占位符会抛 MissingSubstitutionError;校验时会尝试从实例推断,推断失败则报错。name 及其变体从不推断。没有条件文件机制,树中每个文件都会被渲染写出。含 TODO 的注释视为自由占位符。
阈值:合规按分数计算,阈值取最窄优先:实例组、生成器、运行级 --threshold,最后为 1。除非迁移,否则不要设置。
修改配置后:Nx 生成器命名空间由配置生成,过期时所有 conformetry 命令拒绝运行,需执行 nx sync。
检查:生成实例后校验其合规性,新生成实例按构造即合规,出现差异说明模板与配置不一致。
限制:资料未提供收费、价格、平台与效果信息。