Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

@typescript-eslint/scope-manager

Package Overview
Dependencies
2
Maintainers
1
Versions
1447
Issues
File Explorer

Advanced tools

@typescript-eslint/scope-manager

TypeScript scope analyser for ESLint

    5.33.0latest

Version published
Maintainers
1
Weekly downloads
21,551,998
decreased by-1.45%

Weekly downloads

Changelog

Source

5.33.0 (2022-08-08)

Bug Fixes

  • eslint-plugin: [no-extra-parens] handle await with type assertion (#5428) (e03826f)
  • website: add explicit frontmatter description to rule docs (#5429) (63cba5f)

Features

  • eslint-plugin: [member-ordering] support static blocks (#5417) (5983e5a)
  • eslint-plugin: [prefer-as-const] adds support for class properties (#5413) (d2394f8)

Readme

Source

TypeScript Scope Manager

CI NPM Version NPM Downloads

This is a fork of eslint-scope, enhanced to support TypeScript functionality. You can view the original license for the code here.

This package is consumed automatically by @typescript-eslint/parser. You probably don't want to use it directly.

Getting Started

You can find our Getting Started docs here

Installation

$ yarn add -D typescript @typescript-eslint/scope-manager $ npm i --save-dev typescript @typescript-eslint/scope-manager

API

analyze(tree, options)

Analyses a given AST and returns the resulting ScopeManager.

interface AnalyzeOptions { /** * Known visitor keys. */ childVisitorKeys?: Record<string, string[]> | null; /** * Which ECMAScript version is considered. * Defaults to `2018`. * `'latest'` is converted to 1e8 at parser. */ ecmaVersion?: EcmaVersion | 1e8; /** * Whether the whole script is executed under node.js environment. * When enabled, the scope manager adds a function scope immediately following the global scope. * Defaults to `false`. */ globalReturn?: boolean; /** * Implied strict mode (if ecmaVersion >= 5). * Defaults to `false`. */ impliedStrict?: boolean; /** * The identifier that's used for JSX Element creation (after transpilation). * This should not be a member expression - just the root identifier (i.e. use "React" instead of "React.createElement"). * Defaults to `"React"`. */ jsxPragma?: string; /** * The identifier that's used for JSX fragment elements (after transpilation). * If `null`, assumes transpilation will always use a member on `jsxFactory` (i.e. React.Fragment). * This should not be a member expression - just the root identifier (i.e. use "h" instead of "h.Fragment"). * Defaults to `null`. */ jsxFragmentName?: string | null; /** * The lib used by the project. * This automatically defines a type variable for any types provided by the configured TS libs. * For more information, see https://www.typescriptlang.org/tsconfig#lib * * Defaults to the lib for the provided `ecmaVersion`. */ lib?: Lib[]; /** * The source type of the script. */ sourceType?: 'script' | 'module'; /** * Emit design-type metadata for decorated declarations in source. * Defaults to `false`. */ emitDecoratorMetadata?: boolean; }

Example usage:

import { analyze } from '@typescript-eslint/scope-manager'; import { parse } from '@typescript-eslint/typescript-estree'; const code = `const hello: string = 'world';`; const ast = parse(code, { // note that scope-manager requires ranges on the AST range: true, }); const scope = analyze(ast, { ecmaVersion: 2020, sourceType: 'module', });

References

Contributing

See the contributing guide here

Keywords

FAQs

What is @typescript-eslint/scope-manager?

TypeScript scope analyser for ESLint

Is @typescript-eslint/scope-manager popular?

The npm package @typescript-eslint/scope-manager receives a total of 20,740,230 weekly downloads. As such, @typescript-eslint/scope-manager popularity was classified as popular.

Is @typescript-eslint/scope-manager well maintained?

We found that @typescript-eslint/scope-manager demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 08 Aug 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc