Refactor build_runner command line (#4165)

* Refactor build_runner CLI to separate options from other state.

* Address review comments.

Author: davidmorgan

_test/test/help_test.dart

@@ -13,56 +13,52 @@ import 'common/utils.dart';
 
 void main() {
   test('dart run build_runner help', () async {
-    await _testHelpCommand([
-      'help',
-    ], checkContent: 'Unified interface for running Dart builds.');
-    await _testHelpCommand([
-      '--help',
-    ], checkContent: 'Unified interface for running Dart builds.');
+    await _testHelpCommand(['help'], checkContent: 'Dart build tool.');
+    await _testHelpCommand(['--help'], checkContent: 'Dart build tool.');
   });
 
   test('dart run build_runner build --help', () async {
     await _testHelpCommand([
       'build',
       '--help',
-    ], checkContent: 'Performs a single build on the specified targets');
+    ], checkContent: 'Builds the current package.');
     await _testHelpCommand([
       'help',
       'build',
-    ], checkContent: 'Performs a single build on the specified targets');
+    ], checkContent: 'Builds the current package.');
   });
 
   test('dart run build_runner serve --help', () async {
     await _testHelpCommand([
       'serve',
       '--help',
-    ], checkContent: 'Runs a development server');
+    ], checkContent: 'Continuously builds and serves the current package.');
     await _testHelpCommand([
       'help',
       'serve',
-    ], checkContent: 'Runs a development server');
+    ], checkContent: 'Continuously builds and serves the current package.');
   });
 
   test('dart run build_runner test --help', () async {
     await _testHelpCommand([
       'test',
       '--help',
-    ], checkContent: 'and then runs tests using');
+    ], checkContent: 'Builds the current package then runs tests.');
     await _testHelpCommand([
       'help',
       'test',
-    ], checkContent: 'and then runs tests using');
+    ], checkContent: 'Builds the current package then runs tests.');
   });
 
   test('dart run build_runner watch --help', () async {
     await _testHelpCommand([
       'watch',
       '--help',
-    ], checkContent: 'watching the file system for updates');
+    ], checkContent: 'Continuously builds the current package.');
     await _testHelpCommand([
       'help',
       'watch',
-    ], checkContent: 'watching the file system for updates');
+    ], checkContent: 'Continuously builds the current package.');
   });
 }
 

_test_common/lib/test_phases.dart

@@ -9,6 +9,7 @@ import 'package:build_runner_core/build_runner_core.dart';
 import 'package:build_test/build_test.dart';
 // ignore: implementation_imports
 import 'package:build_test/src/in_memory_reader_writer.dart';
+import 'package:built_collection/built_collection.dart';
 import 'package:logging/logging.dart';
 import 'package:test/test.dart';
 
@@ -142,7 +143,7 @@ Future<TestBuildersResult> testPhases(
     b.verbose = verbose;
   });
 
