[messages] Ignore case in LinterRuleOptionsValidator.

Now that lint name matching is case insensitive
(https://dart-review.googlesource.com/c/sdk/+/465964), it makes sense
for the LinterRuleOptionsValidator to ignore case when checking the
contents of `analysis_options.yaml` files.

This paves the way for a follow-up CL that will change the names
declared in the linter to all lower case.


Change-Id: I6a6a696430f1d99408902b115587ac8c3d22fbe8
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/466000
Commit-Queue: Paul Berry <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>

Author: stereotype441

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

@@ -65,10 +65,8 @@ class LinterRuleOptionsValidator extends OptionsValidator {
     this.isPrimarySource = true,
   });
 
-  AbstractAnalysisRule? getRegisteredLint(String value) => Registry
-      .ruleRegistry
-      .rules
-      .firstWhereOrNull((rule) => rule.name == value);
+  AbstractAnalysisRule? getRegisteredLint(String value) =>
+      Registry.ruleRegistry[value];
 
   bool isDeprecatedInCurrentOrEarlierSdk(RuleState state) =>
       state.isDeprecated && _beforeCurrentConstraint(state.since);
@@ -182,8 +180,13 @@ class LinterRuleOptionsValidator extends OptionsValidator {
     List<_IncompatibleRuleData> incompatibleRules = [];
     for (var incompatibleRule in rule.incompatibleRules) {
       for (var MapEntry(:key, value: rules) in rules.entries) {
-        if (rules.map((node) => node.value).contains(incompatibleRule)) {
-          var list = rules.where((scalar) => scalar.value == incompatibleRule);
+        if (rules
+            .map((node) => _safeToLower(node.value))
+            .contains(incompatibleRule.toLowerCase())) {
+          var list = rules.where(
+            (scalar) =>
+                _safeToLower(scalar.value) == incompatibleRule.toLowerCase(),
+          );
           for (var scalar in list) {
             var rule = getRegisteredLint(scalar.value.toString())!;
             incompatibleRules.add(
@@ -259,7 +262,9 @@ class LinterRuleOptionsValidator extends OptionsValidator {
         );
       }
     }
-    if (rules[null]!.map((e) => e.value).contains(ruleData.node.value)) {
+    if (rules[null]!
+        .map((e) => _safeToLower(e.value))
+        .contains(_safeToLower(ruleData.node.value))) {
       reporter.atSourceSpan(
         ruleData.node.span,
         diag.duplicateRule,
@@ -357,6 +362,9 @@ class LinterRuleOptionsValidator extends OptionsValidator {
     return seenRules;
   }
 
+  Object? _safeToLower(Object? value) =>
+      value is String ? value.toLowerCase() : value;
+
   void _validateRules(
     YamlNode? rules,
     DiagnosticReporter reporter,

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

@@ -203,6 +203,31 @@ include:
   - included1.yaml
   - included2.yaml
 
+linter:
+  rules:
+''',
+      [diag.incompatibleLintIncluded],
+    );
+  }
+
+  Future<void>
+  test_incompatible_multiple_include_noLintMainFile_mixedCase() async {
+    newFile('/included1.yaml', '''
+linter:
+  rules:
+    - ruLe_neg
+''');
+    newFile('/included2.yaml', '''
+linter:
+  rules:
+    - rule_poS
+''');
+    assertErrors(
+      '''
+include:
+  - included1.yaml
+  - included2.yaml
+
 linter:
   rules:
 ''',
@@ -272,6 +297,36 @@ linter:
 ''');
   }
 
+  Future<void> test_incompatible_rule_map_include_mixedCase() async {
+    var includedCode = TestCode.parse('''
+linter:
+  rules:
+    [!rulE_neg!]: true
+''');
+    var included = newFile('/included.yaml', includedCode.code);
+    var testCode = TestCode.parse('''
+include: included.yaml
+
+linter:
+  rules:
+    [!Rule_pos!]: true
+''');
+    await assertErrorsInCode(testCode.code, [
+      error(
+        diag.incompatibleLintFiles,
+        testCode.range.sourceRange.offset,
+        testCode.range.sourceRange.length,
+        contextMessages: [
+          contextMessage(
+            included,
+            includedCode.range.sourceRange.offset,
+            includedCode.range.sourceRange.length,
+          ),
+        ],
+      ),
+    ]);
+  }
+
   void test_incompatible_trigger_invalidMap() {
     newFile('/included.yaml', '''
 linter:
@@ -309,6 +364,24 @@ linter:
     );
   }
 
+  void test_incompatible_unsuportedValue_invalidMap_mixedCase() {
+    newFile('/included.yaml', '''
+linter:
+  rules:
+    rUle_neg: true
+''');
+    assertErrors(
+      '''
+include: included.yaml
+
+linter:
+  rules:
+    Rule_pos: invalid_value
+''',
+      [diag.unsupportedValue],
+    );
+  }
+
   void test_package_import() {
     newFile('$otherLib/analysis_options.yaml', '''
 linter:
@@ -347,6 +420,18 @@ include: included.yaml
 linter:
   rules:
     - removed_in_2_12_lint
+''',
+      [diag.removedLint],
+      sdk: dart3_3,
+    );
+  }
+
+  test_removed_rule_previousSdk_mixedCase() {
+    assertErrors(
+      '''
+linter:
+  rules:
+    - remOved_in_2_12_lint
 ''',
       [diag.removedLint],
       sdk: dart3_3,
@@ -379,6 +464,28 @@ linter:
     );
   }
 
+  void test_deprecated_rule_map_mixedCase() {
+    assertErrors(
+      '''
+linter:
+  rules:
+    deprecated_lInt: false
+''',
+      [diag.deprecatedLint],
+    );
+  }
+
+  void test_deprecated_rule_mixedCase() {
+    assertErrors(
+      '''
+linter:
+  rules:
+    - deprecAted_lint
+''',
+      [diag.deprecatedLint],
+    );
+  }
+
   void test_deprecated_rule_previousSDK() {
     assertErrors(
       '''
@@ -402,6 +509,17 @@ linter:
     );
   }
 
+  void test_deprecated_rule_withReplacement_mixedCase() {
+    assertErrors(
+      '''
+linter:
+  rules:
+    - deprecated_lint_with_rePlacement
+''',
+      [diag.deprecatedLintWithReplacement],
+    );
+  }
+
   void test_deprecated_rule_withSince_inCurrentSdk() {
     assertErrors(
       '''
@@ -442,6 +560,18 @@ linter:
     );
   }
 
+  void test_duplicated_rule_mixedCase() {
+    assertErrors(
+      '''
+linter:
+  rules:
+    - stable_lint
+    - staBle_lint
+''',
+      [diag.duplicateRule],
+    );
+  }
+
   Future<void> test_incompatible_rule() async {
     var testCode = TestCode.parse('''
 linter:
@@ -497,6 +627,52 @@ linter:
 ''');
   }
 
+  Future<void> test_incompatible_rule_map_mixedCase() async {
+    var testCode = TestCode.parse('''
+linter:
+  rules:
+    /*[0*/Rule_pos/*0]*/: true
+    /*[1*/rUle_neg/*1]*/: true
+''');
+    await assertErrorsInCode(testCode.code, [
+      error(
+        diag.incompatibleLint,
+        testCode.ranges.last.sourceRange.offset,
+        testCode.ranges.last.sourceRange.length,
+        contextMessages: [
+          contextMessage(
+            analysisOptionsFile,
+            testCode.ranges.first.sourceRange.offset,
+            testCode.ranges.first.sourceRange.length,
+          ),
+        ],
+      ),
+    ]);
+  }
+
+  Future<void> test_incompatible_rule_mixedCase() async {
+    var testCode = TestCode.parse('''
+linter:
+  rules:
+    - /*[0*/rule_Pos/*0]*/
+    - /*[1*/rule_neG/*1]*/
+''');
+    await assertErrorsInCode(testCode.code, [
+      error(
+        diag.incompatibleLint,
+        testCode.ranges.last.sourceRange.offset,
+        testCode.ranges.last.sourceRange.length,
+        contextMessages: [
+          contextMessage(
+            analysisOptionsFile,
+            testCode.ranges.first.sourceRange.offset,
+            testCode.ranges.first.sourceRange.length,
+          ),
+        ],
+      ),
+    ]);
+  }
+
   void test_no_duplicated_rule_include() {
     newFile('/included.yaml', '''
 linter:
@@ -544,6 +720,18 @@ linter:
     );
   }
 
+  void test_replaced_rule_mixedCase() {
+    assertErrors(
+      '''
+linter:
+  rules:
+    - replaCed_lint
+''',
+      [diag.replacedLint],
+      sdk: dart3,
+    );
+  }
+
   void test_stable_rule() {
     assertNoErrors('''
 linter:
@@ -560,6 +748,22 @@ linter:
 ''');
   }
 
+  void test_stable_rule_map_mixedCase() {
+    assertNoErrors('''
+linter:
+  rules:
+    sTable_lint: true
+''');
+  }
+
+  void test_stable_rule_mixedCase() {
+    assertNoErrors('''
+linter:
+  rules:
+    - Stable_lint
+''');
+  }
+
   void test_undefined_rule() {
     assertErrors(
       '''