ESLint Scope

ESLint Scope is the ECMAScript scope analyzer used in ESLint. It is a fork of escope.

Install

npm i eslint-scope --save

📖 Usage

To use in an ESM file:

import * as eslintScope from 'eslint-scope';

To use in a CommonJS file:

const eslintScope = require('eslint-scope');

In order to analyze scope, you'll need to have an ESTree compliant AST structure to run it on. The primary method is eslintScope.analyze(), which takes two arguments:

ast - the ESTree-compliant AST structure to analyze.
options (optional) - Options to adjust how the scope is analyzed, including:

ignoreEval (default: false) - Set to true to ignore all eval() calls (which would normally create scopes).
nodejsScope (default: false) - Set to true to create a top-level function scope needed for CommonJS evaluation.
impliedStrict (default: false) - Set to true to evaluate the code in strict mode even outside of modules and without "use strict".
ecmaVersion (default: 5) - The version of ECMAScript to use to evaluate the code.
sourceType (default: "script") - The type of JavaScript file to evaluate. Change to "module" for ECMAScript module code.
childVisitorKeys (default: null) - An object with visitor key information (like eslint-visitor-keys). Without this, eslint-scope finds child nodes to visit algorithmically. Providing this option is a performance enhancement.
fallback (default: "iteration") - The strategy to use when childVisitorKeys is not specified. May be a function.

Example:

import * as eslintScope from 'eslint-scope';
import * as espree from 'espree';
import estraverse from 'estraverse';

const options = {
    ecmaVersion: 2022,
    sourceType: "module"
};

const ast = espree.parse(code, { range: true, ...options });
const scopeManager = eslintScope.analyze(ast, options);

const currentScope = scopeManager.acquire(ast);   // global scope

estraverse.traverse(ast, {
    enter (node, parent) {
        // do stuff

        if (/Function/.test(node.type)) {
            currentScope = scopeManager.acquire(node);  // get current function scope
        }
    },
    leave(node, parent) {
        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, so please be sure to read them before contributing. If you're not sure where to dig in, check out the issues.

Security Policy

We work hard to ensure that ESLint Scope is safe for everyone and that security issues are addressed quickly and responsibly. Read the full security policy.

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.

Current Tags

8.2.0 ... latest (16 days ago)
4.0.0-rc.0 ... next (6 years ago)
3.7.3 ... v3-latest (6 years ago)