介绍
node-source-walk 是一个 npm 包，它可以用来遍历 JavaScript 代码中的 AST（抽象语法树），并提供了一些方便的 API 让开发者能够在遍历过程中进行一些操作。这个包通常被用于编写静态代码分析工具或自动化重构工具。
安装
你可以通过 npm 命令安装 node-source-walk：
$ npm install node-source-walk
使用方法
使用 node-source-walk 的主要步骤如下：
- 解析 JavaScript 代码生成 AST；
- 创建一个遍历器；
- 注册回调函数，对每一个节点进行操作；
- 开始遍历。
下面对这些步骤进行详细说明。
解析 JavaScript 代码生成 AST
node-source-walk 并没有自己的解析器，因此需要使用第三方解析器将 JavaScript 代码转换成 AST。常用的解析器有 esprima、babel-parser 等。下面以 esprima 为例演示如何生成 AST。
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ---- - - -------- ------ -- - ------ - - -- - -- ----- --- - --------------------------
上面的代码使用 esprima 解析器生成了一个简单的 AST，该 AST 表示了一个将两个参数相加并返回结果的函数。
创建遍历器
在 node-source-walk 中，遍历器是用来遍历 AST 的。下面展示如何创建一个遍历器：
const NodeSourceWalk = require('node-source-walk');
const walker = NodeSourceWalk.make({
// 选项
});make 函数接受一个对象作为选项，常用选项如下：
includeSourceLocations：是否要在节点上包含源代码位置信息；followAllChildProperties：是否要深度遍历所有属性。
注册回调函数
node-source-walk 的核心是遍历 AST 并调用注册的回调函数。回调函数可以对每个节点进行操作或者修改。下面演示如何注册回调函数：
walker.walk(ast, {
enter: (node, parent, prop, index) => {
// 进入节点时的回调函数
},
leave: (node, parent, prop, index) => {
// 离开节点时的回调函数
}
});enter 回调函数会在进入一个节点时被调用，leave 回调函数会在离开一个节点时被调用。这两个函数接收四个参数：
node：当前节点；parent：当前节点的父节点；prop：当前节点在父节点中的属性名；index：当前节点在父节点中的索引。
开始遍历
最后一步是开始遍历 AST，下面展示如何启动遍历：
walker.walk(ast, {
enter: (node, parent, prop, index) => {
// 进入节点时的回调函数
},
leave: (node, parent, prop, index) => {
// 离开节点时的回调函数
}
});该代码会遍历 ast 并调用注册的回调函数来操作每个节点。
示例代码
下面是一个使用 node-source-walk 实现的简单的静态代码分析器，它可以统计 JavaScript 代码中的函数数量和变量数量：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- -------------- - ---------------------------- ----- ---- - - -------- ------ -- - --- - - - - -- ------ -- - -------- ----- - --- - - -- --- - - -- ------ ------ - ----------------------------------------------------------- -------- ----------------------------------------------------------------------------------