# estree-walker 中文文档

规范地址：https://npmcn.com/package/estree-walker/

版本：3\.0\.3
npm 元数据更新时间：2023-07-09T22:05:07.091Z
中文译文更新时间：2026-11-04T13:57:34.905Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/estree-walker
原文对照：https://npmcn.com/package/estree-walker/?lang=original
项目主页：https://github.com/Rich-Harris/estree-walker#readme
源码仓库：https://github.com/Rich-Harris/estree-walker

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：17.6 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2015-04-09T12:57:41.638Z
- 最新版本发布：2023-01-20T02:27:12.467Z
- 近 30 天下载量：849894364（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：27（近 12 个月 0 个）

## 中文简介

遍历一个符合estree的AST

## 安装

```sh
npm install estree-walker
```

也可以使用：`pnpm add estree-walker`、`yarn add estree-walker`、`bun add estree-walker`

## README

# estree-walker

简单实用的步行和 [ESTree](https://github.com/estree/estree)\-兼容的AST，例如由 [橡子](https://github.com/marijnh/acorn)。

## 安装

```bash
npm i estree-walker
```

## 用法

```js
var walk = require('estree-walker').walk;
var acorn = require('acorn');

ast = acorn.parse(sourceCode, options); // https://github.com/acornjs/acorn

walk(ast, {
  enter(node, parent, prop, index) {
    // some code happens
  },
  leave(node, parent, prop, index) {
    // some code happens
  }
});
```

在 `enter` 函数,调用 `this.skip()` 会阻止节点的子节点被遍历，或者 `leave` 函数（可选）被调用。

呼叫 `this.replace(new_node)` 在任何 `enter` 或 `leave` 用新节点替换当前节点。

呼叫 `this.remove()` 在任何 `enter` 或 `leave` 删除当前节点。

## 为什么不使用estraverse？

ESTree规范正在发展以适应ES6/7。我有过几次经历 [estraverse](https://github.com/estools/estraverse) 无法处理由最新版本的acorn生成的AST，因为它硬编码访问者密钥。

相比之下，Estree-walker只是枚举节点的属性来查找子节点（和节点的子列表），因此不受规范更改的影响。它也小得多。（如果你想知道，它们的表现基本上是一样的。）

这些都不应该被认为是对estraverse的批评，它有更多的功能，并且在更多的情况下经过了战斗测试，对此我非常感激。

## 许可证

麻省理工学院

## 常见问题

### estree-walker 是什么？

遍历一个符合estree的AST

### 如何安装 estree-walker？

在项目目录运行 npm install estree-walker，或使用 pnpm add / yarn add / bun add。

### estree-walker 支持 TypeScript 吗？

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

### estree-walker 支持 ESM 还是 CommonJS？

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

### estree-walker 可以商用吗？

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

### estree-walker 的下载量有多少？

根据 npm 官方下载统计，estree-walker 在 2026/10/05 – 2026/11/03 这 30 天内被下载 849,894,364 次，日均约 28,329,812 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### estree-walker 还在维护吗？

最新版本 3\.0\.3 发布于 2023/01/20（3 年前）；至今共发布 27 个版本，其中过去 12 个月发布了 0 个；首次发布于 2015/04/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。