Gathering detailed insights and metrics for estree-util-visit
Gathering detailed insights and metrics for estree-util-visit
Gathering detailed insights and metrics for estree-util-visit
Gathering detailed insights and metrics for estree-util-visit
estree-util-is-identifier-name
Check if something can be an ecmascript (javascript) identifier name
hast-util-to-estree
hast utility to transform to estree (JavaScript AST) JSX
estree-util-build-jsx
Transform JSX in estrees to function calls (for react, preact, and most hyperscript interfaces)
estree-util-to-js
estree (and esast) utility to serialize to JavaScript
npm install estree-util-visit
Module System
Min. Node Version
Typescript Support
Node Version
NPM Version
4 Stars
39 Commits
1 Forks
8 Watching
1 Branches
10 Contributors
Updated on 08 Feb 2024
JavaScript (100%)
Cumulative downloads
Total Downloads
Last day
0.5%
346,181
Compared to previous day
Last week
7%
1,859,363
Compared to previous week
Last month
13.5%
7,644,857
Compared to previous month
Last year
83.6%
70,487,306
Compared to previous year
2
estree (and esast) utility to visit nodes.
This package is a utility that helps you walk the tree.
This package helps when dealing with JavaScript ASTs.
Use unist-util-visit
for other unist ASTs.
This package is ESM only. In Node.js (version 16+), install with npm:
1npm install estree-util-visit
In Deno with esm.sh
:
1import {visit} from 'https://esm.sh/estree-util-visit@2'
In browsers with esm.sh
:
1<script type="module"> 2 import {visit} from 'https://esm.sh/estree-util-visit@2?bundle' 3</script>
1import {parse} from 'acorn' 2import {visit} from 'estree-util-visit' 3 4const tree = parse( 5 'export function x() { console.log(1 + "2"); process.exit(3) }', 6 {sourceType: 'module', ecmaVersion: 2020} 7) 8 9visit(tree, function (node) { 10 if (node.type === 'Literal' && 'value' in node) console.log(node.value) 11}) 12 13// Both enter and leave: 14walk(tree, { 15 enter(node, field, index, parents) { /* … */ }, 16 leave(node, field, index, parents) { /* … */ } 17})
Yields:
11 2"2" 33
This package exports the identifiers CONTINUE
,
EXIT
,
SKIP
, and
visit
.
There is no default export.
visit(tree, visitor|visitors)
Visit nodes, 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.
tree
(Node
)
— tree to traversevisitor
(Visitor
)
— same as passing {enter: visitor}
visitors
(Visitors
)
— handle each nodeNothing (undefined
).
CONTINUE
Continue traversing as normal (symbol
).
EXIT
Stop traversing immediately (symbol
).
SKIP
Do not traverse this node’s children (symbol
).
Action
Union of the action types (TypeScript type).
1type Action = typeof CONTINUE | typeof EXIT | typeof SKIP
ActionTuple
List with one or two values, the first an action, the second an index (TypeScript type).
1type ActionTuple = [ 2 (Action | null | undefined | void)?, 3 (Index | null | undefined)? 4]
Index
Move to the sibling at index
next (after node itself is completely
traversed), when moving in an array (TypeScript type).
Useful if mutating the tree, such as removing the node the visitor is currently
on, or any of its previous siblings.
Results less than 0 or greater than or equal to children.length
stop
traversing the parent.
1type Index = number
Visitor
Handle a node (TypeScript type).
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 (which is a bug).
When adding or removing previous siblings of node
, the Visitor
should
return a new Index
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
.
node
(Node
)
— found nodekey
(string
or undefined
)
— field at which node
lives in its parent (or where a list of nodes
lives)index
(number
or undefined
)
— index where node
lives if parent[key]
is an arrayancestors
(Array<Node>
)
— ancestors of node
What to do next (Action
, Index
, or
ActionTuple
, optional).
An Index
is treated as a tuple of [CONTINUE, Index]
.
An Action
is treated as a tuple of [Action]
.
Passing a tuple back only makes sense if the Action
is SKIP
.
When the Action
is EXIT
, that action can be returned.
When the Action
is CONTINUE
, Index
can be returned.
Visitors
Handle nodes when entering (preorder) and leaving (postorder) (TypeScript type).
enter
(Visitor
, optional)
— handle nodes when entering (preorder)leave
(Visitor
, optional)
— handle nodes when leaving (postorder)This package is fully typed with TypeScript.
It exports the additional types Action
,
ActionTuple
,
Index
,
Visitor
, and
Visitors
.
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, estree-util-visit@^2
,
compatible with Node.js 16.
unist-util-visit
— walk any unist treeSee 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.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
Reason
security policy file detected
Details
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
Found 1/30 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More