@typescript-eslint/eslint-plugin

What is @typescript-eslint/eslint-plugin?

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.

What are @typescript-eslint/eslint-plugin's main functionalities?

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;
}

Other packages similar to @typescript-eslint/eslint-plugin

eslint-plugin-react

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.

eslint-plugin-vue

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.

eslint-plugin-import

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.

README

@typescript-eslint/eslint-plugin

An 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.

Changelog

6.8.0 (2023-10-16)

Bug Fixes

• eslint-plugin: [consistent-type-imports] import assertion checks added (#7722) (afdae37)
• eslint-plugin: [no-shadow] fix static class generics for class expressions (#7724) (e5ea1d0)
• eslint-plugin: [no-unsafe-member-access] report on only the accessed property (#7717) (f81a2da)
• eslint-plugin: [no-useless-empty-export] exempt .d.ts (#7718) (ac397f1)

Features

• eslint-plugin: add new extended rule prefer-destructuring (#7117) (3c6379b)

You can read about our versioning strategy and releases on our website.