flutter/dev/tools/gen_defaults
Michael Goderbauer b966b2beee
Enable private field promotion for dev (#134480)
New feature in upcoming Dart 3.2. See https://github.com/dart-lang/language/issues/2020. Feature is enabled by bumping the min SDK version to 3.2.

Part of https://github.com/flutter/flutter/issues/134476.
2023-09-12 18:29:00 +00:00
..
bin Add support for M3 motion (#129942) 2023-07-19 22:07:59 +02:00
data Run dart command to update widget defaults (#122557) 2023-03-15 18:53:29 +01:00
generated Fix Scrollable TabBar for Material 3 (#131409) 2023-08-02 00:48:06 +00:00
lib Add cancelButtonStyle & confirmButtonStyle to the DatePickerThemeData (#132847) 2023-08-30 21:16:13 +00:00
test Improve defaults generation with logging, stats, and token validation (#128244) 2023-06-09 11:28:18 +00:00
pubspec.yaml Enable private field promotion for dev (#134480) 2023-09-12 18:29:00 +00:00
README.md Improve defaults generation with logging, stats, and token validation (#128244) 2023-06-09 11:28:18 +00:00
test.json Improve defaults generation with logging, stats, and token validation (#128244) 2023-06-09 11:28:18 +00:00

Token Defaults Generator

Script that generates component theme data defaults based on token data.

Usage

Run this program from the root of the git repository:

dart dev/tools/gen_defaults/bin/gen_defaults.dart [-v]

This updates generated/used_tokens.csv and the various component theme files.

Templates

There is a template file for every component that needs defaults from the token database. These templates are implemented as subclasses of TokenTemplate. This base class provides some utilities and a structure for adding a new block of generated code to the bottom of a given file.

Templates need to override the generate method to provide the generated code block as a string.

See lib/fab_template.dart for an example that generates defaults for the Floating Action Button.

Tokens

Tokens are stored in JSON files in data/, and are sourced from an internal Google database.

template.dart should provide nearly all useful token resolvers (e.g. color, shape, etc.). For special cases in which one shouldn't be defined, use getToken to get the raw token value. The script, through the various revolvers and getToken, validates tokens, keeps track of which tokens are used, and generates generated/used_tokens.csv.