@geoql/doctor-core

中文文档
1.9.0发布于 2026/11/04MITTypeScriptES Module构建来源已验证近 30 天下载 7906

@geoql/vue-doctor和@geoql/nuxt-doctor的审计引擎. 混合双通: @vue/compiller-sfc模板 AST + oxlint 子进程. TypeScript, 无害环境管理.

中文使用文档
文档目录7 节
  1. 它会做什么
  2. 安装
  3. API 密码
  4. 主要出口
  5. 范围
  6. 建筑
  7. 许可证

@geoql/doctor-core

背后的审计引擎 @geoql/vue-doctor 财务报告和审定财务报表 @geoql/nuxt-doctor。 。 。 .

这是图书馆的工作。 两个CLI很薄 cac 包装;一切真实生活在这里:混合扫描,评分,记者,配置加载,以及项目检测. 您通常依赖CLI,而不是直接依赖此软件包. 到达 doctor-core 只有在你把审计嵌入你自己的工具时.

它会做什么

doctor-core 运行 a 混合双通扫描 超过 Vue 3 或 Nuxt 4 项目, 锁定在 docs/SPEC.md 第10节:

  • 传出 1 — 模板 AST. 参数 .vue 带有 @vue/compiler-sfc ,并在程序中行走模板 AST。 这是唯一能看见模板的通路,所以模板形状的规则(v-for 缺少 :key, (中文(简体) ), v-if编号 :v-for 在同一节点上,列表中的内置对象道具)在这里活.
  • 传出 2 — 脚本 ESTree. 双胞胎 oxlint 作为针对生成的子进程 .oxlintrc.json 打开牛林的本土 vue 插件加医生 JS 插件(@geoql/oxlint-plugin-vue-doctor, (中文(简体) ), @geoql/oxlint-plugin-nuxt-doctor. 牛林只手插 JS 所取出 <script>,所以所有脚本级别的规则都在这里运行.

两个通行证的诊断结果合并并解开 (file, line, column, ruleId),然后崩溃成决定性的0-100分. 定重权重(error =5个, warn =2个, info = 0.5) 对累犯进行减分,所以一个吵闹的规则不能把整个分数压入. 同一码入,同分出:无随机分出,无相通相克分出.

它也拥有 CLI 表面的棋子: 配置加载器( :doctor.config.ts 通过 c12),用于闸门规则,规则登记册,以及每个记者格式的项目/能力检测.

安装

npm i @geoql/doctor-core

发表于 无 财务报告和审定财务报表 日 尔 与出处。 仅限无害环境管理. knip 财务报告和审定财务报表 oxlint 是同伴的依赖关系(死码和脚本向它们传递 shell).

API 密码

主要条目是 audit()。它返回载有诊断、数值分数、分数分数、检测到的项目信息以及进程退出代码的报告.

import { audit, format } from '@geoql/doctor-core';

const report = await audit({
  rootDir: process.cwd(),
  include: ['**/*.vue', '**/*.ts'],
  exclude: ['node_modules', 'dist', '.nuxt', '.output'],
  failOn: 'error',
});

for (const d of report.diagnostics) {
  console.log(
    `${d.file}:${d.line}:${d.column} ${d.severity} ${d.ruleId}: ${d.message}`,
  );
}

console.log(`Score: ${report.score}/100`);
console.log(`Exit code: ${report.exitCode}`);

// Render any reporter format. `format()` takes a ReporterInput,
// which you assemble from the report.
process.stdout.write(
  format(
    {
      toolName: '@geoql/vue-doctor',
      toolVersion: '0.1.0',
      rootDirectory: report.rootDir,
      analyzedFileCount: report.filesScanned,
      elapsedMs: report.elapsedMs,
      diagnostics: report.diagnostics,
      score: report.scoreResult,
      projectInfo: report.projectInfo,
    },
    'agent',
  ),
);

严重性是 error | warn | info 整个. failOn 接受 error | warn | none。 。 。 .

主要出口

导出目的
audit进行"双通"扫描,并返回完整报告.
format将报告作为 agent, (中文(简体) ), pretty, (中文(简体) ), json, (中文(简体) ), json-compact, (中文(简体) ), sarif,或 html。 。 。 .
loadDoctorConfig, (中文(简体) ), defineConfig, (中文(简体) ), mergeCliOverrides装入 doctor.config.ts (通过) c12)和上层 CLI 覆盖.
detectProject检测门规则所用的框架、版本和能力标志.
listRules, (中文(简体) ), RULE_REGISTRY, (中文(简体) ), loadRuleDoc检查规则登记处和规则文件.
scoreDiagnostics与分解决定分出0-100分.
listChangedFiles为渐进运行解析 diff/ stated 文件范围 .
encodeAnnotations释放 GitHub 动作 ::error:: 编号 : ::warning:: 线条.

船舶类型AuditConfig, (中文(简体) ), AuditReport, (中文(简体) ), Diagnostic, (中文(简体) ), Severity, (中文(简体) ), ReporterFormat, (中文(简体) ), ProjectInfo, (中文(简体) ), ScoreResult(还有更多).

范围

Vue 3和Nuxt 4仅限. Nuxt 检测预期 app/ 目录布局 compatibilityVersion: 4。 。 。 .

建筑

见 docs/SPEC.md §10 对于完整的 二通道设计, 经验性的牛林发现 塑造它,和犬科 Diagnostic 形状.

许可证

麻省理工学院

版本与发布记录

@geoql/doctor-core 共发布 25 个版本,首次发布于 2026/05/29;过去 12 个月发布了 25 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.9.0latest2026/11/0412 天前
1.8.42026/11/0412 天前
1.8.32026/10/2818 天前
1.8.22026/09/122 个月前
1.8.12026/07/283 个月前
1.8.02026/07/273 个月前

其他发布通道:alpha → 0.2.0-alpha.0。

关于 @geoql/doctor-core 的常见问题

@geoql/doctor-core 是什么?

@geoql/vue-doctor和@geoql/nuxt-doctor的审计引擎. 混合双通: @vue/compiller-sfc模板 AST + oxlint 子进程. TypeScript, 无害环境管理.

如何安装 @geoql/doctor-core?

在项目目录运行 npm install @geoql/doctor-core,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:knip(^6.14.2)、oxlint(^1.66.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@geoql/doctor-core 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@geoql/doctor-core 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@geoql/doctor-core 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@geoql/doctor-core 可以商用吗?

@geoql/doctor-core 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@geoql/doctor-core 的下载量有多少?

根据 npm 官方下载统计,@geoql/doctor-core 在 2026/10/16 – 2026/11/14 这 30 天内被下载 7,906 次,日均约 264 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@geoql/doctor-core 还在维护吗?

最新版本 1.9.0 发布于 2026/11/04(12 天前);至今共发布 25 个版本,其中过去 12 个月发布了 25 个;首次发布于 2026/05/29。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。