esrecurse

中文文档
4.3.0发布于 2020/09/01BSD-2-ClauseCommonJS近 30 天下载 6.5亿

ECMAScript AST递归访问者

中文使用文档
文档目录3 节
  1. Esrecurse
  2. 示例使用
  3. 许可证

Esrecurse Build Status

Esrecurse (esrecurse)是 ECMAScript 递归遍历功能。

示例使用

下面的代码将输出在文件根目录下声明的所有变量。

esrecurse.visit(ast, {
    XXXStatement: function (node) {
        this.visit(node.left);
        // do something...
        this.visit(node.right);
    }
});

我们可以用 Visitor 实例。

var visitor = new esrecurse.Visitor({
    XXXStatement: function (node) {
        this.visit(node.left);
        // do something...
        this.visit(node.right);
    }
});

visitor.visit(ast);

我们可以继承 Visitor 实例。

class Derived extends esrecurse.Visitor {
    constructor()
    {
        super(null);
    }

    XXXStatement(node) {
    }
}
function DerivedVisitor() {
    esrecurse.Visitor.call(/* this for constructor */  this  /* visitor object automatically becomes this. */);
}
util.inherits(DerivedVisitor, esrecurse.Visitor);
DerivedVisitor.prototype.XXXStatement = function (node) {
    this.visit(node.left);
    // do something...
    this.visit(node.right);
};

您可以在自定义访问操作中调用默认访问操作。

function DerivedVisitor() {
    esrecurse.Visitor.call(/* this for constructor */  this  /* visitor object automatically becomes this. */);
}
util.inherits(DerivedVisitor, esrecurse.Visitor);
DerivedVisitor.prototype.XXXStatement = function (node) {
    // do something...
    this.visitChildren(node);
};

这个 childVisitorKeys 选项不自定义的行为 this.visitChildren(node)。 我们可以使用用户定义的节点类型。

// This tree contains a user-defined `TestExpression` node.
var tree = {
    type: 'TestExpression',

    // This 'argument' is the property containing the other **node**.
    argument: {
        type: 'Literal',
        value: 20
    },

    // This 'extended' is the property not containing the other **node**.
    extended: true
};
esrecurse.visit(
    ast,
    {
        Literal: function (node) {
            // do something...
        }
    },
    {
        // Extending the existing traversing rules.
        childVisitorKeys: {
            // TargetNodeName: [ 'keys', 'containing', 'the', 'other', '**node**' ]
            TestExpression: ['argument']
        }
    }
);

我们可以用 fallback 还有选项。 如果 fallback 选择是 "iteration", esrecurse 将访问未知节点的所有可枚举属性。 请注意循环引用会导致堆栈溢出。AST可能出于某些目的在其他属性中有循环引用(例如: node.parent).

esrecurse.visit(
    ast,
    {
        Literal: function (node) {
            // do something...
        }
    },
    {
        fallback: 'iteration'
    }
);

如果 fallback 期权是一个函数, esrecurse 调用此函数以确定未知节点的可枚举属性。 请注意循环引用会导致堆栈溢出。AST可能出于某些目的在其他属性中有循环引用(例如: node.parent).

esrecurse.visit(
    ast,
    {
        Literal: function (node) {
            // do something...
        }
    },
    {
        fallback: function (node) {
            return Object.keys(node).filter(function(key) {
                return key !== 'argument'
            });
        }
    }
);

许可证

版权所有2014 Yusuke Suzuki (推特: @Constellation)和其他贡献者。

重新分发和使用的源代码和二进制形式,有或没有 在满足下列条件的情况下,允许进行修改:

  • 重新发布源代码必须保留上述版权 注意,此条件列表和以下免责声明。

  • 以二进制形式重新发布必须复制上述版权 注意,本条件列表和以下免责声明中的 随发行版提供的文件和/或其他材料。

本软件由版权所有者和贡献者“按原样”提供。 以及任何明示或暗示的保证,包括但不限于 对适销性和适合某一特定目的的默示保证 是否认。在任何情况下,我都不承担任何责任 直接的、间接的、偶然的、特殊的、惩戒性的或后果性的损害 (包括但不限于,替代商品或服务的采购; 损失:失去使用、数据或利润;或业务中断),无论如何引起和 在任何责任理论中,无论是合同责任、严格责任还是侵权责任 (包括疏忽或其他)因使用 本软件即使被告知有这种损害的可能性。

版本与发布记录

esrecurse 共发布 13 个版本,首次发布于 2014/12/02;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.3.0latest2020/09/016 年前
4.2.12018/02/268 年前
4.2.02017/06/209 年前
4.1.02016/03/1210 年前
4.0.02016/02/0310 年前
3.1.12015/03/1511 年前

关于 esrecurse 的常见问题

esrecurse 是什么?

ECMAScript AST递归访问者

如何安装 esrecurse?

在项目目录运行 npm install esrecurse,或使用 pnpm add / yarn add / bun add。

esrecurse 支持 TypeScript 吗?

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

esrecurse 支持 ESM 还是 CommonJS?

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

esrecurse 需要什么版本的 Node.js?

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

esrecurse 可以商用吗?

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

esrecurse 的下载量有多少?

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

esrecurse 还在维护吗?

最新版本 4.3.0 发布于 2020/09/01(6 年前);至今共发布 13 个版本,其中过去 12 个月发布了 0 个;首次发布于 2014/12/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。