Add `flutter: config: {...}` section to `pubspec.yaml` to influence `FeatureFlags` by matanlurey · Pull Request #167953 · flutter/flutter

matanlurey · 2025-04-28T19:25:25Z

In this PR:

FlutterFeaturesConfig reads from the global config, current pubspec.yaml, and environment
FeatureFlags now delegates "was this configured" to FlutterFeaturesConfig
featureFlags (Context) now is created with knowledge of the current pubpec.yaml, if any

Once this lands and we play with it a bit (i.e. migrate disable-swift-package-manager), we can publicize it and update website documentation (it won't make it into this beta/stable release anyway).

I did a significant rewrite of feature_test, as lots of what was being tested no longer made sense.

loic-sharma · 2025-04-28T19:45:58Z

packages/flutter_tools/lib/src/flutter_features_config.dart

+  /// The value is resolved, if possible, in the following order, where if a
+  /// step resolves to a boolean value, no further steps are attempted.
+  ///
+  /// ## Environment Variable


Consider making it clearer this is an ordered list:

Suggested change

/// The value is resolved, if possible, in the following order, where if a

/// step resolves to a boolean value, no further steps are attempted.

///

/// ## Environment Variable

/// The value is resolved, if possible, in the following order, where if a

/// step resolves to a boolean value, no further steps are attempted:

///

/// ## 1. Environment Variable

loic-sharma · 2025-04-28T19:48:09Z

packages/flutter_tools/lib/src/flutter_features_config.dart

+  /// The value is resolved, if possible, in the following order, where if a
+  /// step resolves to a boolean value, no further steps are attempted.
+  ///
+  /// ## Environment Variable


In the current implementation, the environment variable has lower priority than the global config. Could we keep that order and make the local project configuration the highest priority?

loic-sharma · 2025-04-28T19:48:29Z

packages/flutter_tools/lib/src/flutter_features_config.dart

+  ///
+  /// [globalConfig] reads values stored by the `flutter config` tool, which
+  /// are normally in the user's `%HOME` directory (varies by system), while
+  /// [projectManfiest] reads values from the _current_ Flutter project's


Suggested change

/// [projectManfiest] reads values from the _current_ Flutter project's

/// [projectManifest] reads values from the _current_ Flutter project's

loic-sharma · 2025-04-28T19:52:03Z

packages/flutter_tools/test/general.shard/features_test.dart

-      expect(
-        flutterMacOSDesktopFeature.generateHelpMessage(),
-        'Enable or disable support for desktop on macOS.',
+    testWithoutContext('reads from configuration if avaialble', () {


Suggested change

testWithoutContext('reads from configuration if avaialble', () {

testWithoutContext('reads from configuration if available', () {

loic-sharma · 2025-04-28T19:52:25Z

packages/flutter_tools/test/commands.shard/hermetic/config_test.dart

      );
    }, overrides: <Type, Generator>{Analytics: () => fakeAnalytics});
+
+    testUsingContext('overriden by the content in pubspec.yaml', () async {});


Looks like this can be deleted

loic-sharma

Looks good overall, one open question on ordering

matanlurey · 2025-04-28T20:00:18Z

Thanks for the review! Will come back to this shortly, agree on changes.

bkonyi

LGTM once @loic-sharma's comments are addressed.

bkonyi · 2025-04-28T20:24:49Z

packages/flutter_tools/test/general.shard/features_config_test.dart

+  });
+}
+
+const Feature _noConfigFeature = Feature(name: 'example');


Ubernit: should these constants be top of file for readability?

bkonyi · 2025-04-28T20:27:27Z

packages/flutter_tools/test/general.shard/features_test.dart

    });

