flutter/dev/tools/gen_defaults
Gray Mackall cad7418f0a
Roll packages manually (#155786)
*Replace this paragraph with a description of what this PR is changing or adding, and why. Consider including before/after screenshots.*

*List which issues are fixed by this PR. You must list at least one issue. An issue is not required if the PR fixes something trivial like a typo.*

*If you had to change anything in the [flutter/tests] repo, include a link to the migration guide as per the [breaking change policy].*
2024-09-27 00:49:08 +00:00
..
bin Update tokens to 4.0.0 (#148789) 2024-05-22 15:08:25 +00:00
data Update tokens to v6.1 (#153722) 2024-09-04 00:20:16 +00:00
generated Update tokens to v6.1 (#153722) 2024-09-04 00:20:16 +00:00
lib Reverts "Normalize TabBarTheme (#155476)" (#155698) 2024-09-25 17:50:18 +00:00
test Fix gen_defaults test randomness (#142743) 2024-02-01 21:22:51 +00:00
dart_test.yaml Really disable shuffling for gen_defaults tests (#142721) 2024-02-01 10:09:07 -08:00
pubspec.yaml Roll packages manually (#155786) 2024-09-27 00:49:08 +00:00
README.md Added missing code block language in docs (#147481) 2024-05-01 14:44:27 +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.