# @ridi/eslint-config
[](https://badge.fury.io/js/%40ridi%2Feslint-config)
A rule set of RIDI's ESLint configurations based on Airbnb's.
## Installation
Install `@ridi/eslint-config` package:
1. Install the correct versions of each package, which are listed by the command:
```
npm info "@ridi/eslint-config" peerDependencies
```
if using **npm 5+**, use this shortcut
```
npx install-peerdeps --dev @ridi/eslint-config
```
if using **yarn**, use this command
```
yarn add --peer --dev @ridi/eslint-config
```
2. Install via package manager:
```
npm install --save-dev @ridi/eslint-config
```
or
```
yarn --dev @ridi/eslint-config
```
## Usage
### Javascript
```javascript
module.exports = {
extends: [
'@ridi/eslint-config'
]
}
```
### @ridi/eslint-config/typescript
> * @typescript-eslint/eslint-plugin
> * typescript
#### Typescript
```javascript
module.exports = {
extends: [
'@ridi/eslint-config',
'@ridi/eslint-config/typescript'
]
}
```
### @ridi/eslint-config/react
> * eslint-plugin-import
> * eslint-plugin-jsx-a11y
> * eslint-plugin-react
> * eslint-plugin-react-hooks
#### Javascript + React
```js
{
"extends": [
'@ridi/eslint-config',
'@ridi/eslint-config/react',
],
}
```
#### Typescript + React
```javascript
module.exports = {
extends: [
'@ridi/eslint-config',
'@ridi/eslint-config/typescript',
'@ridi/eslint-config/react'
]
}
```
### @ridi/eslint-config/prettier
> * eslint-plugin-prettier
#### Prettier
works fine with local configuration file (e.g. .prettierrc)
```js
{
"extends": [
'@ridi/eslint-config',
'@ridi/eslint-config/prettier',
],
}
```