build-examples .pluginToolsConfig.yaml support

Author: Hixie

script/tool/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.8.0
+
+- Add support for `.pluginToolsConfig.yaml` in the `build-examples` command.
+
 ## 0.7.0
 
 - `native-test` now supports `--linux` for unit tests.

script/tool/lib/src/build_examples_command.dart

@@ -3,9 +3,11 @@
 // found in the LICENSE file.
 
 import 'dart:async';
+import 'dart:io';
 
 import 'package:file/file.dart';
 import 'package:platform/platform.dart';
+import 'package:yaml/yaml.dart';
 
 import 'common/core.dart';
 import 'common/package_looping_command.dart';
@@ -16,7 +18,10 @@ import 'common/repository_package.dart';
 /// Key for APK.
 const String _platformFlagApk = 'apk';
 
+const String _pluginToolsConfigFileName = '.pluginToolsConfig.yaml';
+
 const int _exitNoPlatformFlags = 3;
+const int _exitInvalidPluginToolsConfig = 4;
 
 // Flutter build types. These are the values passed to `flutter build <foo>`.
 const String _flutterBuildTypeAndroid = 'apk';
@@ -99,7 +104,10 @@ class BuildExamplesCommand extends PackageLoopingCommand {
   @override
   final String description =
       'Builds all example apps (IPA for iOS and APK for Android).\n\n'
-      'This command requires "flutter" to be in your path.';
+      'This command requires "flutter" to be in your path.\n\n'
+      'A $_pluginToolsConfigFileName file can be placed in an example app '
+      'directory to specify additional build arguments. It should be a YAML '
+      'file giving a list of arguments.';
 
   @override
   Future<void> initializeRun() async {
@@ -225,6 +233,29 @@ class BuildExamplesCommand extends PackageLoopingCommand {
       }
     }
 
+    final File pluginToolsConfig =
+        example.directory.childFile(_pluginToolsConfigFileName);
+    if (pluginToolsConfig.existsSync()) {
+      final Object? configuration =
+          loadYaml(pluginToolsConfig.readAsStringSync());
+      if (configuration is! YamlList ||
+          configuration.any((Object? value) => value is! String)) {
+        printError(
+            'The $_pluginToolsConfigFileName file must consist of a list of arguments');
+        printError('to pass to `flutter build` command, as in:');
+        printError(' - "--no-tree-shake-icons" ');
+        printError(' - "--dart-define=buildmode=testing"');
+        printError(
+            'It appears that currently it does not match this format (the root is not');
+        printError('a list of strings).');
+        throw ToolExit(_exitInvalidPluginToolsConfig);
+      }
+      extraBuildFlags = <String>[
+        ...extraBuildFlags,
+        ...configuration.cast<String>()
+      ];
+    }
+
     final int exitCode = await processRunner.runAndStream(
       flutterCommand,
       <String>[

script/tool/pubspec.yaml

@@ -1,7 +1,7 @@
 name: flutter_plugin_tools
 description: Productivity utils for flutter/plugins and flutter/packages
 repository: https://github.com/flutter/plugins/tree/master/script/tool
-version: 0.7.0
+version: 0.8.0
 
 dependencies:
   args: ^2.1.0

script/tool/test/build_examples_command_test.dart

@@ -679,5 +679,49 @@ void main() {
             ]));
       });
     });
+
+    test('The .pluginToolsConfig.yaml file', () async {
+      mockPlatform.isLinux = true;
+      final Directory pluginDirectory = createFakePlugin('plugin', packagesDir,
+          platformSupport: <String, PlatformDetails>{
+            kPlatformLinux: const PlatformDetails(PlatformSupport.inline),
+            kPlatformMacos: const PlatformDetails(PlatformSupport.inline),
+          });
+
+      final Directory pluginExampleDirectory =
+          pluginDirectory.childDirectory('example');
+
+      final File pluginExampleConfigFile =
+          pluginExampleDirectory.childFile('.pluginToolsConfig.yaml');
+      pluginExampleConfigFile.writeAsStringSync(' - "test argument"');
+
+      final List<String> output = <String>[
+        ...await runCapturingPrint(
+            runner, <String>['build-examples', '--linux']),
+        ...await runCapturingPrint(
+            runner, <String>['build-examples', '--macos']),
+      ];
+
+      expect(
+        output,
+        containsAllInOrder(<String>[
+          '\nBUILDING plugin/example for Linux',
+          '\nBUILDING plugin/example for macOS',
+        ]),
+      );
+
+      expect(
+          processRunner.recordedCalls,
+          orderedEquals(<ProcessCall>[
+            ProcessCall(
+                getFlutterCommand(mockPlatform),
+                const <String>['build', 'linux', 'test argument'],
+                pluginExampleDirectory.path),
+            ProcessCall(
+                getFlutterCommand(mockPlatform),
+                const <String>['build', 'macos', 'test argument'],
+                pluginExampleDirectory.path),
+          ]));
+    });
   });
 }