Geração de Código com build_runner

Alguns códigos são repetitivos, como a análise de JSON. A geração de código os escreve para você a partir de anotações, ajudando a manter a precisão e a rapidez. ⚙️

build_runner é a ferramenta do Dart que executa geradores de código no seu projeto. Ela lê arquivos-fonte, encontra anotações e emite novos arquivos.

Adicione build_runner em dev_dependencies no pubspec.yaml, pois ele é executado durante a compilação e nunca é enviado com seu aplicativo.

Os geradores escrevem em um arquivo irmão. Você o vincula com uma diretiva part, cujo nome termina convencionalmente em .g.dart.

Inicie uma geração única com o comando build. Ele examina seu código e cria ou atualiza todos os arquivos .g.dart.

Durante o desenvolvimento, o modo watch gera novamente os arquivos automaticamente sempre que você salva. Assim, os arquivos gerados permanecem sincronizados sem novas execuções manuais.

Se os resultados entrarem em conflito com arquivos antigos, adicione --delete-conflicting-outputs. Isso remove os arquivos gerados obsoletos para que a nova compilação seja concluída.

Os geradores só atuam sobre declarações que você anota. A anotação informa ao compilador qual classe deve ser processada e qual código deve ser produzido.

Trate todo arquivo .g.dart como somente leitura. A próxima compilação substituirá suas alterações; portanto, edite o código-fonte e as anotações.

As equipes escolhem entre confirmar os arquivos gerados ou adicioná-los ao .gitignore e reconstruí-los na CI. De qualquer forma, escolha uma política e mantenha a consistência.

Muitos pacotes se integram ao build_runner, como json_serializable e freezed. Eles compartilham um builder de compilação, portanto um único comando executa todos.

Qual comando gera o código novamente a cada salvamento de arquivo?

O build_runner transforma anotações em arquivos .g.dart gerados. Adicione-o a dev_dependencies, execute build ou watch e nunca edite o resultado. 🎉