Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

@typescript-eslint/eslint-plugin

Package Overview
Dependencies
9
Maintainers
1
Versions
2159
Issues
File Explorer

Advanced tools

@typescript-eslint/eslint-plugin

TypeScript plugin for ESLint

    5.33.0latest

Version published
Maintainers
1
Weekly downloads
17,302,353
increased by1.28%

Weekly downloads

Changelog

Source

5.33.0 (2022-08-08)

Bug Fixes

  • eslint-plugin: [no-extra-parens] handle await with type assertion (#5428) (e03826f)
  • website: add explicit frontmatter description to rule docs (#5429) (63cba5f)

Features

  • eslint-plugin: [member-ordering] support static blocks (#5417) (5983e5a)
  • eslint-plugin: [prefer-as-const] adds support for class properties (#5413) (d2394f8)

Readme

Source

ESLint Plugin TypeScript

An ESLint plugin which provides lint rules for TypeScript codebases.

CI NPM Version NPM Downloads

Getting Started

These docs walk you through setting up ESLint, this plugin, and our parser. If you know what you're doing and just want to quick start, read on...

Quick-start

Installation

Make sure you have TypeScript and @typescript-eslint/parser installed:

$ yarn add -D typescript @typescript-eslint/parser $ npm i --save-dev typescript @typescript-eslint/parser

Then install the plugin:

$ yarn add -D @typescript-eslint/eslint-plugin $ npm i --save-dev @typescript-eslint/eslint-plugin

It is important that you use the same version number for @typescript-eslint/parser and @typescript-eslint/eslint-plugin.

Note: If you installed ESLint globally (using the -g flag) then you must also install @typescript-eslint/eslint-plugin globally.

Usage

Add @typescript-eslint/parser to the parser field and @typescript-eslint to the plugins section of your .eslintrc configuration file, then configure the rules you want to use under the rules section.

{ "parser": "@typescript-eslint/parser", "plugins": ["@typescript-eslint"], "rules": { "@typescript-eslint/rule-name": "error" } }

You can also enable all the recommended rules for our plugin. Add plugin:@typescript-eslint/recommended in extends:

{ "extends": ["plugin:@typescript-eslint/recommended"] }

You can also use eslint:recommended (the set of rules which are recommended for all projects by the ESLint Team) with this plugin:

{ "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"] }

As of version 2 of this plugin, by design, none of the rules in the main recommended config require type-checking in order to run. This means that they are more lightweight and faster to run.

Some highly valuable rules require type-checking in order to be implemented correctly, however, so we provide an additional config you can extend from called recommended-requiring-type-checking. You would apply this in addition to the recommended configs previously mentioned, e.g.:

{ "extends": [ "eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:@typescript-eslint/recommended-requiring-type-checking" ] }

Pro Tip: For larger codebases you may want to consider splitting our linting into two separate stages: 1. fast feedback rules which operate purely based on syntax (no type-checking), 2. rules which are based on semantics (type-checking).

You can read more about linting with type information here

Supported Rules

For the exhaustive list of supported rules, please see our website.

Contributing

See the contributing guide here.

Keywords

FAQs

What is @typescript-eslint/eslint-plugin?

TypeScript plugin for ESLint

Is @typescript-eslint/eslint-plugin popular?

The npm package @typescript-eslint/eslint-plugin receives a total of 14,027,284 weekly downloads. As such, @typescript-eslint/eslint-plugin popularity was classified as popular.

Is @typescript-eslint/eslint-plugin well maintained?

We found that @typescript-eslint/eslint-plugin demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 08 Aug 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc