typescript-eslint

What is typescript-eslint?

typescript-eslint is a set of tools that allows you to use ESLint to lint TypeScript code. It provides a parser that can read TypeScript code and a set of rules that are specific to TypeScript, enabling you to enforce coding standards and catch potential issues in your TypeScript projects.

What are typescript-eslint's main functionalities?

Linting TypeScript Code

This configuration file sets up ESLint to use the TypeScript parser and includes recommended rules from the @typescript-eslint plugin. It also adds a custom rule to error on unused variables.

module.exports = {
  parser: '@typescript-eslint/parser',
  plugins: ['@typescript-eslint'],
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended'
  ],
  rules: {
    '@typescript-eslint/no-unused-vars': 'error'
  }
};

Type-Aware Rules

This configuration enables type-aware linting rules by specifying a TypeScript project. The rule '@typescript-eslint/no-floating-promises' ensures that promises are properly handled.

module.exports = {
  parser: '@typescript-eslint/parser',
  parserOptions: {
    project: './tsconfig.json'
  },
  plugins: ['@typescript-eslint'],
  extends: [
    'plugin:@typescript-eslint/recommended-requiring-type-checking'
  ],
  rules: {
    '@typescript-eslint/no-floating-promises': 'error'
  }
};

Custom Rules

This configuration enforces explicit return types on functions, but allows expressions to omit the return type. This helps in maintaining clear and predictable function signatures.

module.exports = {
  parser: '@typescript-eslint/parser',
  plugins: ['@typescript-eslint'],
  rules: {
    '@typescript-eslint/explicit-function-return-type': ['error', {
      allowExpressions: true
    }]
  }
};

Other packages similar to typescript-eslint

tslint

TSLint is an extensible static analysis tool that checks TypeScript code for readability, maintainability, and functionality errors. However, TSLint has been deprecated in favor of ESLint and typescript-eslint, as the latter provides a more flexible and extensible architecture.

eslint

ESLint is a widely-used linting tool for JavaScript. While it does not natively support TypeScript, it can be extended with the typescript-eslint parser and plugin to lint TypeScript code. This makes ESLint a versatile tool for projects that use both JavaScript and TypeScript.

prettier

Prettier is an opinionated code formatter that supports multiple languages, including TypeScript. While it is not a linter, it can be used alongside typescript-eslint to ensure consistent code formatting. Prettier focuses on code style, whereas typescript-eslint focuses on code quality and potential errors.

README

typescript-eslint

Tooling which enables you to use TypeScript with ESLint

👉 See https://typescript-eslint.io/packages/typescript-eslint 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.

Changelog

7.2.0 (2024-03-11)

🚀 Features

• support TS 5.4 (#8630)
• eslint-plugin: [prefer-string-starts-ends-with] add allowSingleElementEquality option (#8374)

🩹 Fixes

• eslint-plugin: expose *-type-checked-only configs for extension (#8600)
• eslint-plugin: [member-ordering] report alphabetical sorting for all groups instead of just the first failing group (#8263)
• eslint-plugin: [no-var-requires, no-require-imports] support template literal (#8408)
• eslint-plugin: [no-useless-template-literals] detect TemplateLiteral (#8575)
• eslint-plugin: [no-unnecessary-condition] handle union array and tuple type (#8592)
• eslint-plugin: [prefer-find] support ternary branches in prefer-find (#8421)
• typescript-eslint: set sourceType: "module" in base shared config (#8622)
• typescript-eslint: export ConfigWithExtends type (#8621)

❤️ Thank You

• Arka Pratim Chaudhuri @arka1002
• auvred @auvred
• Chris Plummer
• Fotis Papadogeorgopoulos @fpapado
• Josh Goldberg ✨
• Kirk Waiblinger @kirkwaiblinger
• Wayne Zhang
• YeonJuan @yeonjuan

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