@geoql/doctor-rule-core

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

Linter-neutral rule cores shared by @geoql/oxlint-plugin-vue-doctor, @geoql/oxlint-plugin-nuxt-doctor, and the future ESLint plugin. ESTree/JS-AST only.

原始使用文档
文档目录4 节
  1. What lives here
  2. What does NOT live here
  3. Adapter contract
  4. Adding a new rule

@geoql/doctor-rule-core

Linter-neutral rule cores shared by:

  • @geoql/oxlint-plugin-vue-doctor
  • @geoql/oxlint-plugin-nuxt-doctor
  • the future ESLint plugin (parity item #4)

What lives here

Pure detection logic for rules that operate on the ESTree / JavaScript AST:

  • rule metadata (id, category, severity, recommended, meta)
  • the visitor spec returned by create(context)
  • the optional fix(node) => string | null transform
  • shared helpers such as defineRule and the auto-imported symbol sets

What does NOT live here

Template-AST rules (e.g. v-for-has-key) operate on the @vue/compiler-sfc template AST, which has a completely different node shape and traversal model. They remain in @geoql/doctor-core alongside the hybrid engine that runs them.

Adapter contract

A linter adapter should consume each CoreRule and wire it into its own linter API. The core shape is intentionally identical to the ESLint / oxlint JS-plugin contract:

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;
}

For oxlint, the adapter is a thin identity wrapper because the shape already matches oxlint's Rule. For ESLint, the adapter will map the same create visitor object into ESLint's context.report() API.

Adding a new rule

  1. Add the rule file under src/rules/vue/ or src/rules/nuxt/.
  2. Export it from the matching src/rules/vue/index.ts or src/rules/nuxt/index.ts.
  3. Add the rule to RULE_REGISTRY in @geoql/doctor-core.
  4. Add the rule id to the matching allowlist in @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 是什么?

Linter-neutral rule cores shared by @geoql/oxlint-plugin-vue-doctor, @geoql/oxlint-plugin-nuxt-doctor, and the future ESLint plugin. ESTree/JS-AST only.

如何安装 @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 和提交记录判断。