https://github.com/indico/eslint-config-indico

ESLint config/preset used by the Indico team
https://github.com/indico/eslint-config-indico

eslint eslint-config eslintconfig javascript

Last synced: 2 days ago
JSON representation

ESLint config/preset used by the Indico team

• Host: GitHub
• URL: https://github.com/indico/eslint-config-indico
• Owner: indico
• License: other
• Created: 2018-04-20T10:33:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-06-14T17:02:25.000Z (over 2 years ago)
• Last Synced: 2024-04-26T08:04:33.444Z (7 months ago)
• Topics: eslint, eslint-config, eslintconfig, javascript
• Language: JavaScript
• Homepage:
• Size: 15.6 KB
• Stars: 1
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Indico ESLint config

This is the ESLint config used by the Indico team.

## Installation

```shell

npm install --save-dev eslint-config-indico

# if you use babel

npm install --save-dev eslint-plugin-babel @babel/eslint-parser

# if you use react

npm install --save-dev eslint-plugin-react

# if you use react-hooks

npm install --save-dev eslint-plugin-react-hooks

# if you use prettier

npm install --save-dev prettier eslint-plugin-prettier eslint-config-prettier

```

## Presets

### indico

The base config. You always want this when using this package.  

Requires `eslint-plugin-import`

### indico/react

Enables rules from the react plugin.  

Requires `eslint-plugin-react`

### indico/react

Enables rules from the react-hooks plugin.  

Requires `eslint-plugin-react-hooks`

### indico/babel

Enables the babel plugin and parser.  

Requires `eslint-plugin-babel` and `@babel/eslint-parser`.  

Make sure to load this *after* the `indico` preset to avoid duplicate quote warnings.

### indico/prettier

Enables prettier integration.  

Requires `prettier`, `eslint-config-prettier` and `eslint-plugin-prettier`  

Make sure to load this after all other `indico/*` presets.  

When using babel/react, also enable the `prettier/babel` and `prettier/react` presets.

For convenience, we also include a prettier config, that can be loaded by putting `"eslint-config-indico/prettier-config"` in your `.prettierrc`.

## Example `.eslintrc.yml`

```yaml

extends:

  - 'indico'

  - 'indico/babel'

  - 'indico/react'

  - 'indico/react-hooks'

  - 'indico/prettier'

  - 'prettier/babel'

  - 'prettier/react'

env:

  browser: true

  es6: true

```