-  var options = await BuildOptions.create(
+  var options = await BuildConfiguration.create(
     packageGraph: packageGraph,
     reader: environment.reader,
     skipBuildScriptCheck: true,
@@ -154,14 +155,14 @@ Future<TestBuildersResult> testPhases(
   var build = await BuildRunner.create(
     options,
     environment,
-    builders,
-    const {},
+    builders.build(),
+    BuiltMap(),
     isReleaseBuild: false,
   );
   result = await build.run(
     {},
-    buildDirs: buildDirs,
-    buildFilters: buildFilters,
+    buildDirs: buildDirs.build(),
+    buildFilters: buildFilters.build(),
   );
   await build.beforeExit();
 

build_runner/bin/build_runner.dart

@@ -2,99 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'dart:async';
-import 'dart:io';
+import 'package:build_runner/src/build_runner.dart';
 
-import 'package:args/args.dart';
-import 'package:args/command_runner.dart';
-import 'package:build_runner/src/build_script_generate/bootstrap.dart';
-import 'package:build_runner/src/build_script_generate/build_process_state.dart';
-import 'package:build_runner/src/entrypoint/options.dart';
-import 'package:build_runner/src/entrypoint/runner.dart';
-import 'package:build_runner_core/build_runner_core.dart';
-import 'package:io/ansi.dart';
-import 'package:io/io.dart';
-
-import 'src/commands/clean.dart';
-
-Future<void> main(List<String> args) async {
-  // Use the actual command runner to parse the args and immediately print the
-  // usage information if there is no command provided or the help command was
-  // explicitly invoked.
-  var commandRunner = BuildCommandRunner(
-    [],
-    await PackageGraph.forThisPackage(),
-  );
-  var localCommands = [CleanCommand()];
-  var localCommandNames = localCommands.map((c) => c.name).toSet();
-  for (var command in localCommands) {
-    commandRunner.addCommand(command);
-    // This flag is added to each command individually and not the top level.
-    command.argParser.addFlag(
-      verboseOption,
-      abbr: 'v',
-      defaultsTo: false,
-      negatable: false,
-      help: 'Verbose logging: displays info logged by builders.',
-    );
-  }
-
-  ArgResults parsedArgs;
-  try {
-    parsedArgs = commandRunner.parse(args);
-  } on UsageException catch (e) {
-    print(red.wrap(e.message));
-    print('');
-    print(e.usage);
-    exitCode = ExitCode.usage.code;
-    return;
-  }
-
-  var commandName = parsedArgs.command?.name;
-
-  if (parsedArgs.rest.isNotEmpty) {
-    print(
-      yellow.wrap('Could not find a command named "${parsedArgs.rest[0]}".'),
-    );
-    print('');
-    print(commandRunner.usageWithoutDescription);
-    exitCode = ExitCode.usage.code;
-    return;
-  }
-
-  if (commandName == 'help' ||
-      parsedArgs.wasParsed('help') ||
-      (parsedArgs.command?.wasParsed('help') ?? false)) {
-    await commandRunner.runCommand(parsedArgs);
-    return;
-  }
-
-  if (commandName == null) {
-    commandRunner.printUsage();
-    exitCode = ExitCode.usage.code;
-    return;
-  }
-
-  if (localCommandNames.contains(commandName)) {
-    exitCode = await commandRunner.runCommand(parsedArgs) ?? 1;
-  } else {
-    var experiments = parsedArgs.command!['enable-experiment'] as List<String>?;
-    // Set the buildLog mode before the command starts so the first few log
-    // messages are displayed correctly.
-    switch (commandName) {
-      case 'build':
-      case 'serve':
-      case 'watch':
-      case 'test':
-        buildLog.configuration = buildLog.configuration.rebuild((b) {
-          b.mode = BuildLogMode.build;
-        });
-      case 'daemon':
-        buildLog.configuration = buildLog.configuration.rebuild((b) {
-          b.mode = BuildLogMode.daemon;
-        });
-    }
-    while ((exitCode = await generateAndRun(args, experiments: experiments)) ==
-        ExitCode.tempFail.code) {}
-  }
-}
+Future<void> main(List<String> arguments) =>
+    BuildRunner(arguments: arguments, builders: null).run();

build_runner/bin/src/commands/clean.dart

@@ -2,5 +2,17 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+import 'package:build_runner_core/build_runner_core.dart'
+    show BuilderApplication;
+
+import 'src/build_runner.dart' show BuildRunner;
+
 export 'src/daemon/constants.dart' show assetServerPort;
-export 'src/entrypoint/run.dart' show run;
+
+/// Runs `build_runner` with [arguments] and [builders].
+///
+/// The `build_runner` tool generates a script `.dart_tool/build/entrypoint/build.dart` that
+/// depends on the configured builders so it can instantiate them to pass the
+/// [builders] parameter.
+Future<int> run(List<String> arguments, List<BuilderApplication> builders) =>
+    BuildRunner(arguments: arguments, builders: builders).run();