Spaces:
Runtime error
Runtime error
File size: 2,050 Bytes
b5ea024 |
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 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
# periscopic
Utility for analyzing scopes belonging to an ESTree-compliant AST.
## API
```js
import { analyze } from 'periscopic';
const ast = acorn.parse(`
const a = b;
console.log(a);
`);
const { map, globals, scope } = analyze(ast);
```
* `map` is a `WeakMap<Node, Scope>`, where the keys are the nodes of your AST that create a scope
* `globals` is a `Map<string, Node>` of all the identifiers that are referenced without being declared anywhere in the program (in this case, `b` and `console`)
* `scope` is the top-level `Scope` belonging to the program
### Scope
Each `Scope` instance has the following properties:
* `scope.block` — true if the scope is created by a block statement (i.e. `let`, `const` and `class` are contained to it), false otherwise
* `scope.parent` — the parent scope object
* `scope.declarations` — a `Map<string, Node>` of all the variables declared in this scope, the node value referes to the declaration statement
* `scope.initialised_declarations` — a `Set<string>` of all the variables declared and initialised in this scope
* `scope.references` — a `Set<string>` of all the names referenced in this scope (or child scopes)
It also has two methods:
* `scope.has(name)` — returns `true` if `name` is declared in this scope or an ancestor scope
* `scope.find_owner(name)` — returns the scope object in which `name` is declared (or `null` if it is not declared)
### `extract_identifiers` and `extract_names`
This package also exposes utilities for extracting the identifiers contained in a declaration or a function parameter:
```js
import { extract_identifiers, extract_names } from 'periscopic';
const ast = acorn.parse(`
const { a, b: [c, d] = e } = opts;
`);
const lhs = ast.body[0].declarations[0].id;
extract_identifiers(lhs);
/*
[
{ type: 'Identifier', name: 'a', start: 9, end: 10 },
{ type: 'Identifier', name: 'c', start: 16, end: 17 },
{ type: 'Identifier', name: 'd', start: 19, end: 20 }
]
*/
extract_names(lhs);
/*
['a', 'c', 'd']
*/
```
## License
[MIT](LICENSE) |