estree-walker
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    estree-walker

    Simple utility for walking an ESTree-compliant AST, such as one generated by acorn.

    Installation

    npm i estree-walker

    Usage

    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
      }
    });

    Inside the enter function, calling this.skip() will prevent the node's children being walked, or the leave function (which is optional) being called.

    Call this.replace(new_node) in either enter or leave to replace the current node with a new one.

    Call this.remove() in either enter or leave to remove the current node.

    Why not use estraverse?

    The ESTree spec is evolving to accommodate ES6/7. I've had a couple of experiences where estraverse was unable to handle an AST generated by recent versions of acorn, because it hard-codes visitor keys.

    estree-walker, by contrast, simply enumerates a node's properties to find child nodes (and child lists of nodes), and is therefore resistant to spec changes. It's also much smaller. (The performance, if you're wondering, is basically identical.)

    None of which should be taken as criticism of estraverse, which has more features and has been battle-tested in many more situations, and for which I'm very grateful.

    License

    MIT

    Keywords

    none

    Install

    npm i estree-walker

    DownloadsWeekly Downloads

    9,029,190

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    19.4 kB

    Total Files

    13

    Last publish

    Collaborators

    • rich_harris