Генерация кода с build_runner

Некоторый код представляет собой повторяющийся шаблонный код, например разбор JSON. Генерация кода создаёт его за Вас на основе аннотаций, помогая работать быстро и без ошибок. ⚙️

Средство сборки Dart запускает генераторы кода для Вашего проекта. Оно читает исходные файлы, находит аннотации и создаёт новые файлы.

Добавьте build_runner в dev_dependencies файла pubspec.yaml, поскольку он запускается во время сборки и никогда не поставляется вместе с приложением.

Генераторы записывают результат в соседний файл. Подключите его директивой part; по соглашению его имя должно заканчиваться на .g.dart.

Запустите однократную генерацию командой build. Она просканирует ваш код и создаст или обновит все файлы .g.dart.

Во время разработки режим watch автоматически выполняет повторную генерацию после каждого сохранения. Сгенерированные файлы остаются синхронизированными без ручного повторного запуска.

Если результаты конфликтуют со старыми файлами, добавьте --delete-conflicting-outputs. Эта опция удаляет устаревшие сгенерированные файлы, чтобы новая сборка завершилась успешно.

Генераторы работают только с объявлениями, которые вы пометили аннотацией. Аннотация указывает сборщику, какой класс обработать и какой код создать.

Считайте каждый файл .g.dart доступным только для чтения. Следующая сборка перезапишет ваши изменения, поэтому вместо этого редактируйте исходный код и аннотации.

Команды могут фиксировать сгенерированные файлы в репозитории или добавить их в .gitignore и выполнять сборку в CI. В любом случае выберите одну политику и придерживайтесь её.

С build_runner работают многие пакеты, например json_serializable и freezed. Они используют общий конвейер builder, поэтому одна команда запускает их все.

Какая команда выполняет повторную генерацию кода после каждого сохранения файла?

build_runner превращает аннотации в сгенерированные файлы .g.dart. Добавьте его в dev_dependencies, запустите build или watch и никогда не редактируйте результат. 🎉