[DAS] Adds some warnings for the analysis_options file

Adds `incompatible_lint` for included rules (and some variants of it) and `unsupported_value` error for linter rules values.

Original change: https://dart-review.googlesource.com/c/sdk/+/419982
Original change reverted at: https://dart-review.googlesource.com/c/sdk/+/429381

Fixes: #60125

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

Author: FMorschel

pkg/analysis_server/lib/src/context_manager.dart

@@ -398,6 +398,7 @@ class ContextManagerImpl implements ContextManager {
         driver.sourceFactory,
         driver.currentSession.analysisContext.contextRoot.root.path,
         sdkVersionConstraint,
+        resourceProvider,
       );
       var converter = AnalyzerConverter();
       convertedErrors = converter.convertAnalysisErrors(

pkg/analysis_server/lib/src/handler/legacy/edit_get_fixes.dart

@@ -133,6 +133,7 @@ class EditGetFixesHandler extends LegacyHandler
       sourceFactory,
       analysisContext.contextRoot.root.path,
       sdkVersionConstraint,
+      resourceProvider,
     );
     var options = _getOptions(sourceFactory, content);
     if (options == null) {

pkg/analysis_server/lib/src/lsp/handlers/code_actions/analysis_options.dart

@@ -87,6 +87,7 @@ class AnalysisOptionsCodeActionsProducer extends AbstractCodeActionsProducer {
       sourceFactory,
       contextRoot.root.path,
       sdkVersionConstraint,
+      resourceProvider,
     );
 
     var codeActions = <CodeActionWithPriority>[];

pkg/analysis_server/lib/src/services/correction/error_fix_status.yaml

@@ -86,10 +86,20 @@ AnalysisOptionsWarningCode.INCLUDED_FILE_WARNING:
   notes: |-
     The fix needs to be made in the included file.
 AnalysisOptionsWarningCode.INCOMPATIBLE_LINT:
-  status: noFix
+  status: needsFix
+  notes: |-
+    Allowing the user to select which rule they would prefer to use so we can
+    remove the incompatible ones.
+AnalysisOptionsWarningCode.INCOMPATIBLE_LINT_FILES:
+  status: needsFix
+  notes: |-
+    Allowing the user to select which rule they would prefer to use so we can
+    disable the incompatible ones.
+AnalysisOptionsWarningCode.INCOMPATIBLE_LINT_INCLUDED:
+  status: needsFix
   notes: |-
-    Without knowing which rule the user would prefer to use, we cannot remove
-    the reported one.
+    Allowing the user to select which rule they would prefer to use so we can
+    disable the incompatible ones.
 AnalysisOptionsWarningCode.INVALID_OPTION:
   status: needsFix
   notes: |-

pkg/analysis_server/test/services/linter/linter_test.dart

@@ -9,6 +9,7 @@ import 'package:analyzer/source/source.dart';
 import 'package:analyzer/src/analysis_options/analysis_options_provider.dart';
 import 'package:analyzer/src/analysis_options/error/option_codes.dart';
 import 'package:analyzer/src/lint/options_rule_validator.dart';
+import 'package:analyzer_testing/resource_provider_mixin.dart';
 import 'package:linter/src/rules.dart';
 import 'package:test/test.dart';
 import 'package:test_reflective_loader/test_reflective_loader.dart';
@@ -20,14 +21,17 @@ void main() {
 }
 
 @reflectiveTest
-class LinterRuleOptionsValidatorTest {
+class LinterRuleOptionsValidatorTest with ResourceProviderMixin {
   late RecordingDiagnosticListener recorder;
 
   late DiagnosticReporter reporter;
 
   List<Diagnostic> get diagnostics => recorder.diagnostics;
 
-  LinterRuleOptionsValidator get validator => LinterRuleOptionsValidator();
+  LinterRuleOptionsValidator get validator => LinterRuleOptionsValidator(
+    optionsProvider: AnalysisOptionsProvider(),
+    resourceProvider: resourceProvider,
+  );
 
   void setUp() {
     registerLintRules();

pkg/analysis_server/test/src/services/correction/fix/analysis_options/test_support.dart

@@ -52,6 +52,7 @@ class AnalysisOptionsFixTest with ResourceProviderMixin {
       sourceFactory,
       '/',
       dart2_12,
+      resourceProvider,
     );
     if (diagnosticFilter != null) {
       if (errors.length == 1) {

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

@@ -67,34 +67,36 @@ class AnalysisOptionsProvider {
   /// Recursively merges options referenced by any `include` directives and
   /// removes any `include` directives from the resulting options map. Returns
   /// an empty options map if the file does not exist or cannot be parsed.
-  YamlMap getOptionsFromSource(Source source) {
+  YamlMap getOptionsFromSource(Source source, {Set<Source>? handled}) {
+    handled ??= {};
     try {
       var options = getOptionsFromString(_readAnalysisOptions(source));
       if (_sourceFactory == null) {
         return options;
       }
       var includeValue = options.valueAt(AnalysisOptionsFile.include);
-      if (includeValue case YamlScalar(value: String path)) {
+      var includes = switch (includeValue) {
+        YamlScalar(:String value) => [value],
+        YamlList() =>
+          includeValue.nodes
+              .whereType<YamlScalar>()
+              .map((e) => e.value)
+              .whereType<String>()
+              .toList(),
+        _ => <String>[],
+      };
+      var includeOptions = includes.fold(YamlMap(), (options, path) {
         var includeUri = _sourceFactory.resolveUri(source, path);
-        if (includeUri != null) {
-          options = merge(getOptionsFromSource(includeUri), options);
+        if (includeUri == null || !handled!.add(includeUri)) {
+          // Return the existing options, unchanged.
+          return options;
         }
-      } else if (includeValue is YamlList) {
-        var includePaths =
-            includeValue.nodes
-                .whereType<YamlScalar>()
-                .map((e) => e.value)
-                .whereType<String>();
-        var includeOptions = includePaths.fold(YamlMap(), (options, path) {
-          var includeUri = _sourceFactory.resolveUri(source, path);
-          if (includeUri == null) {
-            // Return the existing options, unchanged.
-            return options;
-          }
-          return merge(options, getOptionsFromSource(includeUri));
-        });
-        options = merge(includeOptions, options);
-      }
+        return merge(
+          options,
+          getOptionsFromSource(includeUri, handled: handled),
+        );
+      });
+      options = merge(includeOptions, options);
       return options;
     } on OptionsFormatException {
       return YamlMap();
@@ -106,12 +108,12 @@ class AnalysisOptionsProvider {
   /// An 'include' directive, if present, will be left as-is, and the referenced
   /// options will NOT be merged into the result. Returns an empty options map
   /// if the content is null, or not a YAML map.
-  YamlMap getOptionsFromString(String? content) {
+  YamlMap getOptionsFromString(String? content, {Uri? sourceUrl}) {
     if (content == null) {
       return YamlMap();
     }
     try {
-      var doc = loadYamlNode(content);
+      var doc = loadYamlNode(content, sourceUrl: sourceUrl);
       return doc is YamlMap ? doc : YamlMap();
     } on YamlException catch (e) {
       throw OptionsFormatException(e.message, e.span);

pkg/analyzer/lib/src/analysis_options/error/option_codes.g.dart

@@ -261,20 +261,75 @@ class AnalysisOptionsWarningCode extends DiagnosticCodeWithExpectedTypes {
 
   /// An error code indicating an incompatible rule.
   ///
+  /// The incompatible rules must be included by context messages.
+  ///
   /// Parameters:
   /// String p0: the rule name
-  /// String p1: the incompatible rule
+  /// String p1: the incompatible rules
   static const AnalysisOptionsWarningTemplate<
     LocatableDiagnostic Function({required String p0, required String p1})
   >
   incompatibleLint = AnalysisOptionsWarningTemplate(
     'INCOMPATIBLE_LINT',
-    "The rule '{0}' is incompatible with the rule '{1}'.",
-    correctionMessage: "Try removing one of the incompatible rules.",
+    "The rule '{0}' is incompatible with {1}.",
+    correctionMessage: "Try removing all but one of the incompatible rules.",
     withArguments: _withArgumentsIncompatibleLint,
     expectedTypes: [ExpectedType.string, ExpectedType.string],
   );
 
+  /// An error code indicating an incompatible rule.
+  ///
+  /// The files that enable the referenced rules must be included by context messages.
+  ///
+  /// Parameters:
+  /// String p0: the rule name
+  /// String p1: the incompatible rules
+  static const AnalysisOptionsWarningTemplate<
+    LocatableDiagnostic Function({required String p0, required String p1})
+  >
+  incompatibleLintFiles = AnalysisOptionsWarningTemplate(
+    'INCOMPATIBLE_LINT',
+    "The rule '{0}' is incompatible with {1}.",
+    correctionMessage:
+        "Try locally disabling all but one of the conflicting rules or "
+        "removing one of the incompatible files.",
+    uniqueName: 'INCOMPATIBLE_LINT_FILES',
+    withArguments: _withArgumentsIncompatibleLintFiles,
+    expectedTypes: [ExpectedType.string, ExpectedType.string],
+  );
+
+  /// An error code indicating an incompatible rule.
+  ///
+  /// Parameters:
+  /// String p0: the rule name
+  /// String p1: the incompatible rules
+  /// int p2: the number of files that include the incompatible rule
+  /// String p3: plural suffix for the word "file"
+  static const AnalysisOptionsWarningTemplate<
+    LocatableDiagnostic Function({
+      required String p0,
+      required String p1,
+      required int p2,
+      required String p3,
+    })
+  >
+  incompatibleLintIncluded = AnalysisOptionsWarningTemplate(
+    'INCOMPATIBLE_LINT',
+    "The rule '{0}' is incompatible with '{1}', which is included from {2} "
+        "file{3}.",
+    correctionMessage:
+        "Try locally disabling all but one of the conflicting rules or "
+        "removing one of the incompatible files.",
+    uniqueName: 'INCOMPATIBLE_LINT_INCLUDED',
+    withArguments: _withArgumentsIncompatibleLintIncluded,
+    expectedTypes: [
+      ExpectedType.string,
+      ExpectedType.string,
+      ExpectedType.int,
+      ExpectedType.string,
+    ],
+  );
+
   /// An error code indicating that a plugin is being configured with an invalid
   /// value for an option and a detail message is provided.
   ///
@@ -481,12 +536,12 @@ class AnalysisOptionsWarningCode extends DiagnosticCodeWithExpectedTypes {
   ///
   /// Parameters:
   /// String p0: the option name
-  /// int p1: the unsupported value
+  /// Object p1: the unsupported value
   /// String p2: legal values
   static const AnalysisOptionsWarningTemplate<
     LocatableDiagnostic Function({
       required String p0,
-      required int p1,
+      required Object p1,
       required String p2,
     })
   >
@@ -495,7 +550,11 @@ class AnalysisOptionsWarningCode extends DiagnosticCodeWithExpectedTypes {
     "The value '{1}' isn't supported by '{0}'.",
     correctionMessage: "Try using one of the supported options: {2}.",
     withArguments: _withArgumentsUnsupportedValue,
-    expectedTypes: [ExpectedType.string, ExpectedType.int, ExpectedType.string],
+    expectedTypes: [
+      ExpectedType.string,
+      ExpectedType.object,
+      ExpectedType.string,
+    ],
   );
 
   /// Initialize a newly created error code to have the given [name].
@@ -577,6 +636,22 @@ class AnalysisOptionsWarningCode extends DiagnosticCodeWithExpectedTypes {
     return LocatableDiagnosticImpl(incompatibleLint, [p0, p1]);
   }
 
+  static LocatableDiagnostic _withArgumentsIncompatibleLintFiles({
+    required String p0,
+    required String p1,
+  }) {
+    return LocatableDiagnosticImpl(incompatibleLintFiles, [p0, p1]);
+  }
+
+  static LocatableDiagnostic _withArgumentsIncompatibleLintIncluded({
+    required String p0,
+    required String p1,
+    required int p2,
+    required String p3,
+  }) {
+    return LocatableDiagnosticImpl(incompatibleLintIncluded, [p0, p1, p2, p3]);
+  }
+
   static LocatableDiagnostic _withArgumentsInvalidOption({
     required String p0,
     required String p1,
@@ -661,7 +736,7 @@ class AnalysisOptionsWarningCode extends DiagnosticCodeWithExpectedTypes {
 
   static LocatableDiagnostic _withArgumentsUnsupportedValue({
     required String p0,
-    required int p1,
+    required Object p1,
     required String p2,
   }) {
     return LocatableDiagnosticImpl(unsupportedValue, [p0, p1, p2]);

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

@@ -6,6 +6,7 @@ import 'package:analyzer/dart/analysis/formatter_options.dart';
 import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/error/listener.dart';
+import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/source/source.dart';
 import 'package:analyzer/src/analysis_options/analysis_options_file.dart';
 import 'package:analyzer/src/analysis_options/analysis_options_provider.dart';
@@ -29,6 +30,7 @@ List<Diagnostic> analyzeAnalysisOptions(
   SourceFactory sourceFactory,
   String contextRoot,
   VersionConstraint? sdkVersionConstraint,
+  ResourceProvider resourceProvider,
 ) {
   List<Diagnostic> errors = [];
   Source initialSource = source;
@@ -81,6 +83,8 @@ List<Diagnostic> analyzeAnalysisOptions(
       source,
       sdkVersionConstraint: sdkVersionConstraint,
       sourceIsOptionsForContextRoot: sourceIsOptionsForContextRoot,
+      optionsProvider: optionsProvider,
+      resourceProvider: resourceProvider,
     ).validate(options);
     addDirectErrorOrIncludedError(
       validationErrors,
@@ -209,7 +213,10 @@ List<Diagnostic> analyzeAnalysisOptions(
   }
 
   try {
-    YamlMap options = optionsProvider.getOptionsFromString(content);
+    YamlMap options = optionsProvider.getOptionsFromString(
+      content,
+      sourceUrl: source.uri,
+    );
     validate(source, options);
   } on OptionsFormatException catch (e) {
     SourceSpan span = e.span!;
@@ -286,12 +293,16 @@ class OptionsFileValidator {
     this._source, {
     VersionConstraint? sdkVersionConstraint,
     required bool sourceIsOptionsForContextRoot,
+    required AnalysisOptionsProvider optionsProvider,
+    required ResourceProvider resourceProvider,
   }) : _validators = [
          AnalyzerOptionsValidator(),
          _CodeStyleOptionsValidator(),
          _FormatterOptionsValidator(),
          _LinterTopLevelOptionsValidator(),
          LinterRuleOptionsValidator(
+           resourceProvider: resourceProvider,
+           optionsProvider: optionsProvider,
            sdkVersionConstraint: sdkVersionConstraint,
            sourceIsOptionsForContextRoot: sourceIsOptionsForContextRoot,
          ),

pkg/analyzer/lib/src/diagnostic/diagnostic_code_values.g.dart

@@ -35,6 +35,8 @@ const List<DiagnosticCode> diagnosticCodeValues = [
   AnalysisOptionsWarningCode.includedFileWarning,
   AnalysisOptionsWarningCode.includeFileNotFound,
   AnalysisOptionsWarningCode.incompatibleLint,
+  AnalysisOptionsWarningCode.incompatibleLintFiles,
+  AnalysisOptionsWarningCode.incompatibleLintIncluded,
   AnalysisOptionsWarningCode.invalidOption,
   AnalysisOptionsWarningCode.invalidSectionFormat,
   AnalysisOptionsWarningCode.multiplePlugins,