[dartdev] introduce a hidden --diagnostics flag

Change-Id: I129b350ef993f718fc2baecfa4af05b825d4e953
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/153301
Reviewed-by: Brian Wilkerson <[email protected]>
Commit-Queue: Devon Carew <[email protected]>

Author: devoncarew

pkg/dartdev/lib/dartdev.dart

@@ -145,7 +145,7 @@ class DartdevRunner<int> extends CommandRunner {
     final bool verbose = args.contains('-v') || args.contains('--verbose');
 
     argParser.addFlag('verbose',
-        abbr: 'v', negatable: false, help: 'Show verbose output.');
+        abbr: 'v', negatable: false, help: 'Show additional command output.');
     argParser.addFlag('version',
         negatable: false, help: 'Print the Dart SDK version.');
     argParser.addFlag('enable-analytics',
@@ -155,6 +155,9 @@ class DartdevRunner<int> extends CommandRunner {
 
     addExperimentalFlags(argParser, verbose);
 
+    argParser.addFlag('diagnostics',
+        negatable: false, help: 'Show tool diagnostic output.', hide: !verbose);
+
     // A hidden flag to disable analytics on this run, this constructor can be
     // called with this flag, but should be removed before run() is called as
     // the flag has not been added to all sub-commands.
@@ -163,14 +166,14 @@ class DartdevRunner<int> extends CommandRunner {
         help: 'Disable anonymous analytics for this `dart *` run',
         hide: true);
 
-    addCommand(AnalyzeCommand(verbose: verbose));
+    addCommand(AnalyzeCommand());
     addCommand(CreateCommand(verbose: verbose));
-    addCommand(CompileCommand(verbose: verbose));
-    addCommand(FormatCommand(verbose: verbose));
+    addCommand(CompileCommand());
+    addCommand(FormatCommand());
     addCommand(MigrateCommand(verbose: verbose));
-    addCommand(PubCommand(verbose: verbose));
-    addCommand(RunCommand(verbose: verbose));
-    addCommand(TestCommand(verbose: verbose));
+    addCommand(PubCommand());
+    addCommand(RunCommand());
+    addCommand(TestCommand());
   }
 
   @override
@@ -192,13 +195,16 @@ class DartdevRunner<int> extends CommandRunner {
         io.exit(254);
       }
     }
-    isVerbose = topLevelResults['verbose'];
+
+    isDiagnostics = topLevelResults['diagnostics'];
 
     final Ansi ansi = Ansi(Ansi.terminalSupportsAnsi);
-    log = isVerbose ? Logger.verbose(ansi: ansi) : Logger.standard(ansi: ansi);
+    log = isDiagnostics
+        ? Logger.verbose(ansi: ansi)
+        : Logger.standard(ansi: ansi);
 
