Validate incompatible lint rules

Change-Id: Ic57cdf7c7264c7d4da266f73a63b0b47e4a1d65a
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/130007
Commit-Queue: Phil Quitslund <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>

Author: pq

pkg/analyzer/lib/src/lint/options_rule_validator.dart

@@ -2,8 +2,6 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'dart:collection';
-
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/error/listener.dart';
 import 'package:analyzer/src/analysis_options/error/option_codes.dart';
@@ -34,6 +32,18 @@ const AnalysisOptionsHintCode DUPLICATE_RULE_HINT = AnalysisOptionsHintCode(
     "The rule {0} is already specified and doesn't need to be specified again.",
     correction: "Try removing all but one specification of the rule.");
 
+/**
+ * An error code indicating an incompatible rule.
+ *
+ * Parameters:
+ * 0: the rule name
+ * 1: the incompatible rule
+ */
+const AnalysisOptionsWarningCode INCOMPATIBLE_LINT_WARNING =
+    AnalysisOptionsWarningCode('INCOMPATIBLE_LINT_WARNING',
+        "The rule '{0}' is incompatible with the rule '{1}'",
+        correction: "Try removing one of the incompatible rules.");
+
 /**
  * An error code indicating an undefined lint rule.
  *
@@ -77,14 +87,31 @@ class LinterRuleOptionsValidator extends OptionsValidator {
 
   validateRules(YamlNode rules, ErrorReporter reporter) {
     if (rules is YamlList) {
-      Set<String> seenRules = HashSet<String>();
-      rules.nodes.forEach((YamlNode ruleNode) {
-        Object value = ruleNode.value;
+      final seenRules = <String>{};
+
+      String findIncompatibleRule(LintRule rule) {
+        for (var incompatibleRule in rule.incompatibleRules) {
+          if (seenRules.contains(incompatibleRule)) {
+            return incompatibleRule;
+          }
+        }
+        return null;
+      }
+
+      for (var ruleNode in rules.nodes) {
+        final value = ruleNode.value;
         if (value != null) {
-          LintRule rule = getRegisteredLint(value);
+          final rule = getRegisteredLint(value);
           if (rule == null) {
             reporter.reportErrorForSpan(
                 UNDEFINED_LINT_WARNING, ruleNode.span, [value]);
+            continue;
+          }
+
+          final incompatibleRule = findIncompatibleRule(rule);
+          if (incompatibleRule != null) {
+            reporter.reportErrorForSpan(INCOMPATIBLE_LINT_WARNING,
+                ruleNode.span, [value, incompatibleRule]);
           } else if (!seenRules.add(rule.name)) {
             reporter.reportErrorForSpan(
                 DUPLICATE_RULE_HINT, ruleNode.span, [value]);
@@ -93,7 +120,7 @@ class LinterRuleOptionsValidator extends OptionsValidator {
                 DEPRECATED_LINT_HINT, ruleNode.span, [value]);
           }
         }
-      });
+      }
     }
   }
 }

pkg/analyzer/test/src/options/options_rule_validator_test.dart

@@ -30,7 +30,7 @@ class DeprecatedLint extends LintRule {
 @reflectiveTest
 class OptionsRuleValidatorTest extends Object with ResourceProviderMixin {
   LinterRuleOptionsValidator validator = LinterRuleOptionsValidator(
-      provider: () => [DeprecatedLint(), StableLint()]);
+      provider: () => [DeprecatedLint(), StableLint(), RuleNeg(), RulePos()]);
 
 /**
  * Assert that when the validator is used on the given [content] the
@@ -64,6 +64,15 @@ linter:
       ''', [DUPLICATE_RULE_HINT]);
   }
 
+  test_incompatible_rule() {
+    assertErrors('''
+linter:
+  rules:
+    - rule_pos
+    - rule_neg
+      ''', [INCOMPATIBLE_LINT_WARNING]);
+  }
+
   test_stable_rule() {
     assertErrors('''
 linter:
@@ -86,3 +95,15 @@ class StableLint extends LintRule {
       : super(
             name: 'stable_lint', group: Group.style, maturity: Maturity.stable);
 }
+
+class RuleNeg extends LintRule {
+  RuleNeg() : super(name: 'rule_neg', group: Group.style);
+  @override
+  List<String> get incompatibleRules => ['rule_pos'];
+}
+
+class RulePos extends LintRule {
+  RulePos() : super(name: 'rule_pos', group: Group.style);
+  @override
+  List<String> get incompatibleRules => ['rule_neg'];
+}