Como Configurar ESLint No React

Em nosso desenvolvimento diário, saber programar apenas não é o suficiente para sermos de fato um bom programador.
Existem padrões de projetos, boas práticas e alguns padrões que se seguirmos, nos torna muito melhor, bem como o nosso próprio código!

Uma coisa que devemos ter em mente é que, um código para ser considerado realmente bom é aquele código que fazemos de forma que um outro ser humano possa entender!

Pensando nisso, uma boa prática é utilizarmos o eslint!

ESLint é um plugin desenhado para permitir que desenvolvedores encontrem problemas em seu Javascript sem a necessidade de executar ele.
Ele é usado para encontrar problemas de padrões de projeto ou algum código que não se encaixe em algum determinado style guidelines

O ESlint é uma biblioteca open source, escrita originalmente por Nicholas C. Zakas em Junho de 2013.

Instalando o ESLint

Para começarmos utilizar o ESLint, devemos instalar ele através do npm ou yarn.
Instalaremos ele como uma dependência de Dev:

1
2
3
4
5
npm install eslint --save-dev

// ou

yarn add eslint --dev

Agora com o ESLint devidamente instalado, devemos inicializar o arquivo eslintrc.json.
É neste arquivo onde iremos adicionar as instruções, as regras que queremos que seguir

Então podemos usar o terminal rodando o seguinte comando:

1
npx eslint --init

Assim que rodamos este comando, nos deparamos com as seguintes opções:
Opções para criação do arquivo ESLint

Neste post, iremos selecionar a opção To check syntax, find problems, and enforce code style

E vamos selecionar as próximas escolhas na seguinte ordem:

  • JavaScript modules (import/export)
  • React
  • Does your project use TypeScript? (y/N): N
  • (*) Browser
  • Use a popular style guide
  • Airbnb
  • Javascript
  • Would you like to install them now with npm? Yes

Por que selecionamos Airbnb?
A style guide do Airbnb é uma das mais completas e cobre praticamente todas as principais práticas para Javascript.
Caso seja do seu interesse, você pode ver o repositório no GitHub do Airbnb

Nosso arquivo eslintrc.json deve ter ficado da seguinte forma:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
module.exports = {
env: {
browser: true,
es6: true,
},
extends: [
'plugin:react/recommended',
'airbnb',
],
globals: {
Atomics: 'readonly',
SharedArrayBuffer: 'readonly',
},
parserOptions: {
ecmaFeatures: {
jsx: true,
},
ecmaVersion: 2018,
sourceType: 'module',
},
plugins: [
'react',
],
rules: {
},
};

Para ficar melhor ainda, vamos adicionar mais uma dependência, chamada prettier:

1
2
3
4
5
npm install prettier --save-dev

// ou

yarn add prettier --dev

Com ela instalada, vamos alterar nosso arquivo eslintrc.json, vamos fazer uma pequena modificação:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
module.exports = {
env: {
browser: true,
es6: true,
},
extends: [
'airbnb',
'prettier',
'prettier/react'
],
globals: {
Atomics: 'readonly',
SharedArrayBuffer: 'readonly',
},
parser: 'babel-eslint',
parserOptions: {
ecmaFeatures: {
jsx: true,
},
ecmaVersion: 2018,
sourceType: 'module',
},
plugins: [
'react',
'prettier' // Adicionando prettier como plugin
],
// Modificamos as regras
// para que o prettier nos avise
// de erros na formtação
rules: {
'prettier/prettier': 'error',
'react/jsx-filename-extension': [
'warn',
{ extensions: ['.jsx', '.js'] }
],
'import/prefer-default-export': 'off'
},
};

Para finalizar, devemos adicionar mais três libs. Elas nos ajudarão a informar onde que estamos errando ou o que estamos esquecendo!
Vamos então rodar o comando:

1
2
3
yarn add -D babel-eslint eslint-plugin-prettier eslint-config-prettier
// Ou
npm install --save-dev babel-eslint eslint-plugin-prettier eslint-config-prettier

Agora com toda essa configuração feita, ao salvarmos nossos arquivos, eles são formatados para se adequar ao melhor padrão bem como também temos agora notificações de Javascript, para tornar os nossos códigos ainda mais legíveis, utilizando as melhores práticas!