Novelty Plastic Moustache

    estree-util-visit
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.0 • Public • Published

    estree-util-visit

    Build Coverage Downloads Size Sponsors Backers Chat

    esast (and estree) utility to visit nodes.

    Contents

    What is this?

    This package is a utility that helps you walk the tree.

    When should I use this?

    This package helps when dealing with JavaScript ASTs. Use unist-util-visit for other unist ASTs.

    Install

    This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with npm:

    npm install estree-util-visit

    In Deno with esm.sh:

    import {visit} from 'https://esm.sh/estree-util-visit@1'

    In browsers with esm.sh:

    <script type="module">
      import {visit} from 'https://esm.sh/estree-util-visit@1?bundle'
    </script>

    Use

    import {parse} from 'acorn'
    import {visit} from 'estree-util-visit'
    
    const tree = parse(
      'export function x() { console.log(1 + "2"); process.exit(3) }',
      {sourceType: 'module', ecmaVersion: 2020}
    )
    
    visit(tree, (node) => {
      if (node.type === 'Literal' && 'value' in node) console.log(node.value)
    })
    
    // Both enter and leave:
    walk(tree, {
      enter(node, field, index, parents) { /* … */ },
      leave(node, field, index, parents) { /* … */ }
    })

    Yields:

    1
    "2"
    3
    

    API

    This package exports the identifiers visit, EXIT, CONTINUE, and SKIP. There is no default export.

    visit(tree, visitor|visitors)

    Visit nodes (inclusive descendants of tree), with ancestral information.

    This algorithm performs depth-first tree traversal in preorder (NLR) and/or postorder (LRN).

    Compared to other estree walkers, this does not need a dictionary of which fields are nodes, because it ducktypes instead.

    Walking the tree is an intensive task. Make use of the return values of the visitor(s) when possible. Instead of walking a tree multiple times, walk it once, use unist-util-is to check if a node matches, and then perform different operations.

    Parameters
    • tree (Node) — tree to traverse
    • visitor (Function) — same as passing {enter: visitor}
    • visitors ({enter: visitor, exit: visitor}) — two functions, respectively called when entering a node (preorder) or before leaving a node (postorder)

    next? = visitor(node, key, index, ancestors)

    Called when a node is found.

    Visitors are free to transform node. They can also transform the parent of node (the last of ancestors). Replacing node itself, if SKIP is not returned, still causes its descendants to be walked. If adding or removing previous siblings of node, visitor should return a new index (number) to specify the sibling to traverse after node is traversed. Adding or removing next siblings of node is handled as expected without needing to return a new index.

    Parameters
    • node (Node) — found node
    • key (string?) — field at which node lives in its parent
    • index (number?) — index at which node lives if parent[key] is an array
    • ancestors (Array<Node>) — ancestors of node
    Returns

    The return value can have the following forms:

    • index (number) — treated as a tuple of [CONTINUE, index]
    • action (symbol) — treated as a tuple of [action]
    • tuple (Array<symbol|number>) — list with one or two values, the first an action, the second and index. Note that passing a tuple only makes sense if the action is SKIP. If the action is EXIT, that action can be returned. If the action is CONTINUE, index can be returned.
    action

    An action can have the following values:

    • EXIT (symbol) — stop traversing immediately
    • CONTINUE (symbol) — continue traversing as normal (same behaviour as not returning an action)
    • SKIP (symbol) — do not traverse this node’s children. Has no effect in leave

    Types

    This package is fully typed with TypeScript. It exports the additional types Action, Index, ActionTuple, Visitor, and Visitors.

    Compatibility

    Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

    Related

    Contribute

    See contributing.md in syntax-tree/.github for ways to get started. See support.md for ways to get help.

    This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

    License

    MIT © Titus Wormer

    Install

    npm i estree-util-visit

    DownloadsWeekly Downloads

    466,692

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    18.1 kB

    Total Files

    9

    Last publish

    Collaborators

    • wooorm
    • kmck