esrecurse

What is esrecurse?

The esrecurse npm package is designed for recursively walking through ECMAScript/JavaScript syntax trees. It is commonly used for static analysis, code transformation, and other tasks that involve traversing and manipulating the structure of JavaScript code.

What are esrecurse's main functionalities?

Visiting nodes in an AST

This feature allows you to visit each node in an abstract syntax tree (AST) and perform actions based on the node type. In the code sample, `Literal` nodes are logged to the console.

const esrecurse = require('esrecurse');
esrecurse.visit(ast, {
  Literal(node) {
    console.log(node.value);
  }
});

Custom visitor keys

This feature allows you to define custom visitor keys for node types that are not part of the standard ECMAScript syntax. In the code sample, a `CustomNode` type is visited, and its `customProperty` is logged.

const esrecurse = require('esrecurse');
const visitorKeys = {
  CustomNode: ['customProperty']
};
esrecurse.visit(ast, {
  CustomNode(node) {
    console.log(node.customProperty);
  }
}, visitorKeys);

Other packages similar to esrecurse

estraverse

Estraverse is a similar package that provides a simple interface for traversing and optionally replacing nodes in an AST. It is similar to esrecurse but has a more extensive API and additional features like the ability to replace nodes.

acorn-walk

Acorn-walk is a part of the Acorn JS parser ecosystem and provides functionality for walking the AST generated by Acorn. It is similar to esrecurse but is tailored specifically for ASTs generated by Acorn and may not be as generic.

README

Esrecurse

Esrecurse (esrecurse) is ECMAScript recursive traversing functionality.

Example Usage

The following code will output all variables declared at the root of a file.

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

We can use Visitor instance.

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

visitor.visit(ast);

We can inherit Visitor instance easily.

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

And you can invoke default visiting operation inside custom visit operation.

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

License

Copyright (C) 2014 Yusuke Suzuki (twitter: @Constellation) and other contributors.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.