[analyzer] Prioritize errors in analysis_options/pubspec errors when running "dart analyze"

This changes the (non-machine/json) output of "dart analyze" when there are errors in pubspec.yaml/analysis_options.

Before:

```
Analyzing myapp...

  error • analysis_options.yaml:3:1 • Expected ':'. Parse errors in analysis_options.yaml may result in other incorrect diagnostics. • parse_error
  error • lib\main.dart:1:16 • A value of type 'Null' can't be returned from the function 'foo' because it has a return type of 'int'. • return_of_invalid_type

2 issues found.
```

After:

```
Analyzing myapp...

Errors were found in pubspec.yaml or analysis_options.yaml which may result in other incorrect errors.

  error • analysis_options.yaml:3:1 • Expected ':'. Parse errors in analysis_options.yaml may result in other incorrect diagnostics. • parse_error

Errors in other files that might be caused by those above.

  error • lib\main.dart:1:16 • A value of type 'Null' can't be returned from the function 'foo' because it has a return type of 'int'. • return_of_invalid_type

2 issues found.
```

Fixes #55987

Change-Id: I25ae7b200463f2cd3f2046ea9f5f8ddc5c62cc60
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/372080
Reviewed-by: Sam Rawlins <[email protected]>
Commit-Queue: Brian Wilkerson <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>

Author: DanTup

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

@@ -119,6 +119,9 @@ class AnalyzeCommand extends DartdevCommand {
       }
     }
 
+    /// Errors in analysis_options and pubspec.yaml will be reported first
+    /// and a note that they might be the cause of other errors.
+    final List<AnalysisError> priorityErrors = <AnalysisError>[];
     final List<AnalysisError> errors = <AnalysisError>[];
 
     final machineFormat = args.option('format') == 'machine';
@@ -180,10 +183,19 @@ class AnalyzeCommand extends DartdevCommand {
     );
 
     server.onErrors.listen((FileAnalysisErrors fileErrors) {
+      var isPriorityFile = const {'analysis_options.yaml', 'pubspec.yaml'}
+          .contains(path.basename(fileErrors.file));
+
       // Record the issues found (but filter out to do comments unless they've
       // been upgraded from INFO).
-      errors.addAll(fileErrors.errors.where((AnalysisError error) =>
-          error.type != 'TODO' || error.severity != 'INFO'));
+      for (var error in fileErrors.errors.where((AnalysisError error) =>
+          error.type != 'TODO' || error.severity != 'INFO')) {
+        if (isPriorityFile && error.severity == 'ERROR') {
+          priorityErrors.add(error);
+        } else {
+          errors.add(error);
+        }
+      }
     });
 
     int pid = await server.start();
