用途:编写或编辑 codometer 配置文件,声明度量输入、限制、自定义计数器、注释预算、排除项和输出目标。配置文件支持 ts、mts、cts、js、mjs、cjs、json、jsonc,从被度量目录向上查找,取最近的一个,不与上层合并。format 为必填字段,其余可选。
主要能力:exclude 与 excludeFrom 用于排除保留但非手写的文件(锁文件、打包产物、生成文档),.gitignore 已自动生效。inputs 声明按 glob 匹配的命名文件集,含 name、include、analyses 等字段,include 中 ! 前缀用于移除文件。limits 为指标设上限,severity 可为 fail 或 warn,字符串值单位必须带 b(如 "8 KB")。custom 数组声明自定义计数器,可用 patterns、symbols 或 comment 三种方式之一选择计数对象。comment 可设 language、kind、maximumCharacters、maximumLines、maximumWords 等,按注释块而非整文件度量。outputs 声明输出目标,每种类型最多一个,支持 json 与 markdown,markdown 可用 write 函数自定义渲染。
使用方式:在配置文件中导入 CodometerConfiguration 类型并导出默认对象。输出路径相对于进程工作目录解析。多项目仓库可为每个项目各建一份配置并共享对象。
限制:配置文件始终按普通对象读取,不支持函数式配置。命名 codebase 的输入会替换内置全树扫描。指标路径歧义或不存在会被拒绝。部分语言用行扫描器,字符串内的注释标记可能被误读;Python 注释需要可运行的解释器。注释选择器无继承机制。资料未提供安装命令与具体运行方式。