@typescript-eslint/parser
Advanced tools
Package description
The @typescript-eslint/parser is an ESLint parser that allows for the analysis and linting of TypeScript code. It is part of the TypeScript-ESLint project, which aims to bring ESLint's powerful static analysis capabilities to TypeScript codebases. The parser converts TypeScript source code into an ESTree-compatible form so that it can be used by ESLint for linting and other code analysis tasks.
Parsing TypeScript code
This feature allows the parser to read TypeScript files and produce an abstract syntax tree (AST) that is compatible with ESLint, enabling it to understand and lint TypeScript syntax.
const { ESLint } = require('eslint');
async function main() {
const eslint = new ESLint({
parser: '@typescript-eslint/parser',
parserOptions: {
ecmaVersion: 2020,
sourceType: 'module',
project: './tsconfig.json'
}
});
const results = await eslint.lintFiles(['src/**/*.ts']);
// Handle the results
}
main();Integration with ESLint rules
The parser can be used in conjunction with ESLint rules, including those specifically designed for TypeScript, to enforce code quality and style guidelines.
module.exports = {
parser: '@typescript-eslint/parser',
extends: [
'plugin:@typescript-eslint/recommended'
],
rules: {
'@typescript-eslint/no-unused-vars': 'error',
'@typescript-eslint/explicit-function-return-type': 'warn'
}
};This package contains a set of ESLint rules that are specifically tailored for TypeScript. It is often used together with @typescript-eslint/parser to provide a complete linting solution for TypeScript codebases.
babel-eslint is an ESLint parser that allows you to lint all valid Babel code with ESLint. While it is not specifically designed for TypeScript, it can be used to lint code that uses Babel for transpilation, including TypeScript when used with the appropriate Babel plugins.
This is a deprecated package that was used to provide ESLint rules for TypeScript before the TypeScript-ESLint project was created. It has been replaced by the @typescript-eslint/parser and typescript-eslint/eslint-plugin packages.
Changelog
6.0.0 (2023-07-10)
typeMatchesSpecifier (#6820) (7ca2c90)ImportExpression (#6587) (e8cdd5c)override on non-constructor function/methods (#6729) (2f3638f)exports field in package.json files (#6550) (53776c2)TRuleListener generic from the createRule (#5036) (361f8bc), closes #5834 #5882 #5864rule-tester (#6777) (2ce1c1d)experimental-utils (#6468) (71adbc5)RuleTester in /utils in favour of the new /rule-tester package (#6816) (c33f497)meta.docs.suggestion rule type (#5967) (f424b2a)experimental-utils - we will no longer update this package and it will be forever frozen at v5.xmeta.docs.suggestion propertyYou can read about our versioning strategy and releases on our website.
Readme
@typescript-eslint/parserAn ESLint parser which leverages TypeScript ESTree to allow for ESLint to lint TypeScript source code.
š See https://typescript-eslint.io/packages/parser for documentation on this package.
See https://typescript-eslint.io for general documentation on typescript-eslint, the tooling that allows you to run ESLint and Prettier on TypeScript code.
FAQs
Unknown package
The npm package @typescript-eslint/parser receives a total of 26,259,703 weekly downloads. As such, @typescript-eslint/parser popularity was classified as popular.
We found that @typescript-eslint/parser demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.Ā It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.