Skip to content

🛠️ A unified ESLint configuration with sensible defaults for TypeScript projects.

License

Notifications You must be signed in to change notification settings

rfgamaral/eslint-config-typescript-unified

Repository files navigation

@rfgamaral/eslint-config-typescript-unified

development ci codecov npm minified size downloads commitizen friendly semantic-release license

A unified ESLint configuration with sensible defaults for TypeScript projects.

Installation

This package provides multiple ESLint Shareable Configurations for your convenience. To make use of any of them, you must first install eslint, prettier and typescript since this package does not do it for you. Then install it with:

npm install --save-dev @rfgamaral/eslint-config-typescript-unified

Usage

Once @rfgamaral/eslint-config-typescript-unified is installed, you can use any of the available configurations in the extends section of your ESLint configuration.

Default

Default configuration with recommended rules from @typescript-eslint/eslint-plugin and eslint-plugin-prettier:

{
  "extends": "@rfgamaral/eslint-config-typescript-unified"
}

ESLint

Extends the default configuration with recommended rules from ESLint:

{
  "extends": "@rfgamaral/eslint-config-typescript-unified/eslint"
}

Airbnb

Extends the default configuration with base rules from Aribnb:

{
  "extends": "@rfgamaral/eslint-config-typescript-unified/airbnb"
}

Airbnb (React)

Extends the Airbnb configuration with React rules from Airbnb:

{
  "extends": "@rfgamaral/eslint-config-typescript-unified/airbnb-react"
}

Airbnb (React + Hooks)

Extends the Airbnb React configuration with