npmpackage.info

As of June 2024, the npm registry hosts over 2 million packages, making it one of the largest open-source software repositories in the world.

periscopic

Utility for analyzing scopes belonging to an ESTree-compliant AST

4.0.2

MIT

JavaScript

102,872,727

3.7

Installations

npm install periscopic

Score

99.1

Supply Chain Risk

89.2

Quality

75.7

Maintenance

100

Vulnerability

Pull Requests

Open

2

Total

19

Closed

3

Merged

14

Issues

Open

3

Total

5

Closed

2

Contributors

View all 6 contributors

Developer

Rich-Harris

Statistics

89 Stars

74 Commits

7 Forks

4 Watching

1 Branches

6 Contributors

Updated on 18 Aug 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

102,872,727

Last day

0.9%

363,531

Compared to previous day

Last week

1,933,809

Compared to previous week

Last month

12.1%

8,009,853

Compared to previous month

Last year

154%

69,706,349

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@types/estree is-reference zimmerframe

Dev Dependencies

acorn dts-buddy typescript uvu

Versions

periscopic

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

API

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:

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

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

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

10

Dangerous-Workflow

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

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

CII-Best-Practices

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

0

Token-Permissions

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

0

Branch-Protection

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Pinned-Dependencies

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

Score

3.7

/10

Last Scanned on 2024-09-09

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

Other packages similar to periscopic

test-periscopic

0.2.0

Testing npm package making

periscopic

Installations

Score

Pull Requests

2

19

3

14

Issues

3

5

2

Contributors

Developer

Rich-Harris

Statistics

Languages

Total Downloads

102,872,727

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`