Giter Club home page Giter Club logo

ast-declaration-source's Introduction

ast-declaration-source

Given an esprima/acorn-style AST, approximately find the original declaration node responsible for a variable.

Usage

NPM

declaration = source(node)

Given a node within an AST generated by esprima or acorn, determine the original declaration node in the tree.

Returns undefined if a suitable node could not be found.

Note that you'll need to use astw or a similar package to add the "parent" properties to each node required for ast-declaration-source to successfully navigate the tree.

var source    = require('ast-declaration-source')
var escodegen = require('escodegen')
var acorn     = require('acorn')
var astw      = require('astw')
var fs        = require('fs')

var src      = fs.readFileSync(__filename, 'utf8')
var ast      = acorn.parse(src)

// required to assign "parent" properties
// to each node
astw(ast)(function(){})

var srcNode  = ast.body[6].declarations[0].init.arguments[0]
var declNode = source(srcNode)

console.log('original usage:')
console.log(escodegen.generate(srcNode.parent))
console.log()

console.log('declaration:')
console.log(escodegen.generate(declNode.parent.parent))
console.log()

License

MIT. See LICENSE.md for details.

ast-declaration-source's People

Contributors

hughsk avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

ast-declaration-source's Issues

Clarify in README that "node" should be an "Identifier" node

Thanks for the library.
It works with the latest version of acorn.

Currently, the README says:

declaration = source(node)

Given a node within an AST generated by esprima or acorn, determine the original declaration node in the tree.

After playing with the library, one thing I notice is that node should have type of Identifier. This should be clarified in README.

The example in README can be improved like this:

...
var walk = require('acorn-walk')

...
walk.simple(ast, {
  Identifier(node) {
    var declNode = source(node)
    ...
  }
});

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.