# @buxlabs/ast 中文文档

规范地址：https://npmcn.com/package/%40buxlabs/ast/

版本：0\.11\.0
npm 元数据更新时间：2022-06-12T15:34:36.110Z
中文译文更新时间：2026-11-08T20:42:42.117Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40buxlabs/ast
原文对照：https://npmcn.com/package/%40buxlabs/ast/?lang=original
项目主页：https://github.com/buxlabs/ast#readme
源码仓库：https://github.com/buxlabs/ast

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

- 包体积（解压后）：13.1 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=8\.11\.1
- 运行依赖：9 个
- 首次发布：2016-12-19T22:09:20.695Z
- 最新版本发布：2018-05-13T20:49:50.242Z
- 近 30 天下载量：2758（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 0 个）

## 中文简介

js 的抽象语法树类

## 安装

```sh
npm install @buxlabs/ast
```

也可以使用：`pnpm add @buxlabs/ast`、`yarn add @buxlabs/ast`、`bun add @buxlabs/ast`

## README

# 抽象语法Tree

[![Build Status](https://travis-ci.org/buxlabs/ast.svg?branch=master)](https://travis-ci.org/buxlabs/ast) [![NSP Status](https://nodesecurity.io/orgs/buxlabs/projects/4b0bfe3e-43d0-4597-b407-dd44cec2f3d6/badge)](https://nodesecurity.io/orgs/buxlabs/projects/4b0bfe3e-43d0-4597-b407-dd44cec2f3d6)

如果想要抽象出一些诸如添加,去除,替换节点等的自控操作,你可能会发现该类有用. 测试文件夹是使用实例的好起点. 公关非常受欢迎.

## 安装

`npm install @buxlabs/ast`

## 方法

### 已经

检查是否包含指定类型的节点 .

```javascript
const source = 'const a = "x";'
const ast = new AbstractSyntaxTree(source)
ast.has('VariableDeclaration')
```

### 计数

计算给定类型的星座节点.

```javascript
const source = 'const a = "x"; const b = "y";'
const ast = new AbstractSyntaxTree(source)
ast.count('VariableDeclaration')
```

### 寻找

查找指定类型的所有节点 .

```javascript
const source = 'const a = "x";'
const ast = new AbstractSyntaxTree(source)
ast.find('VariableDeclaration')
```

### 每个

在所有指定类型的节点上标出 .

```javascript
const source = 'const a = "x";'
const ast = new AbstractSyntaxTree(source)
ast.each('VariableDeclaration', node => {})
```

### 第一个

第一个指定类型的节点 .

```javascript
const source = 'var a = "x";'
const ast = new AbstractSyntaxTree(source)
ast.first('VariableDeclaration')
```

### 最后一个

查找指定类型的最后一个节点.

```javascript
const source = 'const a = "x";'
const ast = new AbstractSyntaxTree(source)
ast.last('VariableDeclaration')
```

### 删除

删除符合标准的所有节点 .

```javascript
const source = '"use strict"; const b = 4;'
const ast = new AbstractSyntaxTree(source)
ast.remove({ type: 'Literal', value: 'use strict' })
```

```javascript
const source = 'function hello () { const foo = "bar"; return "world"; }'
const ast = new AbstractSyntaxTree(source)
ast.remove('BlockStatement > VariableDeclaration')
```

### 走开

走遍所有节点

```javascript
const source = 'const a = 1'
const ast = new AbstractSyntaxTree(source)
ast.walk((node, parent) => {})
```

### 转弯

走遍所有节点

```javascript
const source = 'const a = 1'
const ast = new AbstractSyntaxTree(source)
ast.walk({
  enter (node) {},
  leave (node) {}
})
```

### 替换

替换所有符合标准的节点 .

```javascript
const source = 'const a = 1'
const ast = new AbstractSyntaxTree(source)
ast.replace({
  enter (node) {
    if (node.type === 'VariableDeclaration') {
      node.kind = 'let'
    }
    return node
  }
})
```

### 预选

将一个节点放在身体上.

```javascript
const source = 'const a = 1;'
const ast = new AbstractSyntaxTree(source)
ast.prepend({
  type: 'ExpressionStatement',
  expression: {
    type: 'Literal',
    value: 'use strict'
  }
})
```

### 附录

给身体加上一个节点.

```javascript
const source = 'const a = 1;'
const ast = new AbstractSyntaxTree(source)
ast.append({
  type: 'ExpressionStatement',
  expression: {
    type: 'Literal',
    value: 'test'
  }
})
```

### 关闭

用给定的节点包裹身体.

```javascript
const source = 'const a = 1;'
const ast = new AbstractSyntaxTree(source)
ast.wrap(body => {
    return [
      {
        type: 'ExpressionStatement',
        expression: {
          type: 'CallExpression',
          callee: {
            type: 'FunctionExpression',
            params: [],
            body: {
              type: 'BlockStatement',
              body
            }
          },
          arguments: []
        }
      }
    ]
})
```

### 打开

将代码更改为第一个块状体

```javascript
const source = '(function () { console.log(1); }())'
const ast = new AbstractSyntaxTree(source)
ast.unwrap()
ast.toSource()
```

### 模板

从模板创建部分

```javascript
const source = 'console.log(1);'
const ast = new AbstractSyntaxTree(source)
ast.template('const foo = <%= bar %>;' { bar: { type: 'Literal', value: 1 } })
```

### 标记

在所有节点中添加 cid

```javascript
const ast = new AbstractSyntaxTree('const a = 1;')
ast.mark()
assert(ast.first('Program').cid === 1)
assert(ast.first('VariableDeclaration').cid === 2)
```

### 改为来源

将 ast 转换为字符串 .

```javascript
const source = 'const a = 1;'
const ast = new AbstractSyntaxTree(source)
const source = ast.toSource()
```

```javascript
const source = 'const a = 1;'
const ast = new AbstractSyntaxTree(source)
const { source, map } = ast.toSource({ sourceMap: true })
```

### ưμ㼯A

生成一个源地图.

```javascript
const source = 'const a = 1;'
const ast = new AbstractSyntaxTree(source)
const map = ast.toSourceMap()
```

## 常见问题

### @buxlabs/ast 是什么？

js 的抽象语法树类

### 如何安装 @buxlabs/ast？

在项目目录运行 npm install @buxlabs/ast，或使用 pnpm add / yarn add / bun add。

### @buxlabs/ast 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/buxlabs\_\_ast 是否存在。

### @buxlabs/ast 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @buxlabs/ast 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=8\.11\.1。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @buxlabs/ast 可以商用吗？

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

### @buxlabs/ast 的下载量有多少？

根据 npm 官方下载统计，@buxlabs/ast 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,758 次，日均约 92 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @buxlabs/ast 还在维护吗？

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