summaryrefslogtreecommitdiff
path: root/tools/eslint/node_modules/estraverse-fb/README.md
blob: 20b02966b871d0c933fcca1e7e99f6d4203c6624 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
estraverse-fb
=============
[![Build Status](https://travis-ci.org/RReverser/estraverse-fb.svg?branch=master)](https://travis-ci.org/RReverser/estraverse-fb)

Drop-in for estraverse that enables traversal over React's JSX and Flow nodes using monkey-patching technique.

You can use estraverse-fb in two possible ways:

* by default, you just require it and it injects needed keys into your installed version of estraverse (it's installed automatically if you don't have it yet):
    ```javascript
    var estraverse = require('estraverse-fb');
    /* same as:
        require('estraverse-fb');
        var estraverse = require('estraverse');
    */

    estraverse.traverse(ast, {
        enter: ...,
        leave: ...
    });
    ```

* alternatively, you can use it manually for selected traversals:
    ```javascript
    var jsxKeys = require('estraverse-fb/keys');

    estraverse.traverse(ast, {
        enter: ...,
        leave: ...,
        keys: jsxKeys
    })
```

Check out [estraverse page](https://github.com/Constellation/estraverse) for detailed usage.