first commit
This commit is contained in:
56
build/node_modules/astw/readme.markdown
generated
vendored
Normal file
56
build/node_modules/astw/readme.markdown
generated
vendored
Normal file
@@ -0,0 +1,56 @@
|
||||
# astw
|
||||
|
||||
walk the ast
|
||||
|
||||
[](http://ci.testling.com/substack/astw)
|
||||
|
||||
[](http://travis-ci.org/substack/astw)
|
||||
|
||||
This module is a faster version of
|
||||
[falafel](https://github.com/substack/node-falafel)
|
||||
that only does ast walking and `.parent` tracking, not source transforms.
|
||||
|
||||
# example
|
||||
|
||||
``` js
|
||||
var astw = require('astw');
|
||||
var deparse = require('escodegen').generate;
|
||||
var walk = astw('4 + beep(5 * 2)');
|
||||
|
||||
walk(function (node) {
|
||||
var src = deparse(node);
|
||||
console.log(node.type + ' :: ' + JSON.stringify(src));
|
||||
});
|
||||
```
|
||||
|
||||
# methods
|
||||
|
||||
``` js
|
||||
var astw = require('astw')
|
||||
```
|
||||
|
||||
## var walk = astw(src, opts={})
|
||||
|
||||
Return a `walk()` function from the source string or ast object `src`.
|
||||
|
||||
Optionally:
|
||||
|
||||
* `opts.ecmaVersion` - default: 8
|
||||
|
||||
## walk(cb)
|
||||
|
||||
Walk the nodes in the ast with `cb(node)` where `node` is each element in the
|
||||
ast from [esprima](http://esprima.org/) but with an additional `.parent`
|
||||
reference to the parent node.
|
||||
|
||||
# install
|
||||
|
||||
With [npm](https://npmjs.org) do:
|
||||
|
||||
```
|
||||
npm install astw
|
||||
```
|
||||
|
||||
# license
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user