Add "pub run --list" command to show all available executables.

See #1323

Author: antonmoiseev

lib/src/command/run.dart

@@ -10,6 +10,8 @@ import 'package:path/path.dart' as p;
 import '../command.dart';
 import '../executable.dart';
 import '../io.dart';
+import '../log.dart' as log;
+import '../package.dart';
 import '../utils.dart';
 
 /// Handles the `run` pub command.
@@ -20,15 +22,21 @@ class RunCommand extends PubCommand {
   bool get allowTrailingOptions => false;
 
   RunCommand() {
-    argParser.addFlag("checked", abbr: "c",
-        help: "Enable runtime type checks and assertions.");
+    argParser.addFlag("checked",
+        abbr: "c", help: "Enable runtime type checks and assertions.");
+    argParser.addFlag('list',
+        help: 'List all available executables.', negatable: false);
     argParser.addOption("mode",
         help: 'Mode to run transformers in.\n'
-              '(defaults to "release" for dependencies, "debug" for '
-                'entrypoint)');
+            '(defaults to "release" for dependencies, "debug" for entrypoint)');
   }
 
   Future run() async {
+    if (argResults['list']) {
+      _listExecutables();
+      return;
+    }
+
     if (argResults.rest.isEmpty) {
       usageException("Must specify an executable to run.");
     }
@@ -45,10 +53,10 @@ class RunCommand extends PubCommand {
       executable = components[1];
 
       if (p.split(executable).length > 1) {
-      // TODO(nweiz): Use adjacent strings when the new async/await compiler
-      // lands.
-        usageException("Cannot run an executable in a subdirectory of a " +
-            "dependency.");
+        // TODO(nweiz): Use adjacent strings when the new async/await compiler
+        // lands.
+        usageException(
+            "Cannot run an executable in a subdirectory of a dependency.");
       }
     } else if (onlyIdentifierRegExp.hasMatch(executable)) {
       // "pub run foo" means the same thing as "pub run foo:foo" as long as
@@ -69,4 +77,48 @@ class RunCommand extends PubCommand {
         checked: argResults['checked'], mode: mode);
     await flushThenExit(exitCode);
   }
+
+  /// Lists all executables reachable from [entrypoint].
+  void _listExecutables() {
+    var ownExecutables = _listExecutablesFor(entrypoint.root)
+        .map((executable) => p.join('bin', executable));
+
+    var packageExecutables = entrypoint.root.immediateDependencies
+        .map((dep) => entrypoint.packageGraph.packages[dep.name])
+        .expand((Package package) => _listExecutablesFor(package).map(
+            (executable) => _normalizeExecutable(package.name, executable)));
+
+    var allExecutables = []
+      ..addAll(ownExecutables)
+      ..addAll(packageExecutables)
+      ..sort();
+
+    log.message(log.bold(allExecutables.join('\n')));
+  }
+
+  /// Lists all Dart files in the `bin` directory of the [package].
+  ///
+  /// Returns paths without extension relative to the `bin` directory of the
+  /// [package].
+  List<String> _listExecutablesFor(Package package) {
+    return package
+        .listFiles(beneath: 'bin', recursive: true)
+        .where((executable) => p.extension(executable) == '.dart')
+        .map((executable) => p.relative(executable, from: package.path('bin')))
+        .map((executable) => p.withoutExtension(executable));
+  }
+
+  /// If [executable] is the same as [package] name, returns unmodified
+  /// [executable].
+  ///
+  ///     _normalizeExecutable('foo', 'foo') // -> 'foo'
+  ///
+  /// Otherwise prepends [executable] with [package] name and separates them
+  /// with the colon.
+  ///
+  ///     _normalizeExecutable('foo', 'bar') // -> 'foo:bar'
+  ///     _normalizeExecutable('foo', 'bar/baz') // -> 'foo:bar/baz'
+  String _normalizeExecutable(String package, String executable) {
+    return package == executable ? package : '$package:$executable';
+  }
 }

test/run/errors_if_no_executable_is_given_test.dart

