Flutter Linter

Adicionando linter a sua aplicação Flutter

O que é Linter?

Antes de darmos início, seria ideal sabermos o conceito básico que envolve um Linter e para isso, um resumo seria que, um Linter ou Lint é uma ferramenta que analisa o código-fonte para sinalizar erros de programação, bugs, sugestões de estilos e construções suspeitas.

Basicamente o Linter irá te auxiliar durante o tempo de desenvolvimento, te dando sugestões para um melhor padrão de código de acordo com as regras que você previamente definiu.

Como mencionado no título, iremos aqui ter um breve e simples exemplo de como adicionar um linter à sua aplicação e não necessariamente precisa ser em Flutter, o exemplo dado poderá ser aplicado em qualquer projeto que utilize dartcomo linguagem.

Benefícios de se utilizar

Qual o propósito de utilizarmos um linte em uma aplicação Flutter? Como em qualquer outro linter, o principal objetivo é mantermos uma única forma de escrita, porém também ganhamos outros pontos como:

• Melhor legibilidade do código:
  O benefício de um código mais legível é indiscutível e irá diminuir a curva de novos desenvolvedores.
• Padronização do código:
  Com as regras bem definidas, fica fácil ter um padrão de código único.
• Melhor manutenção do código:
  Com um padrão definido, a manutenção e refatoração serão menos dolorosas.
• Ganho de tempo em code reviews:
  Às vezes algumas revisões demandam muito tempo e o linter pode evitar isso, pois previamente alguns ajustes poderão ser anunciados ao desenvolvedor e ele terá que corrigir.
• Evitar erros:
  Linter também pode evitar erros em runtime, isso irá dar uma maior confiabilidade em cada linha de código inserida.

Você também poderá inserir uma verificação no seu CI, analisando os erros apontados pelo linter e evitando o merge até que as correções sejam submetidas.

Inserindo o Linter

• Para adicionarmos o linter em nossa aplicação, será necessário criar um arquivo chamado analysis_options.yaml na raiz da nossa aplicação.
• Com o arquivo criado, você poderá inserir as regras do linter.

Pronto, sua IDE já está apta a te notificar considerando as regras adicionadas.

Obs: Dart plugin deve estar instalado na sua IDE.

Regras

Esta é a lista das regras disponíveis para que você possa utilizar. Não necessariamente você precise utilizar todas, utilize apenas as regras que fazem sentido ao seu uso e contexto.

Você também pode consultar a lista de regras suportadas contendo uma documentação demonstrando exemplos de uso como o mostrado abaixo:

always_declare_return_types
Esta regra exige que você mencione todos os tipos de retorno.

Exclude folders

Em alguns cenários você precisará que a análise do linter não seja realizada em determinadas pastas, para isto você precisará inserir tal informação no arquivo analysis.options.yaml

Quando executar o comando flutter analyze ele não mais irá verificar a pasta lib/generated. Porém o VSCode não compreendo isto e também é preciso adicionar essa informação as configurações da nossa IDE no arquivo .vscode/settings.json dentro do nosso projeto.