@eduzz/eslint-config-houston

name: ESLint

menu:

ESLint Config

Para configurar no padrão do Houston, primerio você deve adicionar as dependências, pois o eslint exige que plugins devem, ser adicionados no projeto principal:

React

yarn add --dev eslint @eduzz/eslint-config-houston eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-config-prettier eslint-plugin-eslint-plugin eslint-plugin-import eslint-plugin-prettier eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-unused-imports eslint-plugin-sonarjs prettier

// .eslintrc
{
  "extends": ["@eduzz/eslint-config-houston"]
}

// .prettierrc.js
module.exports = {
  ...require('@eduzz/eslint-config-houston/.prettierrc')
};

React Native:

yarn add --dev eslint @eduzz/eslint-config-houston eslint eslint-plugin-react-native @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-config-prettier eslint-plugin-eslint-plugin eslint-plugin-import eslint-plugin-prettier eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-unused-imports eslint-plugin-sonarjs prettier

// .eslintrc
{
  "extends": ["@eduzz/eslint-config-houston/native"]
}

// .prettierrc.js
module.exports = {
  ...require('@eduzz/eslint-config-houston/.prettierrc')
};

Node

yarn add --dev eslint @eduzz/eslint-config-houston eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-config-prettier eslint-plugin-eslint-plugin eslint-plugin-import eslint-plugin-prettier eslint-plugin-unused-imports eslint-plugin-sonarjs prettier

// .eslintrc
{
  "extends": ["@eduzz/eslint-config-houston/node"]
}

// .prettierrc.js
module.exports = {
  ...require('@eduzz/eslint-config-houston/.prettierrc')
};

Configurações Extras

VSCode

• Adicione a extensão do ESLint. SUGERIMOS DESISTALAR OU DESATIVAR A EXTENSÃO DO PRETTIER POIS O ESLINT QUE APLICARÁ O PRETTIER.

• Crie/Adicione no .vscode/settings.json (não na suas configurações, pois assim ficará no projeto e o time já terá acesso):

{
  //... suas configurações
  "editor.codeActionsOnSave": {
    "source.organizeImports": false,
    "source.fixAll.eslint": true
  },
  "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact"],
  "editor.formatOnPaste": false,
  "editor.formatOnSave": false,
  "editor.formatOnType": false,
  "editor.tabSize": 2
}

React Hooks

Para que o eslint verifique e aplica a regra correta do react-hooks/exhaustive-deps é preciso adicionar seus custom hooks nas regras do .eslintrc, para facilitar esse processo criamos um generator. Já adicionados todos os hooks do Houston, mas caso queria adicionar os do seu proejeto:

// .eslintrc.js <~precisa ser .js
const generator = require('@eduzz/eslint-config-houston/configs/generator');

module.exports = {
  extends: ['@eduzz/eslint-config-houston'],
  rules: {
    'react-hooks/exhaustive-deps': generator.exhaustiveDeps('warn', ['useMyCustomHook'], true)
  }
};

Método	Params
exhaustiveDeps	1. 'warn' | 'error' 2. Array com seus hooks 3. boolean se deve ou não adicionar os hooks do @eduzz/houston-hooks

⚠️ Vale ressaltar que os custom hooks devem seguir o padrão de que o segundo parametro seja a deps

React 17 e JSX

Para utilizar a nova versão do React com jsx-runtime basta seguir o tutorial do blog, mas resumidamente é:

# Removendo Imports React não Utilizadas
npx react-codemod update-react-imports

tsconfig.json

{
  //... suas configurações
  "compilerOptions": {
    "jsx": "react-jsx" //Troque esse configuração
  }
}

.eslintrc

{
  "extends": ["@eduzz/eslint-config-houston"],
  "rules": {
    //Adicione essas rules
    "react/jsx-uses-react": "off",
    "react/react-in-jsx-scope": "off"
  }
}