[analyzer] Fixes included diagnostics for analysis_options

This change fixes the offset of some diagnostics so they better align with what they are analysing. Also fixes a false-positive for `included_file_warning`.

Fixes: #61147
Change-Id: I3ec7f7a5042fc230410ad3b28453ab60fe6d452e
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/448061
Auto-Submit: Felipe Morschel <[email protected]>
Commit-Queue: Konstantin Shcheglov <[email protected]>
Reviewed-by: Samuel Rawlins <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>

Author: FMorschel

pkg/analyzer/lib/src/analysis_options/options_file_validator.dart

@@ -201,14 +201,18 @@ List<Diagnostic> analyzeAnalysisOptions(
       }
     }
 
-    if (includeNode is YamlScalar) {
-      validateInclude(includeNode);
-    } else if (includeNode is YamlList) {
-      for (var includeValue in includeNode.nodes) {
-        if (includeValue is YamlScalar) {
-          validateInclude(includeValue);
-        }
+    var includes = switch (includeNode) {
+      YamlScalar node => [node],
+      YamlList(:var nodes) => nodes.whereType<YamlScalar>().toList(),
+      _ => const <YamlScalar>[],
+    };
+
+    for (var includeValue in includes) {
+      if (sourceIsOptionsForContextRoot) {
+        initialIncludeSpan = null;
+        includeChain.clear();
       }
+      validateInclude(includeValue);
     }
   }
 

pkg/analyzer/test/src/diagnostics/analysis_options/include_file_not_found_test.dart

@@ -24,6 +24,30 @@ include: "./analysis_options.yaml"
     );
   }
 
+  Future<void> test_notFound_existent_list_first() async {
+    newFile('/included1.yaml', '');
+    await assertErrorsInCode(
+      '''
+include:
+  - ./analysis_options.yaml
+  - included1.yaml
+''',
+      [error(AnalysisOptionsWarningCode.recursiveIncludeFile, 13, 23)],
+    );
+  }
+
+  Future<void> test_notFound_existent_list_second() async {
+    newFile('/included1.yaml', '');
+    await assertErrorsInCode(
+      '''
+include:
+  - included1.yaml
+  - ./analysis_options.yaml
+''',
+      [error(AnalysisOptionsWarningCode.recursiveIncludeFile, 32, 23)],
+    );
+  }
+
   Future<void> test_notFound_existent_notQuoted() async {
     await assertErrorsInCode(
       '''
@@ -55,7 +79,54 @@ include: "package:pedantic/analysis_options.yaml"
           40,
           text:
               "The include file 'package:pedantic/analysis_options.yaml'"
-              " in '${convertPath('/analysis_options.yaml')}' can't be found when analyzing '/'.",
+              " in '${convertPath('/analysis_options.yaml')}' can't be found "
+              "when analyzing '/'.",
+        ),
+      ],
+    );
+  }
+
+  Future<void> test_notFound_nonexistent_list_first() async {
+    newFile('/included1.yaml', '');
+    await assertErrorsInCode(
+      '''
+# We don't depend on pedantic, but we should consider adding it.
+include:
+  - package:pedantic/analysis_options.yaml
+  - included1.yaml
+''',
+      [
+        error(
+          AnalysisOptionsWarningCode.includeFileNotFound,
+          78,
+          38,
+          text:
+              "The include file 'package:pedantic/analysis_options.yaml'"
+              " in '${convertPath('/analysis_options.yaml')}' can't be found "
+              "when analyzing '/'.",
+        ),
+      ],
+    );
+  }
+
+  Future<void> test_notFound_nonexistent_list_second() async {
+    newFile('/included1.yaml', '');
+    await assertErrorsInCode(
+      '''
+# We don't depend on pedantic, but we should consider adding it.
+include:
+  - included1.yaml
+  - package:pedantic/analysis_options.yaml
+''',
+      [
+        error(
+          AnalysisOptionsWarningCode.includeFileNotFound,
+          97,
+          38,
+          text:
+              "The include file 'package:pedantic/analysis_options.yaml'"
+              " in '${convertPath('/analysis_options.yaml')}' can't be found "
+              "when analyzing '/'.",
         ),
       ],
     );
@@ -74,7 +145,8 @@ include: package:pedantic/analysis_options.yaml
           38,
           text:
               "The include file 'package:pedantic/analysis_options.yaml'"
-              " in '${convertPath('/analysis_options.yaml')}' can't be found when analyzing '/'.",
+              " in '${convertPath('/analysis_options.yaml')}' can't be found "
+              "when analyzing '/'.",
         ),
       ],
     );
@@ -93,7 +165,8 @@ include: 'package:pedantic/analysis_options.yaml'
           40,
           text:
               "The include file 'package:pedantic/analysis_options.yaml'"
-              " in '${convertPath('/analysis_options.yaml')}' can't be found when analyzing '/'.",
+              " in '${convertPath('/analysis_options.yaml')}' can't be found "
+              "when analyzing '/'.",
         ),
       ],
     );

pkg/analyzer/test/src/diagnostics/analysis_options/recursive_include_file_test.dart

@@ -27,7 +27,8 @@ include: analysis_options.yaml
           21,
           text:
               "The include file 'analysis_options.yaml' "
-              "in '${convertPath('/analysis_options.yaml')}' includes itself recursively.",
+              "in '${convertPath('/analysis_options.yaml')}' includes itself "
+              'recursively.',
         ),
       ],
     );
@@ -46,12 +47,25 @@ include:
           21,
           text:
               "The include file 'analysis_options.yaml' "
-              "in '${convertPath('/analysis_options.yaml')}' includes itself recursively.",
+              "in '${convertPath('/analysis_options.yaml')}' includes itself "
+              'recursively.',
         ),
       ],
     );
   }
 
+  Future<void> test_notRecursive() async {
+    newFile('/a.yaml', '''
+include: b.yaml
+''');
+    newFile('/b.yaml', '');
+    await assertNoErrorsInCode('''
+include:
+  - a.yaml
+  - b.yaml
+''');
+  }
+
   Future<void> test_recursive() async {
     newFile('/a.yaml', '''
 include: b.yaml
@@ -116,8 +130,8 @@ include:
       [
         error(
           AnalysisOptionsWarningCode.recursiveIncludeFile,
-          13,
-          10,
+          28,
+          6,
           text:
               "The include file 'analysis_options.yaml' "
               "in '${convertPath('/b.yaml')}' includes itself recursively.",