Escrevendo um bom exemplo de código

Escrever um bom exemplo de código é difícil. Aprenda princípios práticos para escrever código Flutter focado, legível e fácil de manter.

Escrever um bom código de exemplo é difícil. Deixe-me esclarecer: montar um exemplo que demonstra o uso de uma API, ou mostra um idioma de UI, pode ser rápido e fácil. A dificuldade vem das peças adicionais que você precisa acrescentar ao seu repositório para manter o código de exemplo atualizado e atraente para seus desenvolvedores.

A primeira coisa a acrescentar ao seu código é um bom README que comece com um resumo do motivo pelo qual um desenvolvedor deve investir tempo e esforço para investigar e entender o exemplo. Em seguida, instruções de uso e links para um rastreador de issues, onde os desenvolvedores possam relatar bugs e pedir esclarecimentos caso algo esteja confuso, são um ótimo próximo passo.

Em seguida, o próprio código. O código segue as convenções de layout e uso? Isso pode ser tão simples quanto onde o código fica, ou tão complexo quanto configurações adequadas para linters e afins. Gosto de linguagens de programação da comunidade que adotaram um padrão forte de formatação de código, layout e conjuntos de regras de lint. Esses padrões trazem conformidade à aparência e ao comportamento do código, o que facilita a navegação. Para aplicar a formatação de código em Dart e Flutter, você pode adicionar o seguinte comando ao seu pipeline de CI para falhar o build caso ele não esteja formatado corretamente:

bash
$ dart format --output none --set-exit-if-changed .

Depois da formatação de código, o próximo passo é aplicar um bom conjunto de lints. Para Dart, recomendo muito conhecer o pacote lints e, para Flutter, recomendo igualmente o pacote flutter_lints. Para garantir que os lints passem no pipeline de CI, adicione o seguinte comando:

bash
$ dart analyze

Testes. Ah, quantos testes. Testes unitários, testes de integração e, no caso do Flutter, também temos os testes de widget. Testes são ótimos para samples, porque comunicam a intenção de como um trecho de código deve ser usado. Os testes também mantêm a base de código sempre atualizada, quando usados em conjunto com o pipeline de CI mencionado anteriormente. Um bom lugar para aprender mais sobre a capacidade de testes do Flutter é o codelab Como testar um app Flutter. Os comandos de CI para Dart e Flutter, respectivamente:

bash
$ flutter test   # for Flutter projects
$ dart test      # for pure Dart projects

Se o seu repositório de código está hospedado no GitHub, eu sugiro que você use a action Dart Setup se você tem um projeto Dart, e a Flutter Action se você tem um projeto Flutter. Como pontos extras, considere adicionar a action Very Good Coverage para manter a cobertura de testes alta. Já que você chegou até aqui, provavelmente deveria divulgar o status do seu CI com um badge de status do workflow.

Espero que a lista de adições acima ajude você a tornar o seu código de exemplo muito mais valioso para o seu público-alvo.

Mais do Flutter