node-modules/estraverse

Name: estraverse

Owner: node_modules

Description: ECMAScript JS AST traversal functions

Created: 2015-10-22 14:23:39.0

Updated: 2015-10-22 14:23:59.0

Pushed: 2015-10-18 13:33:42.0

Homepage: null

Size: 985

Language: CoffeeScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Estraverse Build Status

Estraverse (estraverse) is ECMAScript traversal functions from esmangle project.

Documentation

You can find usage docs at wiki page.

Example Usage

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

averse.traverse(ast, {
enter: function (node, parent) {
    if (node.type == 'FunctionExpression' || node.type == 'FunctionDeclaration')
        return estraverse.VisitorOption.Skip;
},
leave: function (node, parent) {
    if (node.type == 'VariableDeclarator')
      console.log(node.id.name);
}

We can use this.skip, this.remove and this.break functions instead of using Skip, Remove and Break.

averse.traverse(ast, {
enter: function (node) {
    this.break();
}

And estraverse provides estraverse.replace function. When returning node from enter/leave, current node is replaced with it.

lt = estraverse.replace(tree, {
enter: function (node) {
    // Replace it with replaced.
    if (node.type === 'Literal')
        return replaced;
}

By passing visitor.keys mapping, we can extend estraverse traversing functionality.

his tree contains a user-defined `TestExpression` node.
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

averse.traverse(tree, {
enter: function (node) { },

// Extending the existing traversing rules.
keys: {
    // TargetNodeName: [ 'keys', 'containing', 'the', 'other', '**node**' ]
    TestExpression: ['argument']
}

By passing visitor.fallback option, we can control the behavior when encountering unknown nodes.

his tree contains a user-defined `TestExpression` node.
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

averse.traverse(tree, {
enter: function (node) { },

// Iterating the child **nodes** of unknown nodes.
fallback: 'iteration'

License

Copyright © 2012-2013 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:

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.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.