@geoql/doctor-rule-core

中文文档
1.5.0发布于 2026/11/04MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 8001

由 @geoql/oxlint-plugin-vue-doctor,@geoql/oxlint-plugin-nuxt-doctor共享的中性规则核心,以及未来的ESLint插件. ESTREE/JS-AST 仅限.

中文使用文档
文档目录4 节
  1. 住在这里的东西
  2. 什么不在这里住
  3. 适应合同
  4. 添加新规则

@geoql/博士-规则-核心

相互中立的规则核心由:

  • @geoql/oxlint-plugin-vue-doctor
  • @geoql/oxlint-plugin-nuxt-doctor
  • 未来的 ESLint 插件( 均等项目 # 4)

住在这里的东西

操作于该平台的规则的纯检测逻辑 ESTree / Java脚本 AST数字 :

  • 规则元数据( e)id, (中文(简体) ), category, (中文(简体) ), severity, (中文(简体) ), recommended, (中文(简体) ), meta(中文(简体) )
  • 返回的访客谱 create(context)
  • 选项 fix(node) => string | null 转换
  • 共享帮助, 如 defineRule 和自动输入的符号集

什么不在这里住

Template-AST规则(如:. v-for-has-key(b) 运行于 @vue/compiler-sfc 模板AST,它具有完全不同的节点外形和倒转模型. 他们还在 @geoql/doctor-core 与运行它们的混合发动机相伴而行.

适应合同

一个接通器应该消耗每个 CoreRule 把它接入自己的体内 (原始内容存档于2018-10-21). linter API. 核心外形与ESLint/克林特故意完全相同 JS-plugin合同:

export interface CoreRule {
  readonly id: string;
  readonly category: RuleCategory;
  readonly severity: 'error' | 'warn' | 'info';
  readonly recommended: boolean;
  readonly meta?: RuleMeta;
  readonly create: (context: RuleContext) => Record<string, RuleVisitor>;
  readonly fix?: (node: AstNode) => string | null;
}

对克林特来说,适配器是一个薄的特性包装器,因为形状已经 匹配克林特语 Rule对于 ESLint ,适配器将绘制相同的地图 create 访问者对象进入 ESLint context.report() API (英语).

添加新规则

  1. 添加规则文件 src/rules/vue/ 或者说 src/rules/nuxt/。 。 。 .
  2. 从匹配中导出 src/rules/vue/index.ts 或者说 src/rules/nuxt/index.ts。 。 。 .
  3. 将规则添加到 RULE_REGISTRY 内 @geoql/doctor-core。 。 。 .
  4. 在匹配的允许列表中添加规则 ID @geoql/doctor-core/src/oxlint/generate-config.ts。 。 。 .

版本与发布记录

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

版本发布日期距今
1.5.0latest2026/11/0412 天前
1.4.32026/11/0412 天前
1.4.22026/10/2818 天前
1.4.12026/09/122 个月前
1.4.02026/07/164 个月前
1.3.02026/07/134 个月前

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

@geoql/doctor-rule-core 是什么?

由 @geoql/oxlint-plugin-vue-doctor,@geoql/oxlint-plugin-nuxt-doctor共享的中性规则核心,以及未来的ESLint插件. ESTREE/JS-AST 仅限.

如何安装 @geoql/doctor-rule-core?

在项目目录运行 npm install @geoql/doctor-rule-core,或使用 pnpm add / yarn add / bun add。

@geoql/doctor-rule-core 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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

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

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