simple scope analysis for javascript ASTs. tracks scopes and collects references to variables.
Caveats and/or todos:
May be missing edge cases.
Things like label:s are not considered at all, but ideally in the future they will!
Install
npm install scope-analyzer
Usage
Note: AST nodes passed to scope-analyzer functions are expected to reference the parent node on a node.parent property.
Nodes from falafel or transform-ast have a .parent property, but others may not. You can use estree-assign-parent to quickly assign a parent property to all nodes in an AST.
var scan = require('scope-analyzer')var ast = parse('...')// Initialize node module variablesscan.createScope(ast, ['module', 'exports', '__dirname', '__filename'])scan.crawl(ast)var binding = scan.getBinding(ast, 'exports')binding.getReferences().forEach(function (reference) { // Assume for the sake of the example that all references to `exports` are assignments like // `exports.xyz = abc` console.log('found export:', reference.parent.property.name)})
API
crawl(ast)
Walk the ast and analyze all scopes. This will immediately allow you to use the get* methods on any node in the tree.
clear(ast)
Clear scope information in all nodes of the AST.
visitScope(node)
Visit a node to check if it initialises any scopes.
For example, a function declaration will initialise a new scope to hold bindings for its parameters.
Use this if you are already walking the AST manually, and if you don't need the scope information during this walk.
visitBinding(node)
Visit a node to check if it is a reference to an existing binding.
If it is, the reference is added to the parent scope.
Use this if you are already walking the AST manually.
createScope(node, bindings)
Initialise a new scope at the given node. bindings is an array of variable names.
This can be useful to make the scope analyzer aware of preexisting global variables.
In that case, call createScope on the root node with the names of globals:
var ast = parse('xyz')scopeAnalyzer.createScope(ast, ['HTMLElement', 'Notification', ...])