Génération de code avec build_runner

Certains codes sont répétitifs, comme l'analyse de JSON. La génération de code l'écrit pour vous à partir des annotations, afin que vous restiez précis et rapide. ⚙️

build_runner est l'outil de Dart qui exécute les générateurs de code sur votre projet. Il lit les fichiers sources, trouve les annotations et produit de nouveaux fichiers.

Vous ajoutez build_runner sous dev_dependencies dans pubspec.yaml, car il s’exécute au moment de la compilation et n’est jamais distribué avec votre application.

Les générateurs écrivent dans un fichier associé. Vous le reliez à l’aide d’une directive part dont le nom se termine, par convention, par .g.dart.

Déclenchez une génération ponctuelle avec la commande build. Elle parcourt votre code et crée ou actualise chaque fichier .g.dart.

Pendant le développement, le mode watch régénère automatiquement le code chaque fois que vous enregistrez vos modifications. Il maintient les fichiers générés à jour sans relance manuelle.

Si les sorties entrent en conflit avec d’anciens fichiers, ajoutez --delete-conflicting-outputs. Cette option supprime les fichiers générés obsolètes afin que la nouvelle compilation puisse réussir.

Les générateurs agissent uniquement sur les déclarations que vous annotez. L’annotation indique au générateur quelle classe traiter et quel code produire.

Considérez chaque fichier .g.dart comme en lecture seule. La prochaine compilation écrasera vos modifications : modifiez donc plutôt le code source et les annotations.

Les équipes choisissent de valider les fichiers générés ou de les ajouter à .gitignore et de les régénérer dans l’intégration continue. Dans les deux cas, choisissez une règle et respectez-la.

De nombreux paquets s’intègrent à build_runner, comme json_serializable et freezed. Ils partagent un même générateur, si bien qu’une seule commande les exécute tous.

Quelle commande régénère le code à chaque enregistrement d’un fichier ?

build_runner transforme les annotations en fichiers .g.dart générés. Ajoutez-le à dev_dependencies, lancez build ou watch et ne modifiez jamais la sortie. 🎉