[google_fonts] Extract the config class to its own file in prevision of a GoogleFontsLite version by TheCarpetMerchant · Pull Request #11602 · flutter/packages

TheCarpetMerchant · 2026-04-29T14:38:20Z

See #11433 and the comment #11433 (review)

…of a GoogleFontsLite version

flutter-dashboard · 2026-04-29T14:38:24Z

It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

gemini-code-assist

Code Review

This pull request refactors the configuration logic by moving the Config class to a new file, google_fonts_config.dart, and renaming it to GoogleFontsConfig. Feedback indicates that this rename is a breaking change and suggests adding a deprecated typedef for Config to maintain backward compatibility.

gemini-code-assist · 2026-04-29T14:39:47Z

+class GoogleFontsConfig {
+  /// Whether or not the GoogleFonts library can make requests to
+  /// [fonts.google.com](https://fonts.google.com/) to retrieve font files.
+  bool allowRuntimeFetching = true;
+
+  /// The HTTP client used to fetch fonts.
+  ///
+  /// If this is null, a shared default [http.Client] will be used.
+  ///
+  /// If you supply a client, you are responsible for closing it.
+  http.Client? httpClient;
+}


Renaming the Config class to GoogleFontsConfig is a breaking change for any users who have explicitly typed the GoogleFonts.config object in their code.

To maintain backward compatibility while adopting the more specific name, consider adding a deprecated typedef for Config. Additionally, ensure that GoogleFontsConfig (and the typedef) is exported from the package's public API (e.g., lib/google_fonts.dart), as GoogleFonts.config is a public field and its type should be accessible to consumers.

Suggested change

class GoogleFontsConfig {

/// Whether or not the GoogleFonts library can make requests to

/// [fonts.google.com](https://fonts.google.com/) to retrieve font files.

bool allowRuntimeFetching = true;

/// The HTTP client used to fetch fonts.

///

/// If this is null, a shared default [http.Client] will be used.

///

/// If you supply a client, you are responsible for closing it.

http.Client? httpClient;

}

class GoogleFontsConfig {

/// Whether or not the GoogleFonts library can make requests to

/// [fonts.google.com](https://fonts.google.com/) to retrieve font files.

bool allowRuntimeFetching = true;

/// The HTTP client used to fetch fonts.

///

/// If this is null, a shared default [http.Client] will be used.

///

/// If you supply a client, you are responsible for closing it.

http.Client? httpClient;

}

/// Deprecated. Use [GoogleFontsConfig] instead.

@Deprecated('Use GoogleFontsConfig instead')

typedef Config = GoogleFontsConfig;

These are good points. We should try to avoid a breaking change unless absolutely necessary, and in order to allow users to access this class, it should be exported.

This just clutters the namespace for nothing, especially with such a common name as "Config".
The only purpose of the class was to be a clear separation between configuration fields and the rest of the GoogleFonts class, there is no utility to developers having their own instance for other purposes (again, especially with this unfortunate "Config" name). As a dev I would rather not have this in my namespace and I see removing it as an improvement.

Still, if you'd rather not have a breaking change I'll export the google_fonts_config file. It really does seem like a negative to me though.

Thanks for the explanation! I agree that Config is a very generic name and renaming it to GoogleFontsConfig is a solid improvement to avoid cluttering the namespace.

