Generación de código con build_runner

Parte del código es código repetitivo, como el análisis de JSON. La Code generation lo escribe por usted a partir de anotaciones, para que trabaje con precisión y rapidez. ⚙️

build_runner es la herramienta de Dart que ejecuta generadores de código en su proyecto. Lee los archivos de código fuente, encuentra anotaciones y genera archivos nuevos.

Debe añadir build_runner en dev_dependencies de pubspec.yaml, porque se ejecuta durante la compilación y nunca se incluye en la aplicación.

Los generadores escriben en un archivo hermano. Puede vincularlo mediante una directiva part, cuyo nombre termina convencionalmente en .g.dart.

Inicie una generación puntual con el comando build. Este analiza el código y crea o actualiza todos los archivos .g.dart.

Durante el desarrollo, el modo watch vuelve a generar los archivos automáticamente cada vez que guarda. Así, los archivos generados se mantienen sincronizados sin tener que volver a ejecutar el comando manualmente.

Si los resultados entran en conflicto con archivos antiguos, añada --delete-conflicting-outputs. Esto elimina los archivos generados obsoletos para que la compilación nueva pueda completarse.

Los generadores solo actúan sobre las declaraciones que usted annotate. La anotación indica al compilador qué clase debe procesar y qué código debe producir.

Trate todos los archivos .g.dart como read-only. La siguiente compilación sobrescribirá sus cambios, así que modifique el código fuente y las anotaciones.

Los equipos pueden elegir entre confirmar los archivos generados o añadirlos a .gitignore y volver a generarlos en CI. En cualquier caso, elija una política y manténgala de forma coherente.

Muchos paquetes se integran con build_runner, como json_serializable y freezed. Todos comparten una canalización de builder, por lo que un solo comando los ejecuta.

¿Qué comando vuelve a generar el código cada vez que guarda un archivo?

build_runner convierte las anotaciones en archivos .g.dart generados. Añádalo a dev_dependencies, ejecute build o watch y no edite nunca el resultado. 🎉