Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
transform the ast on a recursive walk
JavaScript
branch: master

1.0.1

latest commit 1f8c9b057b
@substack authored
Failed to load latest commit information.
example document isKeyword
test Add additional for test.
.travis.yml es6 test
index.js Remove redundant insertHelpers call.
package.json 1.0.1
readme.markdown update docs

readme.markdown

falafel

Transform the ast on a recursive walk.

browser support

build status

This modules uses acorn to create an AST from source code.

falafel döner

example

array.js

Put a function wrapper around all array literals.

var falafel = require('falafel');

var src = '(' + function () {
    var xs = [ 1, 2, [ 3, 4 ] ];
    var ys = [ 5, 6 ];
    console.dir([ xs, ys ]);
} + ')()';

var output = falafel(src, function (node) {
    if (node.type === 'ArrayExpression') {
        node.update('fn(' + node.source() + ')');
    }
});
console.log(output);

output:

(function () {
    var xs = fn([ 1, 2, fn([ 3, 4 ]) ]);
    var ys = fn([ 5, 6 ]);
    console.dir(fn([ xs, ys ]));
})()

methods

var falafel = require('falafel')

falafel(src, opts={}, fn)

Transform the string source src with the function fn, returning a string-like transformed output object.

For every node in the ast, fn(node) fires. The recursive walk is a pre-traversal, so children get called before their parents.

Performing a pre-traversal makes it easier to write nested transforms since transforming parents often requires transforming all its children first.

The return value is string-like (it defines .toString() and .inspect()) so that you can call node.update() asynchronously after the function has returned and still capture the output.

Instead of passing a src you can also use opts.source.

All of the opts will be passed directly to acorn.

nodes

Aside from the regular esprima data, you can also call some inserted methods on nodes.

Aside from updating the current node, you can also reach into sub-nodes to call update functions on children from parent nodes.

node.source()

Return the source for the given node, including any modifications made to children nodes.

node.update(s)

Transform the source for the present node to the string s.

Note that in 'ForStatement' node types, there is an existing subnode called update. For those nodes all the properties are copied over onto the node.update() function.

node.parent

Reference to the parent element or null at the root element.

install

With npm do:

npm install falafel

license

MIT

Something went wrong with that request. Please try again.