@zmgti/eslint-config NPM

Lint Config © ZM S.A

Esse repositório é destinado às configurações de linting usadas para alguns repositórios da ZM S.A.

Tabela de conteúdos

Setup

Versões utilizadas:

Node.js (recomendado: >=18.13.0)
ESLint (>=8.45.0)

Note O setup a seguir atualmente tem foco em Vue.js, porém, os passos a seguir são bem semelhantes em outras tecnologias e stacks.

1. Instalar as dependências de desenvolvimento:

npm i --save-dev eslint @zmgti/eslint-config

2. Instalar as extensões recomendadas e alterar o arquivo de configuração do VS Code, utilizando a pasta .vscode como referência:

Note Caso você não queira sobrescrever suas configurações de usuário, copie a pasta .vscode para a raiz do seu projeto. Por padrão, o VS Code irá priorizar as configurações do Workspace em relação às do usuário.

3. Criar o arquivo eslint.config.js na raiz do projeto, importando as configurações:

// eslint.config.js

const vueConfig = require('@zmgti/eslint-config/vue')

module.exports = {
   ...vueConfig
}

Note O último diretório da importação deverá ser qual arquivo de config deseja-se utilizar. As opções disponíveis são os arquivos .js no repositório, voltados para stacks/tecnologias específicas.

4. Copiar o arquivo .editorconfig para a raiz do seu projeto:

Apesar desse repositório ser destinado às configurações do VS Code, o EditorConfig é algo que pode ser reaproveitado em várias IDEs, servindo como uma configuração base para todo o resto.

Desenvolvimento

As configurações são bem expansíveis para novas stacks/tecnologias:

1. Clonar o repositório:

git clone https://github.com/zmgti/eslint-config.git

2. Criar uma branch nova:

git branch <nome_da_branch>
git checkout <nome_da_branch>

3. Criar um arquivo de configurações novo:

touch <nome_da_ferramenta_ou_stack>.js

Note Você pode criar o arquivo manualmente caso preferir.

4. Instalar as dependências (plugins e configs) que serão utilizadas:

npm i --save-dev <deps>

Note A compatibilidade entre as versões das dependências e plugins do ESLint muitas vezes se torna instável. Para controlar isso inicialmente, executar o passo 2 é essencial. Além disso, o comando eslint --debug <caminho_arquivo> é bem útil para visualizar uma stack dos erros.

5. Boa Sorte!

Agora é só configurar o arquivo com as regras e configurações optadas pela equipe.

Para testar as configurações em algum projeto real, basta utilizar o comando npm i --save-dev eslint <caminho_lib>. O caminho_lib é onde está o repositório local dessa biblioteca.

6. Subir uma Pull Request com o código pronto e testado para a branch main.