Versions

创建自定义解析器

如果你想使用自己的解析器以便为自己的规则提供额外的功能,你可以指定使用自定义解析器。这就可以使用解析器暴露的 parseForESLint 方法来解析代码,或者也可以使用 parse 方法。这两个方法都应该将源码作为第一个参数,并将可选的配置对象作为第二个参数(在配置文件中作为 parserOptions 提供)。parse 方法应该简单地返回 AST。parseForESLint 方法应该返回包含必需属性 ast 和可选属性 servicesscopeManagervisitorKeys 的对象。

  • ast 应该包含 AST。
  • services 可以包含任何依赖于解析器的服务(例如节点的类型检查器)。services 属性的值可以作为 context.parserServices 传递给规则。默认为空对象。
  • scopeManager 可以是 ScopeManager 对象。自定义解析器可以为实验性/增强性语法提供自定义范围分析。默认使用 eslint-scope 创建的ScopeManager 对象。
    • 在 ESLint v4.14.0 中加入了对 scopeManager 的支持。支持 scopeManager 的 ESLint 版本将在parserOptions 中提供 eslintScopeManager: true 属性,可用于特征检测。
  • visitorKeys 可以是自定义 AST 遍历的对象。该对象的键是 AST 节点的类型。每个值是一个应该被遍历的属性名称的数组。默认为 eslint-visitor-keys 的键
    • 在 ESLint v4.14.0 中加入了对 visitorKeys 的支持。支持 visitorKeys 的 ESLint 版本将在 parserOptions 中提供 eslintVisitorKeys: true 属性,它可以用作特征检测。

你可以在这找到 ESLint 解析器项目。

{
"parser": "./path/to/awesome-custom-parser.js"
}
var espree = require("espree");
// awesome-custom-parser.js
exports.parseForESLint = function(code, options) {
return {
ast: espree.parse(code, options),
services: {
foo: function() {
console.log("foo");
}
},
scopeManager: null,
visitorKeys: null
};
};

AST 规范

自定义解析器创建的 AST 需要基于 ESTree。AST 还需要包括一些关于源码细节信息的额外属性。

所有节点

所有节点必须要有 range 属性。

  • rangenumber[])是一个由两个数字组成的数组。这两个数字都是基于 0 的索引,是源代码字符数组中的位置。第一个是节点的起始位置,第二个是节点的结束位置。code.slice(node.range[0], node.range[1]) 必须是该节点的文本。这个范围不包括节点周围的空格/括号。
  • loc (SourceLocation) 不能是 nullESTreeloc 属性定义为 nullable,但 ESLint 需要这个属性。另一方面 SourceLocation#source 属性也可以是 undefined。ESLint 不使用 SourceLocation#source 属性。

所有节点的 parent 属性必须可覆写。ESLint 在遍历时会在任何规则访问 AST 前,将每个节点的 parent 属性设置为其父节点。

Program 节点

Program 节点必须要有 tokenscomments 属性。这两个属性都是 Token 接口下的一个数组:

interface Token {
type: string;
loc: SourceLocation;
range: [number, number]; // 参见“所有节点”部分,了解“范围”属性的细节。
value: string;
}
  • tokensToken[])是影响程序行为的令牌阵列。令牌之间可能存在任意的空间,所以规则会检查 Token#range 以检测令牌之间的空间。这必须按 Token#range[0] 进行排序。
  • commentsToken[])是评论标记的阵列。这必须按 Token#range[0] 排序。

所有标记和评论的范围索引必须不与其他标记和评论的范围重叠。

Literal 节点

Literal 节点必须要有 raw 属性。

  • rawstring)是这个字面的源代码。这与 code.slice(node.range[0], node.range[1]) 相同。