However, we still need to export GoogleFontsConfig because otherwise, developers cannot reference the type directly (e.g., they won't be able to write GoogleFontsConfig cfg = GoogleFonts.config; or pass it to configuration helper functions).

Since we recently bumped the major version, using a deprecation path is best to avoid churn on the ecosystem. We can expose a deprecated typedef in google_fonts_config.dart and export it in lib/google_fonts.dart. We can then clean up and remove this deprecation in a future major version bump.

@Deprecated('Use GoogleFontsConfig instead') typedef Config = GoogleFontsConfig;

What do you think about using this deprecation path?

Piinks · 2026-05-15T23:11:55Z

+class GoogleFontsConfig {
+  /// Whether or not the GoogleFonts library can make requests to
+  /// [fonts.google.com](https://fonts.google.com/) to retrieve font files.
+  bool allowRuntimeFetching = true;
+
+  /// The HTTP client used to fetch fonts.
+  ///
+  /// If this is null, a shared default [http.Client] will be used.
+  ///
+  /// If you supply a client, you are responsible for closing it.
+  http.Client? httpClient;
+}


These are good points. We should try to avoid a breaking change unless absolutely necessary, and in order to allow users to access this class, it should be exported.

Piinks · 2026-05-15T23:12:31Z

Thank you for putting this together to make #11433 more robust!

Piinks

Thanks for the updates! This needs the pubspec and changelog updated in order to merge.

Piinks · 2026-06-23T21:09:27Z

+@Deprecated('Use GoogleFontsConfig instead')
+typedef Config = GoogleFontsConfig;


This will still need a public doc comment on it to pass analysis:

/// Deprecated. Use [GoogleFontsConfig] instead.

This documentation is still needed.

TheCarpetMerchant · 2026-06-23T21:38:53Z

Thanks for the updates! This needs the pubspec and changelog updated in order to merge.

I can update the changelog, but I'm unsure of what you would want changed in the pubspec ?

Piinks · 2026-06-23T23:23:10Z

You'll have to bump the package version in the pubspec so we can release it.

TheCarpetMerchant · 2026-06-29T06:14:02Z

You'll have to bump the package version in the pubspec so we can release it.

Ah, I was thinking of waiting for the GoogleFontsLite commit to make a release. Making one for just a change in which file hosts a particular class doesn't seem very useful ?

Piinks · 2026-06-30T16:42:54Z

You'll have to bump the package version in the pubspec so we can release it.

Ah, I was thinking of waiting for the GoogleFontsLite commit to make a release. Making one for just a change in which file hosts a particular class doesn't seem very useful ?

It does. This changes the public API. We don't batch changes for releases of this package.

TheCarpetMerchant · 2026-07-02T10:35:46Z

You'll have to bump the package version in the pubspec so we can release it.

Ah, I was thinking of waiting for the GoogleFontsLite commit to make a release. Making one for just a change in which file hosts a particular class doesn't seem very useful ?

It does. This changes the public API. We don't batch changes for releases of this package.

Done

Piinks

Hi @TheCarpetMerchant thanks for updating the pubspec and the changelog. This isn't quite ready to merge yet. Would you like me to finish up the small bits that remain so we can get this merged and unblock the other PR? I want to respect your time and feel like we have been going back and forth over some small final things to make this ready. Let me know, happy to get this in finally.

Piinks · 2026-07-06T15:50:57Z

@@ -1,3 +1,7 @@
+## 8.2.0
+
+- Extract the class `Config` to its own file and rename it `GoogleFontsConfig`. The `Config` name will be deprecated in a future release.


It is deprecated though in this change, isn't it?

Suggested change

- Extract the class `Config` to its own file and rename it `GoogleFontsConfig`. The `Config` name will be deprecated in a future release.

- Extract the class `Config` to its own file and rename it `GoogleFontsConfig`. The `Config` class is now deprecated.

Piinks · 2026-07-06T15:51:10Z

+@Deprecated('Use GoogleFontsConfig instead')
+typedef Config = GoogleFontsConfig;


This documentation is still needed.

TheCarpetMerchant · 2026-07-06T16:12:29Z

Hi @TheCarpetMerchant thanks for updating the pubspec and the changelog. This isn't quite ready to merge yet. Would you like me to finish up the small bits that remain so we can get this merged and unblock the other PR? I want to respect your time and feel like we have been going back and forth over some small final things to make this ready. Let me know, happy to get this in finally.

Sure go ahead. I'll take a look to know what to do next time.
Feel free to squash this to a single commit as well

Piinks · 2026-07-14T23:16:23Z

It looks like I do not have permissions to push to the PR, so I am going to close it to re-open as a fresh PR and get this in to unblock the other change: #12202

[google_fonts] Extract the config class to its own file in prevision …

91027e4

…of a GoogleFontsLite version

github-actions Bot added p: google_fonts triage-framework Should be looked at in framework triage labels Apr 29, 2026

TheCarpetMerchant mentioned this pull request Apr 29, 2026

[google_fonts] Add google_fonts_lite file to allow tree-shaking of the other huge files #11433

Open

gemini-code-assist Bot reviewed Apr 29, 2026

View reviewed changes

stuartmorgan-g requested a review from Piinks May 5, 2026 18:20

Piinks requested changes May 15, 2026

View reviewed changes

TheCarpetMerchant added 2 commits May 18, 2026 08:12

[google_fonts] Add missing license header to google_fonts_config

0a33c95

[google_fonts] Add a typedef for Config and export it, to be deprecated

c4d3235

Piinks reviewed Jun 23, 2026

View reviewed changes

[google_fonts] bump to 8.2.0

aaeb7d6

Piinks reviewed Jul 6, 2026

View reviewed changes

Piinks closed this Jul 14, 2026

		@Deprecated('Use GoogleFontsConfig instead')
		typedef Config = GoogleFontsConfig;

		@@ -1,3 +1,7 @@
		## 8.2.0

		- Extract the class `Config` to its own file and rename it `GoogleFontsConfig`. The `Config` name will be deprecated in a future release.

Uh oh!

Conversation

TheCarpetMerchant commented Apr 29, 2026

Uh oh!

flutter-dashboard Bot commented Apr 29, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Piinks commented May 15, 2026

Uh oh!

Piinks left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TheCarpetMerchant commented Jun 23, 2026

Uh oh!

Piinks commented Jun 23, 2026

Uh oh!

TheCarpetMerchant commented Jun 29, 2026

Uh oh!

Piinks commented Jun 30, 2026

Uh oh!

TheCarpetMerchant commented Jul 2, 2026

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TheCarpetMerchant commented Jul 6, 2026

Uh oh!

Piinks commented Jul 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Piinks left a comment •

edited

Loading