-    /// Flutter Web
+    FileSystem createFsWithPubspec(String pubspec) {


Nit: Since we're only using this in one place, can we instead hardcode the contents of pubspec here and not take a parameter? That way it's obvious what the contents of the pubspec are without scrolling to the bottom of the test.

…luence `FeatureFlags` (flutter/flutter#167953)

loic-sharma · 2025-04-29T19:12:28Z

packages/flutter_tools/lib/src/flutter_features.dart

-    }
-    return isEnabled;
+
+    // Otherwise, read it from environment variable > project manifest > global config


FYI this comment is stale

…luence `FeatureFlags` (flutter/flutter#167953)

added missing '/' https://github.comflutter/flutter/pull/167953 => flutter/flutter#167953

…luence `FeatureFlags` (flutter/flutter#167953)

…FeatureFlags` (flutter#167953) Closes flutter#167667. In this PR: - `FlutterFeaturesConfig` reads from the global config, current pubspec.yaml, and environment - `FeatureFlags` now delegates "was this configured" to `FlutterFeaturesConfig` - `featureFlags` (`Context`) now is created with knowledge of the current `pubpec.yaml`, if any Once this lands and we play with it a bit (i.e. migrate `disable-swift-package-manager`), we can publicize it and update website documentation (it won't make it into this beta/stable release anyway). I did a significant rewrite of `feature_test`, as lots of what was being tested no longer made sense.

…luence `FeatureFlags` (flutter/flutter#167953)

#12925) ## Description Updates the Swift Package Manager documentation to use the new `flutter: config:` section format for pubspec.yaml configuration, replacing the deprecated `disable-swift-package-manager` field. ## Changes **File:** `src/_includes/docs/swift-package-manager/how-to-enable-disable.md` ### Before (deprecated) ```yaml flutter: disable-swift-package-manager: true ``` ### After (current) ```yaml flutter: config: enable-swift-package-manager: false ``` ## Additional Changes - Added a migration note to help users who were using the deprecated syntax - The note explains that the old syntax produces an error in Flutter 3.38 and later ## Context This change aligns the Swift Package Manager documentation with: - The [pubspec options documentation](https://docs.flutter.dev/tools/pubspec) which already uses the new syntax - [flutter/flutter#168433](flutter/flutter#168433) which moved the config to the `config` section - [flutter/flutter#167953](flutter/flutter#167953) which introduced the `flutter: config:` section ## Testing - Verified the new syntax matches what's documented in `src/content/tools/pubspec.md` - Confirmed the markdown formatting follows existing patterns in the file ## Related Issues Fixes #12924 ## Pre-launch Checklist - [x] I read the [Contributor Guide](https://github.com/flutter/website/blob/main/CONTRIBUTING.md) - [x] I signed the [CLA](https://cla.developers.google.com/clas) - [x] I listed at least one issue that this PR fixes in the description above

Write tests.

0e6654b

matanlurey requested review from bkonyi and loic-sharma April 28, 2025 19:25

github-actions bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Apr 28, 2025

loic-sharma reviewed Apr 28, 2025

View reviewed changes

bkonyi approved these changes Apr 28, 2025

View reviewed changes

Apply suggestions, tweaks.

79ad51e

matanlurey added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 28, 2025

auto-submit bot added this pull request to the merge queue Apr 28, 2025

Merged via the queue into flutter:master with commit f94a82d Apr 29, 2025
143 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Apr 29, 2025

engine-flutter-autoroll mentioned this pull request Apr 29, 2025

Roll Flutter from cfb887cd5f41 to 04616f8dde3f (137 revisions) flutter/packages#9172

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 29, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

11b534f

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll mentioned this pull request Apr 29, 2025

Roll Flutter from cfb887cd5f41 to a46bf190ef7d (138 revisions) flutter/packages#9173

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 29, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

66e670b

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll mentioned this pull request Apr 29, 2025

Roll Flutter from cfb887cd5f41 to a46bf190ef7d (138 revisions) flutter/packages#9174

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 29, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

4de3f15

…luence `FeatureFlags` (flutter/flutter#167953)

loic-sharma reviewed Apr 29, 2025

View reviewed changes

engine-flutter-autoroll mentioned this pull request Apr 30, 2025

Roll Flutter from cfb887cd5f41 to fffe394cdd2d (158 revisions) flutter/packages#9179

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 30, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

fe83b14

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll mentioned this pull request Apr 30, 2025

Roll Flutter from cfb887cd5f41 to fffe394cdd2d (158 revisions) flutter/packages#9180

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 30, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

e29aaa7

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 1, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

e00d269

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

bd1b4bf

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

5228a5a

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

6f84c68

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

68b95dd

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

bba14ff

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

5d548ed

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

c82d27e

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 5, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

ce4446a

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 6, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

bd56ea8

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 6, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

f0e1c51

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 6, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

a3d1d98

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 6, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

b850888

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 7, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

b4f068f

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 7, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

7ca70a8

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 7, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

9cb11de

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 7, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

5746eec

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 7, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

80d9677

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 7, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

ed2334c

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 7, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

cafe91e

…luence `FeatureFlags` (flutter/flutter#167953)

mg3994 added a commit to mg3994/website that referenced this pull request May 22, 2025

fixed Broken Link

06d35a8

added missing '/' https://github.comflutter/flutter/pull/167953 => flutter/flutter#167953

mg3994 mentioned this pull request May 22, 2025

Fix broken GitHub URL by adding missing slash flutter/website#12056

Merged

4 tasks

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

eb07a48

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

e244a01

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

d4fa72b

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

10f0eb9

…luence `FeatureFlags` (flutter/flutter#167953)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 16, 2025

f94a82d Add flutter: config: {...} section to pubspec.yaml to inf…

0e3e200

…luence `FeatureFlags` (flutter/flutter#167953)

This was referenced Jan 13, 2026

Swift Package Manager docs use deprecated pubspec.yaml syntax flutter/website#12924

Closed

Update Swift Package Manager pubspec.yaml syntax to use config section flutter/website#12925

Merged

	/// [projectManfiest] reads values from the _current_ Flutter project's
	/// [projectManifest] reads values from the _current_ Flutter project's

	testWithoutContext('reads from configuration if avaialble', () {
	testWithoutContext('reads from configuration if available', () {

Conversation

matanlurey commented Apr 28, 2025

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

loic-sharma left a comment

Choose a reason for hiding this comment

Uh oh!

matanlurey commented Apr 28, 2025

Uh oh!

bkonyi 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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants