✨ flutter config --list (flutter#135401)

Resolves flutter#81831.

The PR improves the `config` command in below ways:
- Does not print the settings in usages or other options.
- Adds the `--list` flag to print the full settings list.
- Separates usages for settings and analytics.
- Prints the restart tip when clearing features.

Update editable_text.dart

change property name

fix text_field.dart

fix editable_text.dart

fix editable_text.dart

fix text_field_test.dart

Update editable_text.dart

Update text_field_test.dart

Author: AlexV525

packages/flutter/lib/src/cupertino/text_field.dart

@@ -285,7 +285,7 @@ class CupertinoTextField extends StatefulWidget {
     this.contextMenuBuilder = _defaultContextMenuBuilder,
     this.spellCheckConfiguration,
     this.magnifierConfiguration,
-    this.canTapOutsideFocus = true,
+    this.onTapOutsideRequiresFocus = false,
   }) : assert(obscuringCharacter.length == 1),
        smartDashesType = smartDashesType ?? (obscureText ? SmartDashesType.disabled : SmartDashesType.enabled),
        smartQuotesType = smartQuotesType ?? (obscureText ? SmartQuotesType.disabled : SmartQuotesType.enabled),
@@ -412,7 +412,7 @@ class CupertinoTextField extends StatefulWidget {
     this.contextMenuBuilder = _defaultContextMenuBuilder,
     this.spellCheckConfiguration,
     this.magnifierConfiguration,
-    this.canTapOutsideFocus = true,
+    this.onTapOutsideRequiresFocus = false,
   }) : assert(obscuringCharacter.length == 1),
        smartDashesType = smartDashesType ?? (obscureText ? SmartDashesType.disabled : SmartDashesType.enabled),
        smartQuotesType = smartQuotesType ?? (obscureText ? SmartQuotesType.disabled : SmartQuotesType.enabled),
@@ -815,8 +815,8 @@ class CupertinoTextField extends StatefulWidget {
   /// {@macro flutter.widgets.undoHistory.controller}
   final UndoHistoryController? undoController;
 
-  /// {@macro flutter.widgets.editableText.canTapOutsideFocus}
-  final bool canTapOutsideFocus;
+  /// {@macro flutter.widgets.editableText.onTapOutsideRequiresFocus}
+  final bool onTapOutsideRequiresFocus;
 
   @override
   State<CupertinoTextField> createState() => _CupertinoTextFieldState();

packages/flutter/lib/src/material/text_field.dart

@@ -311,7 +311,7 @@ class TextField extends StatefulWidget {
     this.canRequestFocus = true,
     this.spellCheckConfiguration,
     this.magnifierConfiguration,
-    this.canTapOutsideFocus = true,
+    this.onTapOutsideRequiresFocus = false,
   }) : assert(obscuringCharacter.length == 1),
        smartDashesType = smartDashesType ?? (obscureText ? SmartDashesType.disabled : SmartDashesType.enabled),
        smartQuotesType = smartQuotesType ?? (obscureText ? SmartQuotesType.disabled : SmartQuotesType.enabled),
@@ -776,8 +776,8 @@ class TextField extends StatefulWidget {
   /// {@macro flutter.widgets.undoHistory.controller}
   final UndoHistoryController? undoController;
 
-  /// {@macro flutter.widgets.editableText.canTapOutsideFocus}
-  final bool canTapOutsideFocus;
+  /// {@macro flutter.widgets.editableText.onTapOutsideRequiresFocus}
+  final bool onTapOutsideRequiresFocus;
 
   static Widget _defaultContextMenuBuilder(BuildContext context, EditableTextState editableTextState) {
     return AdaptiveTextSelectionToolbar.editableText(
@@ -1436,7 +1436,7 @@ class _TextFieldState extends State<TextField> with RestorationMixin implements
           contextMenuBuilder: widget.contextMenuBuilder,
           spellCheckConfiguration: spellCheckConfiguration,
           magnifierConfiguration: widget.magnifierConfiguration ?? TextMagnifier.adaptiveMagnifierConfiguration,
-          canTapOutsideFocus: widget.canTapOutsideFocus,
+          onTapOutsideRequiresFocus: widget.onTapOutsideRequiresFocus,
         ),
       ),
     );

packages/flutter/lib/src/material/text_form_field.dart

@@ -169,7 +169,7 @@ class TextFormField extends FormField<String> {
     Clip clipBehavior = Clip.hardEdge,
     bool scribbleEnabled = true,
     bool canRequestFocus = true,
-    bool canTapOutsideFocus = true,
+    bool onTapOutsideRequiresFocus = false,
   }) : assert(initialValue == null || controller == null),
        assert(obscuringCharacter.length == 1),
        assert(maxLines == null || maxLines > 0),
@@ -260,7 +260,7 @@ class TextFormField extends FormField<String> {
                clipBehavior: clipBehavior,
                scribbleEnabled: scribbleEnabled,
                canRequestFocus: canRequestFocus,
-               canTapOutsideFocus: canTapOutsideFocus,
+               onTapOutsideRequiresFocus: onTapOutsideRequiresFocus,
              ),
            );
          },

packages/flutter/lib/src/widgets/editable_text.dart

@@ -811,7 +811,7 @@ class EditableText extends StatefulWidget {
     this.spellCheckConfiguration,
     this.magnifierConfiguration = TextMagnifierConfiguration.disabled,
     this.undoController,
-    this.canTapOutsideFocus = true,
+    this.onTapOutsideRequiresFocus = false,
   }) : assert(obscuringCharacter.length == 1),
        smartDashesType = smartDashesType ?? (obscureText ? SmartDashesType.disabled : SmartDashesType.enabled),
        smartQuotesType = smartQuotesType ?? (obscureText ? SmartQuotesType.disabled : SmartQuotesType.enabled),
@@ -1402,8 +1402,9 @@ class EditableText extends StatefulWidget {
 
   /// {@template flutter.widgets.editableText.onTapOutside}
   /// Called for each tap that occurs outside of the [TextFieldTapRegion] group
-  /// when [canTapOutsideFocus] is set to true.
-  /// When [canTapOutsideFocus] is set to false, this method will be called only
+  /// when [onTapOutsideRequiresFocus] is set to false.
+  ///
+  /// When [onTapOutsideRequiresFocus] is set to true, this method will be called only
   /// when the text field is focused.
   ///
   /// If this is null, [FocusNode.unfocus] will be called on the [focusNode] for
@@ -1848,12 +1849,12 @@ class EditableText extends StatefulWidget {
   /// {@macro flutter.widgets.magnifier.TextMagnifierConfiguration.details}
   final TextMagnifierConfiguration magnifierConfiguration;
 
-  /// {@template flutter.widgets.editableText.canTapOutsideFocus}
+  /// {@template flutter.widgets.editableText.onTapOutsideRequiresFocus}
   /// Determine whether [onTapOutside] is called when this widget is not focused.
   ///
-  /// Defaults to true.
+  /// Defaults to false.
   /// {@endtemplate}
-  final bool canTapOutsideFocus;
+  final bool onTapOutsideRequiresFocus;
 
   bool get _userSelectionEnabled => enableInteractiveSelection && (!readOnly || !obscureText);
 
@@ -4781,7 +4782,7 @@ class EditableTextState extends State<EditableText> with AutomaticKeepAliveClien
       compositeCallback: _compositeCallback,
       enabled: _hasInputConnection,
       child: TextFieldTapRegion(
-        onTapOutside: _hasFocus || widget.canTapOutsideFocus ? widget.onTapOutside ?? _defaultOnTapOutside : null,
+        onTapOutside: _hasFocus || !widget.onTapOutsideRequiresFocus ? widget.onTapOutside ?? _defaultOnTapOutside : null,
         debugLabel: kReleaseMode ? null : 'EditableText',
         child: MouseRegion(
           cursor: widget.mouseCursor ?? SystemMouseCursors.text,

packages/flutter/test/material/text_field_test.dart

@@ -16893,7 +16893,7 @@ void main() {
                 TextField(
                   autofocus: true,
                   focusNode: focusNodeA,
-                  canTapOutsideFocus: false,
+                  onTapOutsideRequiresFocus: true,
                   onTapOutside: (PointerDownEvent event) {
                     timesTriggered += 1;
                   },
@@ -16922,7 +16922,15 @@ void main() {
       await tester.pumpAndSettle();
 
       expect(timesTriggered, 0);
-    }, variant: TargetPlatformVariant.all());
+
+      focusNodeA..requestFocus();
+      await tester.pump();
+
+      await click(find.text('Outside'));
+      await tester.pumpAndSettle();
+          
+      expect(timesTriggered, 1);
+      }, variant: TargetPlatformVariant.all());
     }}
   });
 

packages/flutter_tools/lib/src/commands/config.dart

@@ -15,6 +15,11 @@ import '../runner/flutter_command_runner.dart';
 
 class ConfigCommand extends FlutterCommand {
   ConfigCommand({ bool verboseHelp = false }) {
+    argParser.addFlag(
+      'list',
+      help: 'List all settings and their current values.',
+      negatable: false,
+    );
     argParser.addFlag('analytics',
       hide: !verboseHelp,
       help: 'Enable or disable reporting anonymously tool usage statistics and crash reports.\n'
@@ -73,37 +78,7 @@ class ConfigCommand extends FlutterCommand {
   bool get shouldUpdateCache => false;
 
   @override
-  String get usageFooter {
-    // List all config settings. for feature flags, include whether they
-    // are available.
-    final Map<String, Feature> featuresByName = <String, Feature>{};
-    final String channel = globals.flutterVersion.channel;
-    for (final Feature feature in allFeatures) {
-      final String? configSetting = feature.configSetting;
-      if (configSetting != null) {
-        featuresByName[configSetting] = feature;
-      }
-    }
-    String values = globals.config.keys
-        .map<String>((String key) {
-          String configFooter = '';
-          if (featuresByName.containsKey(key)) {
-            final FeatureChannelSetting setting = featuresByName[key]!.getSettingForChannel(channel);
-            if (!setting.available) {
-              configFooter = '(Unavailable)';
-            }
-          }
-          return '  $key: ${globals.config.getValue(key)} $configFooter';
-        }).join('\n');
-    if (values.isEmpty) {
-      values = '  No settings have been configured.';
-    }
-    final bool analyticsEnabled = globals.flutterUsage.enabled &&
-                                  !globals.flutterUsage.suppressAnalytics;
-    return
-      '\nSettings:\n$values\n\n'
-      'Analytics reporting is currently ${analyticsEnabled ? 'enabled' : 'disabled'}.';
-  }
+  String get usageFooter => '\n$analyticsUsage';
 
   /// Return null to disable analytics recording of the `config` command.
   @override
@@ -121,6 +96,11 @@ class ConfigCommand extends FlutterCommand {
           '    flutter config --android-studio-dir "/opt/Android Studio"');
     }
 
+    if (boolArg('list')) {
+      globals.printStatus(settingsText);
+      return FlutterCommandResult.success();
+    }
+
     if (boolArg('machine')) {
       await handleMachine();
       return FlutterCommandResult.success();
@@ -133,6 +113,7 @@ class ConfigCommand extends FlutterCommand {
           globals.config.removeValue(configSetting);
         }
       }
+      globals.printStatus(requireReloadTipText);
       return FlutterCommandResult.success();
     }
 
@@ -195,7 +176,7 @@ class ConfigCommand extends FlutterCommand {
     if (argResults == null || argResults!.arguments.isEmpty) {
       globals.printStatus(usage);
     } else {
-      globals.printStatus('\nYou may need to restart any open editors for them to read new settings.');
+      globals.printStatus('\n$requireReloadTipText');
     }
 
     return FlutterCommandResult.success();
@@ -234,4 +215,50 @@ class ConfigCommand extends FlutterCommand {
       globals.printStatus('Setting "$keyName" value to "$keyValue".');
     }
   }
+
+  /// List all config settings. for feature flags, include whether they are available.
+  String get settingsText {
+    final Map<String, Feature> featuresByName = <String, Feature>{};
+    final String channel = globals.flutterVersion.channel;
+    for (final Feature feature in allFeatures) {
+      final String? configSetting = feature.configSetting;
+      if (configSetting != null) {
+        featuresByName[configSetting] = feature;
+      }
+    }
+    final Set<String> keys = <String>{
+      ...allFeatures.map((Feature e) => e.configSetting).whereType<String>(),
+      ...globals.config.keys,
+    };
+    final Iterable<String> settings = keys.map<String>((String key) {
+      Object? value = globals.config.getValue(key);
+      value ??= '(Not set)';
+      final StringBuffer buffer = StringBuffer('  $key: $value');
+      if (featuresByName.containsKey(key)) {
+        final FeatureChannelSetting setting = featuresByName[key]!.getSettingForChannel(channel);
+        if (!setting.available) {
+          buffer.write(' (Unavailable)');
+        }
+      }
+      return buffer.toString();
+    });
+    final StringBuffer buffer = StringBuffer();
+    buffer.writeln('All Settings:');
+    if (settings.isEmpty) {
+      buffer.writeln('  No configs have been configured.');
+    } else {
+      buffer.writeln(settings.join('\n'));
+    }
+    return buffer.toString();
+  }
+
+  /// List the status of the analytics reporting.
+  String get analyticsUsage {
+    final bool analyticsEnabled =
+        globals.flutterUsage.enabled && !globals.flutterUsage.suppressAnalytics;
+    return 'Analytics reporting is currently ${analyticsEnabled ? 'enabled' : 'disabled'}.';
+  }
+
+  /// Raising the reload tip for setting changes.
+  final String requireReloadTipText = 'You may need to restart any open editors for them to read new settings.';
 }

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

@@ -12,6 +12,7 @@ import 'package:flutter_tools/src/base/file_system.dart';
 import 'package:flutter_tools/src/build_info.dart';
 import 'package:flutter_tools/src/cache.dart';
 import 'package:flutter_tools/src/commands/config.dart';
+import 'package:flutter_tools/src/features.dart';
 import 'package:flutter_tools/src/globals.dart' as globals;
 import 'package:flutter_tools/src/reporting/reporting.dart';
 import 'package:flutter_tools/src/version.dart';
@@ -48,6 +49,23 @@ void main() {
   }
 
   group('config', () {
+    testUsingContext('prints all settings with --list', () async {
+      final ConfigCommand configCommand = ConfigCommand();
+      final CommandRunner<void> commandRunner = createTestCommandRunner(configCommand);
+      await commandRunner.run(<String>['config', '--list']);
+      expect(
+        testLogger.statusText,
+        'All Settings:\n'
+        '${allFeatures
+            .where((Feature e) => e.configSetting != null)
+            .map((Feature e) => '  ${e.configSetting}: (Not set)')
+            .join('\n')}'
+        '\n\n',
+      );
+    }, overrides: <Type, Generator>{
+      Usage: () => testUsage,
+    });
+
     testUsingContext('throws error on excess arguments', () {
       final ConfigCommand configCommand = ConfigCommand();
       final CommandRunner<void> commandRunner = createTestCommandRunner(configCommand);
@@ -196,6 +214,7 @@ void main() {
 
       await commandRunner.run(<String>[
         'config',
+        '--list'
       ]);
 
       expect(
@@ -270,20 +289,21 @@ void main() {
       Usage: () => testUsage,
     });
 
-    testUsingContext('analytics reported disabled when suppressed', () async {
+    testUsingContext('analytics reported with help usages', () async {
       final ConfigCommand configCommand = ConfigCommand();
-      final CommandRunner<void> commandRunner = createTestCommandRunner(configCommand);
+      createTestCommandRunner(configCommand);
 
       testUsage.suppressAnalytics = true;
-
-      await commandRunner.run(<String>[
-        'config',
-      ]);
-
       expect(
-        testLogger.statusText,
+        configCommand.usage,
         containsIgnoringWhitespace('Analytics reporting is currently disabled'),
       );
+
+      testUsage.suppressAnalytics = false;
+      expect(
+        configCommand.usage,
+        containsIgnoringWhitespace('Analytics reporting is currently enabled'),
+      );
     }, overrides: <Type, Generator>{
       Usage: () => testUsage,
     });

packages/flutter_tools/test/integration.shard/command_output_test.dart

@@ -71,11 +71,12 @@ void main() {
     expect(result.stdout, contains('Shutdown hooks complete'));
   });
 
-  testWithoutContext('flutter config contains all features', () async {
+  testWithoutContext('flutter config --list contains all features', () async {
     final String flutterBin = fileSystem.path.join(getFlutterRoot(), 'bin', 'flutter');
     final ProcessResult result = await processManager.run(<String>[
       flutterBin,
       'config',
+      '--list'
     ]);
 
     // contains all of the experiments in features.dart