-    if (wereExperimentsSpecified(topLevelResults)) {
-      List<String> experimentIds = specifiedExperiments(topLevelResults);
+    if (topLevelResults.wasParsed(experimentFlagName)) {
+      List<String> experimentIds = topLevelResults[experimentFlagName];
       for (ExperimentalFeature feature in experimentalFeatures) {
         // We allow default true flags, but complain when they are passed in.
         if (feature.isEnabledByDefault &&

pkg/dartdev/lib/src/commands/analyze.dart

@@ -15,8 +15,7 @@ import 'analyze_impl.dart';
 // TODO: Support enable-experiment for 'dart analyze'.
 
 class AnalyzeCommand extends DartdevCommand<int> {
-  AnalyzeCommand({bool verbose = false})
-      : super('analyze', "Analyze the project's Dart code.") {
+  AnalyzeCommand() : super('analyze', "Analyze the project's Dart code.") {
     argParser
       ..addFlag('fatal-infos',
           help: 'Treat info level issues as fatal.', negatable: false)
@@ -104,6 +103,9 @@ class AnalyzeCommand extends DartdevCommand<int> {
           '(${error.code})',
         );
 
+        // TODO(devoncarew): If verbose, print additional information about the
+        // issue (resolution, more info url, ...).
+
         hasErrors |= error.isError;
         hasWarnings |= error.isWarning;
         hasInfos |= error.isInfo;

pkg/dartdev/lib/src/commands/analyze_impl.dart

@@ -45,7 +45,6 @@ class AnalysisServer {
       sdkPath.path,
     ];
 
-    log.trace('dart ${command.join(' ')}');
     _process = await startProcess(sdk.dart, command);
     // This callback hookup can't throw.
     //ignore: unawaited_futures

pkg/dartdev/lib/src/commands/compile.dart

@@ -18,6 +18,7 @@ class Option {
   final String flag;
   final String help;
   final String abbr;
+
   Option({this.flag, this.help, this.abbr});
 }
 
@@ -44,10 +45,7 @@ bool checkFile(String sourcePath) {
 }
 
 class CompileJSCommand extends DartdevCommand<int> {
-  bool verbose = false;
-  CompileJSCommand({
-    this.verbose,
-  }) : super('js', 'Compile Dart to JavaScript') {
+  CompileJSCommand() : super('js', 'Compile Dart to JavaScript') {
     argParser
       ..addOption(
         commonOptions['outputFile'].flag,
@@ -85,14 +83,12 @@ class CompileJSCommand extends DartdevCommand<int> {
 }
 
 class CompileSnapshotCommand extends DartdevCommand<int> {
-  bool verbose = false;
   final String commandName;
   final String help;
   final String fileExt;
   final String formatName;
 
   CompileSnapshotCommand({
-    this.verbose,
     this.commandName,
     this.help,
     this.fileExt,
@@ -146,13 +142,11 @@ class CompileSnapshotCommand extends DartdevCommand<int> {
 }
 
 class CompileNativeCommand extends DartdevCommand<int> {
-  bool verbose = false;
   final String commandName;
   final String format;
   final String help;
 
   CompileNativeCommand({
-    this.verbose,
     this.commandName,
     this.format,
     this.help,
@@ -216,29 +210,27 @@ Remove debugging information from the output and save it separately to the speci
 class CompileCommand extends Command {
   @override
   String get description => 'Compile Dart to various formats.';
+
   @override
   String get name => 'compile';
 
-  CompileCommand({bool verbose = false}) {
+  CompileCommand() {
     addSubcommand(CompileJSCommand());
     addSubcommand(CompileSnapshotCommand(
       commandName: 'jit-snapshot',
       help: 'to a JIT snapshot',
       fileExt: 'jit',
       formatName: 'app-jit',
-      verbose: verbose,
     ));
     addSubcommand(CompileNativeCommand(
       commandName: 'exe',
       help: 'to a self-contained executable',
       format: 'exe',
-      verbose: verbose,
     ));
     addSubcommand(CompileNativeCommand(
       commandName: 'aot-snapshot',
       help: 'to an AOT snapshot',
       format: 'aot',
-      verbose: verbose,
     ));
   }
 }

pkg/dartdev/lib/src/commands/format.dart

@@ -8,8 +8,7 @@ import '../core.dart';
 import '../sdk.dart';
 
 class FormatCommand extends DartdevCommand {
-  FormatCommand({bool verbose = false})
-      : super('format', 'Format Dart source code.') {
+  FormatCommand() : super('format', 'Format Dart source code.') {
     // TODO(jwren) When https://github.com/dart-lang/dart_style/issues/889
     //  is resolved, have dart_style provide the ArgParser, instead of creating
     // one here.

pkg/dartdev/lib/src/commands/pub.dart

@@ -12,7 +12,7 @@ import '../experiments.dart';
 import '../sdk.dart';
 
 class PubCommand extends DartdevCommand<int> {
-  PubCommand({bool verbose = false}) : super('pub', 'Work with packages.');
+  PubCommand() : super('pub', 'Work with packages.');
 
   @override
   final ArgParser argParser = ArgParser.allowAnything();
@@ -46,8 +46,8 @@ class PubCommand extends DartdevCommand<int> {
     var args = argResults.arguments;
 
     // Pass any --enable-experiment options along.
-    if (args.isNotEmpty && wereExperimentsSpecified(globalResults)) {
-      List<String> experimentIds = specifiedExperiments(globalResults);
+    if (args.isNotEmpty && wereExperimentsSpecified) {
+      List<String> experimentIds = specifiedExperiments;
 
       if (args.first == 'run') {
         args = [

pkg/dartdev/lib/src/commands/run.dart

@@ -18,6 +18,8 @@ import '../utils.dart';
 class RunCommand extends DartdevCommand<int> {
   @override
   final ArgParser argParser = ArgParser.allowAnything();
+
+  @override
   final bool verbose;
 
   RunCommand({this.verbose = false}) : super('run', '''
@@ -102,9 +104,8 @@ Run a Dart file.''');
     }
 
     // Pass any --enable-experiment options along.
-    // todo: test
-    if (args.isNotEmpty && wereExperimentsSpecified(globalResults)) {
-      List<String> experimentIds = specifiedExperiments(globalResults);
+    if (args.isNotEmpty && wereExperimentsSpecified) {
+      List<String> experimentIds = specifiedExperiments;
       args = [
         '--$experimentFlagName=${experimentIds.join(',')}',
         ...args,

pkg/dartdev/lib/src/commands/test.dart

@@ -11,8 +11,7 @@ import '../core.dart';
 import '../sdk.dart';
 
 class TestCommand extends DartdevCommand<int> {
-  TestCommand({bool verbose = false})
-      : super('test', 'Runs tests in this project.');
+  TestCommand() : super('test', 'Runs tests in this project.');
 
   @override
   final ArgParser argParser = ArgParser.allowAnything();

pkg/dartdev/lib/src/core.dart

@@ -9,10 +9,11 @@ import 'package:args/command_runner.dart';
 import 'package:cli_util/cli_logging.dart';
 import 'package:path/path.dart' as path;
 
+import 'experiments.dart';
 import 'utils.dart';
 
 Logger log;
-bool isVerbose = false;
+bool isDiagnostics = false;
 
 abstract class DartdevCommand<int> extends Command {
   final String _name;
@@ -32,6 +33,19 @@ abstract class DartdevCommand<int> extends Command {
   String get description => _description;
 
   Project get project => _project ??= Project();
+
+  /// Return whether commands should emit verbose output.
+  bool get verbose => globalResults['verbose'];
+
+  /// Return whether the tool should emit diagnostic output.
+  bool get diagnosticsEnabled => globalResults['diagnostics'];
+
+  /// Return whether any Dart experiments were specified by the user.
+  bool get wereExperimentsSpecified =>
+      globalResults.wasParsed(experimentFlagName);
+
+  /// Return the list of Dart experiment flags specified by the user.
+  List<String> get specifiedExperiments => globalResults[experimentFlagName];
 }
 
 /// A utility method to start the given executable as a process, optionally
@@ -50,7 +64,7 @@ void routeToStdout(
   bool logToTrace = false,
   void Function(String str) listener,
 }) {
-  if (isVerbose) {
+  if (isDiagnostics) {
     _streamLineTransform(process.stdout, (String line) {
       logToTrace ? log.trace(line.trimRight()) : log.stdout(line.trimRight());
       if (listener != null) listener(line);

pkg/dartdev/lib/src/experiments.dart

@@ -3,7 +3,6 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analyzer/src/dart/analysis/experiments.dart';
-import 'package:args/args.dart';
 
 const experimentFlagName = 'enable-experiment';
 
@@ -15,11 +14,3 @@ List<ExperimentalFeature> get experimentalFeatures {
   features.sort((a, b) => a.enableString.compareTo(b.enableString));
   return features;
 }
-
-/// Return whether any Dart experiments were specified by the user.
-bool wereExperimentsSpecified(ArgResults argResults) =>
-    argResults.wasParsed(experimentFlagName);
-
-/// Return the list of Dart experiment flags specified by the user.
-List<String> specifiedExperiments(ArgResults argResults) =>
-    argResults[experimentFlagName];