Kodgenerering med build_runner

Viss kod är upprepad standardkod, till exempel JSON-parsning. Code generation skriver den åt er utifrån annoteringar, så att ni kan arbeta korrekt och snabbt. ⚙️

build_runner är Darts verktyg för att köra kodgeneratorer i projektet. Det läser källfiler, hittar annoteringar och skapar nya filer.

Du lägger till build_runner under dev_dependencies i pubspec.yaml eftersom det körs vid byggtillfället och aldrig skickas med din app.

Generatorer skriver till en fil bredvid källfilen. Du länkar till den med ett part-direktiv vars namn enligt konvention slutar på .g.dart.

Starta en engångsgenerering med kommandot build. Det genomsöker din kod och skapar eller uppdaterar alla .g.dart-filer.

Under utvecklingen återskapar läget watch automatiskt filerna varje gång du sparar. Det håller de genererade filerna synkroniserade utan manuella omkörningar.

Om utdata krockar med gamla filer lägger du till --delete-conflicting-outputs. Det rensar inaktuella genererade filer så att det nya bygget kan lyckas.

Generatorer arbetar bara med deklarationer som du annotate. Anteckningen talar om för byggverktyget vilken klass som ska behandlas och vilken kod som ska skapas.

Behandla alla .g.dart-filer som read-only. Nästa bygge skriver över dina ändringar, så redigera källan och anteckningarna i stället.

Team väljer antingen att checka in genererade filer eller lägga till dem i .gitignore och bygga om i CI. Oavsett vilket bör ni välja en strategi och följa den konsekvent.

Många paket ansluter till build_runner, till exempel json_serializable och freezed. De delar en gemensam builder-pipeline, så ett enda kommando kör dem alla.

build_runner omvandlar anteckningar till genererade .g.dart-filer. Lägg till det i dev_dependencies, kör build eller watch och redigera aldrig utdatafilerna. 🎉