Utils for ESLint Plugins
Utilities for working with TypeScript + ESLint together.
Note
This package has inherited its version number from the @typescript-eslint project.
Meaning that even though this package is 2.x.y, you shouldn't expect 100% stability between minor version bumps.
i.e. treat it as a 0.x.y package.
Feel free to use it now, and let us know what utilities you need or send us PRs with utilities you build on top of it.
Once it is stable, it will be renamed to @typescript-eslint/util for a 4.0.0 release.
Exports
| Name | Description |
|---|---|
ASTUtils |
Tools for operating on the ESTree AST. Also includes the eslint-utils package, correctly typed to work with the types found in TSESTree
|
ESLintUtils |
Tools for creating ESLint rules with TypeScript. |
JSONSchema |
Types from the @types/json-schema package, re-exported to save you having to manually import them. Also ensures you're using the same version of the types as this package. |
TSESLint |
Types for ESLint, correctly typed to work with the types found in TSESTree. |
TSESLintScope |
The eslint-scope package, correctly typed to work with the types found in both TSESTree and TSESLint
|
TSESTree |
Types for the TypeScript flavor of ESTree created by @typescript-eslint/typescript-estree. |
AST_NODE_TYPES |
An enum with the names of every single node found in TSESTree. |
AST_TOKEN_TYPES |
An enum with the names of every single token found in TSESTree. |
ParserServices |
Typing for the parser services provided when parsing a file using @typescript-eslint/typescript-estree. |