@@ -20,6 +20,7 @@ Must specify an executable to run.
 Usage: pub run <executable> [args...]
 -h, --help            Print this usage information.
 -c, --[no-]checked    Enable runtime type checks and assertions.
+    --list            List all available executables.
     --mode            Mode to run transformers in.
                       (defaults to "release" for dependencies, "debug" for entrypoint)
 

test/run/errors_if_path_in_dependency_test.dart

@@ -27,6 +27,7 @@ Cannot run an executable in a subdirectory of a dependency.
 Usage: pub run <executable> [args...]
 -h, --help            Print this usage information.
 -c, --[no-]checked    Enable runtime type checks and assertions.
+    --list            List all available executables.
     --mode            Mode to run transformers in.
                       (defaults to "release" for dependencies, "debug" for entrypoint)
 

test/run/list_test.dart

@@ -0,0 +1,112 @@
+// Copyright (c) 2016, the Dart project authors. Please see the AUTHORS file
+// 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:path/path.dart' as p;
+
+import '../descriptor.dart' as d;
+import '../test_pub.dart';
+
+main() {
+  integration("lists executables in entrypoint's bin", () {
+    d.dir(appPath, [
+      d.appPubspec(),
+      d.dir('bin', [
+        d.file('foo.dart'),
+        d.file('bar.dart'),
+        d.dir('sub', [d.file('baz.dart')])
+      ])
+    ]).create();
+
+    schedulePub(
+        args: ['run', '--list'],
+        output: '''
+${p.join('bin', 'bar')}
+${p.join('bin', 'foo')}
+${p.join('bin', 'sub', 'baz')}
+''');
+  });
+
+  integration('lists only Dart files', () {
+    d.dir(appPath, [
+      d.appPubspec(),
+      d.dir('bin', [d.file('foo.dart'), d.file('bar.sh')])
+    ]).create();
+
+    schedulePub(args: ['run', '--list'], output: p.join('bin', 'foo'));
+  });
+
+  integration('lists executables from a dependency', () {
+    d.dir('foo', [
+      d.libPubspec('foo', '1.0.0'),
+      d.dir('bin', [
+        d.file('bar.dart'),
+        d.dir('sub', [d.file('baz.dart'),])
+      ])
+    ]).create();
+
+    d.dir(appPath, [
+      d.appPubspec({
+        'foo': {'path': '../foo'}
+      })
+    ]).create();
+
+    pubGet();
+    schedulePub(
+        args: ['run', '--list'],
+        output: '''
+foo:bar
+foo:${p.join('sub', 'baz')}
+''');
+  });
+
+  integration('lists executables only from immediate dependencies', () {
+    d.dir('foo', [
+      d.libPubspec('foo', '1.0.0'),
+      d.dir('bin', [d.file('baz.dart')])
+    ]).create();
+
+    d.dir('bar', [
+      d.libPubspec('bar', '1.0.0', deps: {
+        'foo': {'path': '../foo'}
+      }),
+      d.dir('bin', [d.file('baz.dart')])
+    ]).create();
+
+    d.dir(appPath, [
+      d.appPubspec({
+        'bar': {'path': '../bar'}
+      })
+    ]).create();
+
+    pubGet();
+    schedulePub(args: ['run', '--list'], output: 'bar:baz');
+  });
+
+  integration('normilizes executable names', () {
+    d.dir('foo', [
+      d.libPubspec('foo', '1.0.0'),
+      d.dir('bin', [d.file('foo.dart'), d.file('bar.dart')])
+    ]).create();
+
+    d.dir(appPath, [
+      d.appPubspec({
+        'foo': {'path': '../foo'}
+      })
+    ]).create();
+
+    pubGet();
+    schedulePub(
+        args: ['run', '--list'],
+        output: '''
+foo
+foo:bar
+''');
+  });
+
+  integration('prints blank line when no executables found', () {
+    d.dir(appPath, [d.appPubspec()]).create();
+
+    schedulePub(args: ['run', '--list'], output: '\n');
+  });
+}