@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 (英语).
添加新规则
- 添加规则文件
src/rules/vue/或者说src/rules/nuxt/。 。 。 . - 从匹配中导出
src/rules/vue/index.ts或者说src/rules/nuxt/index.ts。 。 。 . - 将规则添加到
RULE_REGISTRY内@geoql/doctor-core。 。 。 . - 在匹配的允许列表中添加规则 ID
@geoql/doctor-core/src/oxlint/generate-config.ts。 。 。 .