Installations

npm install periscopic

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

16.20.2

NPM Version

8.19.4 Pull Requests

Open

2

Total

19

Closed

3

Merged

14

Issues

Open

4

Total

6

Closed

2

Releases

Unable to fetch releases

Contributors

6

Unable to fetch Contributors

View all 6 contributors

Languages

1

JavaScript

JavaScript (100%)

Developer

Rich-Harris

Download Statistics

Total Downloads

132,603,358

Last Day

117,296

Last Week

769,042

Last Month

7,213,984

Last Year

85,031,561

GitHub Statistics

96 Stars

74 Commits

8 Forks

5 Watching

1 Branches

6 Contributors

Bundle Size

3.18 kB

Minified

1.17 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

4.0.2

Package Id

periscopic@4.0.2

Unpacked Size

10.48 kB

Size

3.67 kB

File Count

6

NPM Version

8.19.4

Node Version

16.20.2

Publised On

10 Sept 2023

Total Downloads

Cumulative downloads

Total Downloads

132,603,358

Last day

-9.2%

117,296

Compared to previous day

Last week

-53%

769,042

Compared to previous week

Last month

-4.4%

7,213,984

Compared to previous month

Last year

128%

85,031,561

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

3

@types/estree is-reference zimmerframe

Dev Dependencies

4

acorn dts-buddy typescript uvu

Versions

periscopic

Utility for analyzing scopes belonging to an ESTree-compliant AST.

API

1import { analyze } from 'periscopic';
2
3const ast = acorn.parse(`
4const a = b;
5console.log(a);
6`);
7
8const { 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:

1import { extract_identifiers, extract_names } from 'periscopic';
2
3const ast = acorn.parse(`
4const { a, b: [c, d] = e } = opts;
5`);
6
7const lhs = ast.body[0].declarations[0].id;
8
9extract_identifiers(lhs);
10/*
11[
12	{ type: 'Identifier', name: 'a', start: 9, end: 10 },
13	{ type: 'Identifier', name: 'c', start: 16, end: 17 },
14	{ type: 'Identifier', name: 'd', start: 19, end: 20 }
15]
16*/
17
18extract_names(lhs);
19/*
20['a', 'c', 'd']
21*/

License

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

SAST

Determines if the project uses static code analysis.

Score

3.7

/10

Last Scanned on 2025-01-13

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

periscopic

Installations

Developer Guide

Yes

ESM

16.20.2

8.19.4

Pull Requests

2

19

3

14

Issues

4

6

2

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

Languages

Developer

Rich-Harris

Download Statistics

GitHub Statistics

Bundle Size

3.18 kB

1.17 kB

Maintainers

Package Meta Information

Total Downloads

132,603,358

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

periscopic

API

Scope

extract_identifiers and extract_names

License

10

10

10

10

3

0

0

0

0

0

0

0

0

3.7

/10

Other packages similar to periscopic

`extract_identifiers` and `extract_names`