google_forms/node_modules/eslint-scope/README.md

71 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

2024-08-21 06:34:30 +00:00
[![npm version](https://img.shields.io/npm/v/eslint-scope.svg)](https://www.npmjs.com/package/eslint-scope)
[![Downloads](https://img.shields.io/npm/dm/eslint-scope.svg)](https://www.npmjs.com/package/eslint-scope)
[![Build Status](https://github.com/eslint/eslint-scope/workflows/CI/badge.svg)](https://github.com/eslint/eslint-scope/actions)
2024-08-09 12:04:48 +00:00
# ESLint Scope
ESLint Scope is the [ECMAScript](http://www.ecma-international.org/publications/standards/Ecma-262.htm) scope analyzer used in ESLint. It is a fork of [escope](http://github.com/estools/escope).
2024-08-21 06:34:30 +00:00
## Install
2024-08-09 12:04:48 +00:00
```
npm i eslint-scope --save
```
2024-08-21 06:34:30 +00:00
## 📖 Usage
To use in an ESM file:
```js
import * as eslintScope from 'eslint-scope';
```
To use in a CommonJS file:
```js
const eslintScope = require('eslint-scope');
```
2024-08-09 12:04:48 +00:00
Example:
```js
2024-08-21 06:34:30 +00:00
import * as eslintScope from 'eslint-scope';
import * as espree from 'espree';
import estraverse from 'estraverse';
2024-08-09 12:04:48 +00:00
2024-08-21 06:34:30 +00:00
const ast = espree.parse(code, { range: true });
const scopeManager = eslintScope.analyze(ast);
2024-08-09 12:04:48 +00:00
2024-08-21 06:34:30 +00:00
const currentScope = scopeManager.acquire(ast); // global scope
2024-08-09 12:04:48 +00:00
estraverse.traverse(ast, {
2024-08-21 06:34:30 +00:00
enter (node, parent) {
2024-08-09 12:04:48 +00:00
// do stuff
if (/Function/.test(node.type)) {
currentScope = scopeManager.acquire(node); // get current function scope
}
},
2024-08-21 06:34:30 +00:00
leave(node, parent) {
2024-08-09 12:04:48 +00:00
if (/Function/.test(node.type)) {
currentScope = currentScope.upper; // set to parent scope
}
// do stuff
}
});
```
## Contributing
Issues and pull requests will be triaged and responded to as quickly as possible. We operate under the [ESLint Contributor Guidelines](http://eslint.org/docs/developer-guide/contributing), so please be sure to read them before contributing. If you're not sure where to dig in, check out the [issues](https://github.com/eslint/eslint-scope/issues).
## Build Commands
* `npm test` - run all linting and tests
* `npm run lint` - run all linting
## License
ESLint Scope is licensed under a permissive BSD 2-clause license.