@@ -215,9 +227,9 @@ class AnalyzeCommand extends DartdevCommand {
 
     progress?.finish(showTiming: true);
 
-    if (errors.isEmpty) {
+    if (priorityErrors.isEmpty && errors.isEmpty) {
       if (jsonFormat) {
-        emitJsonFormat(log, errors, usageInfo);
+        emitJsonFormat(log, [], usageInfo);
       } else if (!machineFormat && !server.serverErrorReceived) {
         log.stdout('No issues found!');
       }
@@ -226,6 +238,7 @@ class AnalyzeCommand extends DartdevCommand {
           : _Result.success.exitCode;
     }
 
+    priorityErrors.sort();
     errors.sort();
 
     if (machineFormat) {
@@ -235,21 +248,43 @@ class AnalyzeCommand extends DartdevCommand {
     } else {
       var relativeTo = targets.length == 1 ? targets.single : null;
 
-      emitDefaultFormat(
-        log,
-        errors,
-        relativeToDir: relativeTo is io.File
-            ? relativeTo.parent
-            : relativeTo as io.Directory?,
-        verbose: verbose,
-      );
+      /// Helper to emit a set of errors.
+      void emit(List<AnalysisError> errors) {
+        emitDefaultFormat(
+          log,
+          errors,
+          relativeToDir: relativeTo is io.File
+              ? relativeTo.parent
+              : relativeTo as io.Directory?,
+          verbose: verbose,
+        );
+      }
+
+      if (priorityErrors.isNotEmpty) {
+        log.stdout('');
+        log.stdout("Errors were found in 'pubspec.yaml' and/or "
+            "'analysis_options.yaml' which might result in either invalid "
+            'diagnostics being produced or valid diagnostics being missed.');
+
+        emit(priorityErrors);
+        if (errors.isNotEmpty) {
+          log.stdout('Errors in remaining files.');
+        }
+      }
+
+      if (errors.isNotEmpty) {
+        emit(errors);
+      }
+
+      final errorCount = priorityErrors.length + errors.length;
+      log.stdout('$errorCount ${pluralize('issue', errorCount)} found.');
     }
 
     bool hasErrors = false;
     bool hasWarnings = false;
     bool hasInfos = false;
 
-    for (final AnalysisError error in errors) {
+    for (final AnalysisError error in priorityErrors.followedBy(errors)) {
       hasErrors |= error.isError;
       hasWarnings |= error.isWarning;
       hasInfos |= error.isInfo;
@@ -344,9 +379,6 @@ class AnalyzeCommand extends DartdevCommand {
     }
 
     log.stdout('');
-
-    final errorCount = errors.length;
-    log.stdout('$errorCount ${pluralize('issue', errorCount)} found.');
   }
 
   @visibleForTesting

pkg/dartdev/test/commands/analyze_test.dart

@@ -578,18 +578,91 @@ void f() {
       'hasFix': false
     };
 
-    test('default', () {
-      final logger = TestLogger(false);
-      final errors = [AnalysisError(sampleInfoJson)];
-
-      AnalyzeCommand.emitDefaultFormat(logger, errors);
-
-      expect(logger.stderrBuffer, isEmpty);
-      final stdout = logger.stdoutBuffer.toString().trim();
-      expect(stdout, contains('info'));
-      expect(stdout, contains('lib${path.separator}test.dart:15:4'));
-      expect(stdout, contains('Foo bar baz.'));
-      expect(stdout, contains('dead_code'));
+    group('default', () {
+      test('emits correct format', () {
+        final logger = TestLogger(false);
+        final errors = [AnalysisError(sampleInfoJson)];
+
+        AnalyzeCommand.emitDefaultFormat(logger, errors);
+
+        expect(logger.stderrBuffer, isEmpty);
+        final stdout = logger.stdoutBuffer.toString().trim();
+        expect(stdout, contains('info'));
+        expect(stdout, contains('lib${path.separator}test.dart:15:4'));
+        expect(stdout, contains('Foo bar baz.'));
+        expect(stdout, contains('dead_code'));
+      });
+
+      test('prioritizes errors in analysis_options.yaml (with other errors)',
+          () async {
+        p = project(
+            mainSrc: 'int get foo => null;\n',
+            analysisOptions: 'include: package:lints/recommended.yaml\nf');
+        var result = await p.runAnalyze([]);
+
+        expect(result.exitCode, 3);
+        expect(result.stderr, isEmpty);
+
+        final stdout = result.stdout;
+        final expectedOutput = '''
+Analyzing myapp...
+
+Errors were found in 'pubspec.yaml' and/or 'analysis_options.yaml' which might result in either invalid diagnostics being produced or valid diagnostics being missed.
+
+  error - analysis_options.yaml:2:1 - Could not find expected ':' for simple key. - parse_error
+
+Errors in remaining files.
+
+  error - lib${path.separator}main.dart:1:16 - A value of type 'Null' can't be returned from the function 'foo' because it has a return type of 'int'. - return_of_invalid_type
+
+2 issues found.
+''';
+        expect(stdout.trim(), expectedOutput.trim());
+      });
+
+      test('prioritizes errors in analysis_options.yaml (without other errors)',
+          () async {
+        p = project(
+            mainSrc: 'int get foo => 1;\n',
+            analysisOptions: 'include: package:lints/recommended.yaml\nf');
+        var result = await p.runAnalyze([]);
+
+        expect(result.exitCode, 3);
+        expect(result.stderr, isEmpty);
+
+        final stdout = result.stdout;
+        final expectedOutput = '''
+Analyzing myapp...
+
+Errors were found in 'pubspec.yaml' and/or 'analysis_options.yaml' which might result in either invalid diagnostics being produced or valid diagnostics being missed.
+
+  error - analysis_options.yaml:2:1 - Could not find expected ':' for simple key. - parse_error
+
+1 issue found.
+''';
+        expect(stdout.trim(), expectedOutput.trim());
+      });
+
+      test('does not prioritize warnings in analysis_options.yaml', () async {
+        p = project(
+            mainSrc: 'int get foo => null;\n',
+            analysisOptions: 'include: package:lints/recommended.yaml');
+        var result = await p.runAnalyze([]);
+
+        expect(result.exitCode, 3);
+        expect(result.stderr, isEmpty);
+
+        final stdout = result.stdout;
+        final expectedOutput = '''
+Analyzing myapp...
+
+  error - lib${path.separator}main.dart:1:16 - A value of type 'Null' can't be returned from the function 'foo' because it has a return type of 'int'. - return_of_invalid_type
+warning - analysis_options.yaml:1:10 - The include file 'package:lints/recommended.yaml' in '${p.analysisOptionsPath}' can't be found when analyzing '${p.dirPath}'. - include_file_not_found
+
+2 issues found.
+''';
+        expect(stdout.trim(), expectedOutput.trim());
+      });
     });
 
     group('json', () {

pkg/dartdev/test/utils.dart

@@ -64,6 +64,8 @@ class TestProject {
 
   String get mainPath => path.join(dirPath, relativeFilePath);
 
+  String get analysisOptionsPath => path.join(dirPath, 'analysis_options.yaml');
+
   String get packageConfigPath => path.join(
         dirPath,
         '.dart_tool',