@typescript-eslint/eslint-plugin
Advanced tools
Package description
The @typescript-eslint/eslint-plugin package is an ESLint plugin that contains a set of ESLint rules that are specifically designed for TypeScript code. It helps in identifying and reporting on patterns found in TypeScript code, and it can be used to enforce a wide range of coding standards and conventions.
Type-aware linting
This feature allows for rules that require type information. For example, the 'strict-boolean-expressions' rule ensures that boolean expressions are clear and error-free by considering the types involved in the expression.
/* eslint @typescript-eslint/strict-boolean-expressions: 'error' */
function isTruthy(value: any): boolean {
return Boolean(value);
}Code style enforcement
Enforces naming conventions for everything from variables to type parameters. This example enforces camelCase naming for variables.
/* eslint @typescript-eslint/naming-convention: ['error', { 'selector': 'variable', 'format': ['camelCase'] }] */
let myVariable = 1;Accessibility checks
This feature requires functions and methods to explicitly define their return type to improve code readability and maintainability.
/* eslint @typescript-eslint/explicit-function-return-type: 'warn' */
function add(x: number, y: number) {
return x + y;
}This package provides linting rules for React and JSX. It's similar to @typescript-eslint/eslint-plugin in that it extends ESLint's capabilities to a specific language extension, but it focuses on React rather than TypeScript.
This package is designed for linting Vue.js templates and scripts. Like @typescript-eslint/eslint-plugin, it provides additional rules that are specific to the Vue.js framework, complementing the standard ESLint rules.
This plugin provides a set of rules that help ensure proper imports, exports, and module structure. While it's not specific to TypeScript, it complements @typescript-eslint/eslint-plugin by enforcing best practices in module usage.
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/eslint-pluginAn ESLint plugin which provides lint rules for TypeScript codebases.
š See https://typescript-eslint.io/getting-started for our Getting Started docs.
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
TypeScript plugin for ESLint
The npm package @typescript-eslint/eslint-plugin receives a total of 26,041,852 weekly downloads. As such, @typescript-eslint/eslint-plugin popularity was classified as popular.
We found that @typescript-eslint/eslint-plugin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.Ā It has 2 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.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.