\n\nThis is a fork of [`eslint-scope`](https://github.com/eslint/eslint-scope), enhanced to support TypeScript functionality.\n[You can view the original license for the code here](https://github.com/eslint/eslint-scope/blob/dbddf14d5771b21b5da704213e4508c660ca1c64/LICENSE).\n\nThis package is consumed automatically by [`@typescript-eslint/parser`](../parser).\nYou probably don't want to use it directly.\n\n## Getting Started\n\n**[You can find our Getting Started docs here](https://typescript-eslint.io/docs)**\n\n## Installation\n\n```bash\n$ yarn add -D typescript @typescript-eslint/scope-manager\n$ npm i --save-dev typescript @typescript-eslint/scope-manager\n```\n\n## API\n\n### `analyze(tree, options)`\n\nAnalyses a given AST and returns the resulting `ScopeManager`.\n\n```ts\ninterface AnalyzeOptions {\n /**\n * Known visitor keys.\n */\n childVisitorKeys?: Record | null;\n\n /**\n * Which ECMAScript version is considered.\n * Defaults to `2018`.\n * `'latest'` is converted to 1e8 at parser.\n */\n ecmaVersion?: EcmaVersion | 1e8;\n\n /**\n * Whether the whole script is executed under node.js environment.\n * When enabled, the scope manager adds a function scope immediately following the global scope.\n * Defaults to `false`.\n */\n globalReturn?: boolean;\n\n /**\n * Implied strict mode (if ecmaVersion >= 5).\n * Defaults to `false`.\n */\n impliedStrict?: boolean;\n\n /**\n * The identifier that's used for JSX Element creation (after transpilation).\n * This should not be a member expression - just the root identifier (i.e. use \"React\" instead of \"React.createElement\").\n * Defaults to `\"React\"`.\n */\n jsxPragma?: string;\n\n /**\n * The identifier that's used for JSX fragment elements (after transpilation).\n * If `null`, assumes transpilation will always use a member on `jsxFactory` (i.e. React.Fragment).\n * This should not be a member expression - just the root identifier (i.e. use \"h\" instead of \"h.Fragment\").\n * Defaults to `null`.\n */\n jsxFragmentName?: string | null;\n\n /**\n * The lib used by the project.\n * This automatically defines a type variable for any types provided by the configured TS libs.\n * For more information, see https://www.typescriptlang.org/tsconfig#lib\n *\n * Defaults to the lib for the provided `ecmaVersion`.\n */\n lib?: Lib[];\n\n /**\n * The source type of the script.\n */\n sourceType?: 'script' | 'module';\n\n /**\n * Emit design-type metadata for decorated declarations in source.\n * Defaults to `false`.\n */\n emitDecoratorMetadata?: boolean;\n}\n```\n\nExample usage:\n\n```ts\nimport { analyze } from '@typescript-eslint/scope-manager';\nimport { parse } from '@typescript-eslint/typescript-estree';\n\nconst code = `const hello: string = 'world';`;\nconst ast = parse(code, {\n // note that scope-manager requires ranges on the AST\n range: true,\n});\nconst scope = analyze(ast, {\n ecmaVersion: 2020,\n sourceType: 'module',\n});\n```\n\n## References\n\n- https://eslint.org/docs/developer-guide/scope-manager-interface\n- https://github.com/eslint/eslint-scope\n\n## Contributing\n\n[See the contributing guide here](../../CONTRIBUTING.md)\n","readmeFilename":"README.md"}
![\"CI\"](\"https://github.com/typescript-eslint/typescript-eslint/workflows/CI/badge.svg\"){kind=icon}
\n ![\"NPM](\"https://img.shields.io/npm/v/@typescript-eslint/scope-manager.svg?style=flat-square\")
\n ![\"NPM](\"https://img.shields.io/npm/dm/@typescript-eslint/scope-manager.svg?style=flat-square\")
\n