Implement the verbose option for dart analyze

bwilkerson · commit-bot@chromium.org · commit fa650e46dd04 · 2020-07-06T04:05:40.000Z
Change-Id: I2186a83ad295ad99a2df09a72f08c2b6f531e982 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/153321 Reviewed-by: Devon Carew <devoncarew@google.com> Commit-Queue: Brian Wilkerson <brianwilkerson@google.com>
diff --git a/pkg/dartdev/lib/src/commands/analyze.dart b/pkg/dartdev/lib/src/commands/analyze.dart
@@ -103,8 +103,19 @@ class AnalyzeCommand extends DartdevCommand<int> {
           '(${error.code})',
         );
 
-        // TODO(devoncarew): If verbose, print additional information about the
-        // issue (resolution, more info url, ...).
+        if (verbose) {
+          var padding = ' '.padLeft(error.severity.length + 2);
+          for (var message in error.contextMessages) {
+            log.stdout('$padding${message.message} '
+                'at ${message.filePath}:${message.line}:${message.column}');
+          }
+          if (error.correction != null) {
+            log.stdout('$padding${error.correction}');
+          }
+          if (error.url != null) {
+            log.stdout('$padding${error.url}');
+          }
+        }
 
         hasErrors |= error.isError;
         hasWarnings |= error.isWarning;
diff --git a/pkg/dartdev/lib/src/commands/analyze_impl.dart b/pkg/dartdev/lib/src/commands/analyze_impl.dart
@@ -203,6 +203,8 @@ class AnalysisError implements Comparable<AnalysisError> {
 
   String get code => json['code'] as String;
 
+  String get correction => json['correction'] as String;
+
   String get file => json['location']['file'] as String;
 
   int get startLine => json['location']['startLine'] as int;
@@ -213,6 +215,13 @@ class AnalysisError implements Comparable<AnalysisError> {
 
   String get messageSentenceFragment => trimEnd(message, '.');
 
+  String get url => json['url'] as String;
+
+  List<DiagnosticMessage> get contextMessages {
+    var messages = json['contextMessages'] as List<dynamic>;
+    return messages.map((message) => DiagnosticMessage(message)).toList();
+  }
+
   // TODO(jwren) add some tests to verify that the results are what we are
   //  expecting, 'other' is not always on the RHS of the subtraction in the
   //  implementation.
@@ -241,6 +250,20 @@ class AnalysisError implements Comparable<AnalysisError> {
       '($code)';
 }
 
+class DiagnosticMessage {
+  final Map<String, dynamic> json;
+
+  DiagnosticMessage(this.json);
+
+  int get column => json['location']['startColumn'] as int;
+
+  String get filePath => json['location']['file'] as String;
+
+  int get line => json['location']['startLine'] as int;
+
+  String get message => json['message'] as String;
+}
+
 class FileAnalysisErrors {
   final String file;
   final List<AnalysisError> errors;
diff --git a/pkg/dartdev/test/commands/analyze_test.dart b/pkg/dartdev/test/commands/analyze_test.dart
@@ -157,4 +157,25 @@ void defineAnalyze() {
     expect(result.stderr, isEmpty);
     expect(result.stdout, contains('1 issue found.'));
   });
+
+  test('--verbose', () {
+    p = project(mainSrc: '''
+int f() {
+  var result = one + 2;
+  var one = 1;
+  return result;
+}''');
+    var result = p.runSync('analyze', ['--verbose', p.dirPath]);
+
+    expect(result.exitCode, 3);
+    expect(result.stderr, isEmpty);
+    var stdout = result.stdout;
+    expect(stdout, contains("The declaration of 'one' is on line 3."));
+    expect(
+        stdout, contains('Try moving the declaration to before the first use'));
+    expect(
+        stdout,
+        contains(
+            'https://dart.dev/tools/diagnostic-messages#referenced_before_declaration'));
+  });
 }
