Ir para o conteúdo principal

O que é o ESLint?

O ESLint é uma ferramenta de análise estática de código que ajuda a manter a qualidade, padronização e consistência do código JavaScript. Como esse projeto utilizar o Cypress para automação de testes, o ESLint tem um papel importante na prevenção de erros e na melhoria da legibilidade dos testes automatizados.

Por que usar ESLint com Cypress

  1. Evita erros comuns em testes
    Comandos como cy.get(), cy.visit() ou Cypress.env() são globais e, sem a configuração correta, podem gerar falsos erros de "variável não definida". O ESLint com o plugin Cypress reconhece corretamente essas APIs.

  2. Garante boas práticas de escrita
    O ESLint aplica regras recomendadas para testes, como evitar comandos encadeados mal estruturados ou esperas desnecessárias. Isso ajuda a manter os testes mais confiáveis e limpos.

  3. Facilita a manutenção de testes legíveis
    Um código de teste mal formatado dificulta a leitura e o debug. O ESLint organiza o código e ajuda a aplicar um padrão que torna os testes mais claros e compreensíveis.

  4. Padroniza o estilo em toda a suíte de testes
    Em equipes, cada desenvolvedor pode ter um estilo diferente de escrita. O ESLint aplica um padrão automático, reduzindo retrabalho e divergências no código.

  5. Integração com editores e CI
    O ESLint pode ser integrado ao VS Code, rodando em tempo real, e também pode ser incluído nos pipelines de CI, evitando que testes mal estruturados sejam enviados para produção.

Considerações

Para que funcione corretamente com Cypress, é necessário instalar e configurar o plugin eslint-plugin-cypress, além de declarar as variáveis globais (cy, Cypress) no ambiente da ferramenta. (Porém quando é feito o npm init para inicializar, ele já traz corretamente, não sendo necessário essa configuração)