Skip to content
This repository has been archived by the owner on Jul 6, 2022. It is now read-only.

Latest commit

 

History

History
65 lines (44 loc) · 1.48 KB

README.md

File metadata and controls

65 lines (44 loc) · 1.48 KB

@amille/eslint-ts-config

npm CircleCI Commitizen friendly

Eslint and prettier configuration with TypeScript support based on @amille/eslint-config

Installation

First you need to install eslint and prettier.

Then install @amille/eslint-ts-config.

# using npm
npm install --save-dev @amille/eslint-ts-config

# or using yarn
yarn add -D @amille/eslint-ts-config

Then create a file named .eslintrc.json with following contents in the root folder of your project:

{
    "root": true,
    "extends": ["@amille/eslint-ts-config"]
}

Then creat a file named .prettierrc.json along side the previous file, with the following contents.

"@amille/eslint-ts-config"

Variants

This package comes with two configurations

Default

The default configuration is based on airbnb-base and prettier.

{
    "extends": ["@amille/eslint-ts-config"]
}

React

The react configuration is based on airbnb, prettier and prettier/react.

{
    "extends": ["@amille/eslint-ts-config/react"]
}