only report lint reference diagnostics for local lints

See: https://github.com/dart-lang/lints/issues/95

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

Author: pq

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

@@ -61,10 +61,13 @@ class LinterRuleOptionsValidator extends OptionsValidator {
 
   final LintRuleProvider ruleProvider;
   final VersionConstraint? sdkVersionConstraint;
+  final bool sourceIsOptionsForContextRoot;
 
-  LinterRuleOptionsValidator(
-      {LintRuleProvider? provider, this.sdkVersionConstraint})
-      : ruleProvider = provider ?? (() => Registry.ruleRegistry.rules);
+  LinterRuleOptionsValidator({
+    LintRuleProvider? provider,
+    this.sdkVersionConstraint,
+    this.sourceIsOptionsForContextRoot = true,
+  }) : ruleProvider = provider ?? (() => Registry.ruleRegistry.rules);
 
   bool currentSdkAllows(Version? since) {
     if (since == null) return true;
@@ -128,18 +131,24 @@ class LinterRuleOptionsValidator extends OptionsValidator {
           reporter.reportErrorForSpan(DUPLICATE_RULE_HINT, node.span, [value]);
         }
       }
-      var state = rule.state;
-      if (isDeprecatedInCurrentSdk(state)) {
-        reporter.reportErrorForSpan(DEPRECATED_LINT_HINT, node.span, [value]);
-      } else if (isRemovedInCurrentSdk(state)) {
-        var since = state.since.toString();
-        var replacedBy = (state as RemovedState).replacedBy;
-        if (replacedBy != null) {
-          reporter.reportErrorForSpan(AnalysisOptionsWarningCode.REPLACED_LINT,
-              node.span, [value, since, replacedBy]);
-        } else {
-          reporter.reportErrorForSpan(AnalysisOptionsWarningCode.REMOVED_LINT,
-              node.span, [value, since]);
+      // Report removed or deprecated lint warnings defined directly (and not in
+      // includes).
+      if (sourceIsOptionsForContextRoot) {
+        var state = rule.state;
+        if (isDeprecatedInCurrentSdk(state)) {
+          reporter.reportErrorForSpan(DEPRECATED_LINT_HINT, node.span, [value]);
+        } else if (isRemovedInCurrentSdk(state)) {
+          var since = state.since.toString();
+          var replacedBy = (state as RemovedState).replacedBy;
+          if (replacedBy != null) {
+            reporter.reportErrorForSpan(
+                AnalysisOptionsWarningCode.REPLACED_LINT,
+                node.span,
+                [value, since, replacedBy]);
+          } else {
+            reporter.reportErrorForSpan(AnalysisOptionsWarningCode.REMOVED_LINT,
+                node.span, [value, since]);
+          }
         }
       }
     }

pkg/analyzer/lib/src/task/options.dart

@@ -32,8 +32,9 @@ List<AnalysisError> analyzeAnalysisOptions(
   String content,
   SourceFactory sourceFactory,
   String contextRoot,
-  VersionConstraint? sdkVersionConstraint,
-) {
+  VersionConstraint? sdkVersionConstraint, {
+  LintRuleProvider? provider,
+}) {
   List<AnalysisError> errors = [];
   Source initialSource = source;
   SourceSpan? initialIncludeSpan;
@@ -73,11 +74,14 @@ List<AnalysisError> analyzeAnalysisOptions(
   }
 
   // Validate the specified options and any included option files.
-  void validate(Source source, YamlMap options) {
+  void validate(Source source, YamlMap options, LintRuleProvider? provider) {
     var sourceIsOptionsForContextRoot = initialIncludeSpan == null;
-    var validationErrors =
-        OptionsFileValidator(source, sdkVersionConstraint: sdkVersionConstraint)
-            .validate(options);
+    var validationErrors = OptionsFileValidator(
+      source,
+      sdkVersionConstraint: sdkVersionConstraint,
+      sourceIsOptionsForContextRoot: sourceIsOptionsForContextRoot,
+      provider: provider,
+    ).validate(options);
     addDirectErrorOrIncludedError(validationErrors, source,
         sourceIsOptionsForContextRoot: sourceIsOptionsForContextRoot);
 
@@ -131,7 +135,7 @@ List<AnalysisError> analyzeAnalysisOptions(
     try {
       var includedOptions =
           optionsProvider.getOptionsFromString(includedSource.contents.data);
-      validate(includedSource, includedOptions);
+      validate(includedSource, includedOptions, provider);
       firstPluginName ??= _firstPluginName(includedOptions);
       // Validate the 'plugins' option in [options], taking into account any
       // plugins enabled by [includedOptions].
@@ -161,7 +165,7 @@ List<AnalysisError> analyzeAnalysisOptions(
 
   try {
     YamlMap options = optionsProvider.getOptionsFromString(content);
-    validate(source, options);
+    validate(source, options, provider);
   } on OptionsFormatException catch (e) {
     SourceSpan span = e.span!;
     errors.add(AnalysisError(source, span.start.offset, span.length,
@@ -694,14 +698,19 @@ class OptionsFileValidator {
 
   final List<OptionsValidator> _validators;
 
-  OptionsFileValidator(this.source,
-      {required VersionConstraint? sdkVersionConstraint})
-      : _validators = [
+  OptionsFileValidator(
+    this.source, {
+    required VersionConstraint? sdkVersionConstraint,
+    required bool sourceIsOptionsForContextRoot,
+    LintRuleProvider? provider,
+  }) : _validators = [
           AnalyzerOptionsValidator(),
           CodeStyleOptionsValidator(),
           LinterOptionsValidator(),
           LinterRuleOptionsValidator(
+            provider: provider,
             sdkVersionConstraint: sdkVersionConstraint,
+            sourceIsOptionsForContextRoot: sourceIsOptionsForContextRoot,
           ),
         ];
 

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

@@ -6,6 +6,7 @@ import 'package:_fe_analyzer_shared/src/base/errors.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/src/context/source.dart';
 import 'package:analyzer/src/generated/source.dart';
+import 'package:analyzer/src/lint/options_rule_validator.dart';
 import 'package:analyzer/src/task/options.dart';
 import 'package:analyzer/src/test_utilities/resource_provider_mixin.dart';
 import 'package:pub_semver/pub_semver.dart';
@@ -18,11 +19,20 @@ abstract class AbstractAnalysisOptionsTest with ResourceProviderMixin {
   VersionConstraint? get sdkVersionConstraint => null;
 
   Future<void> assertErrorsInCode(
-      String code, List<ExpectedError> expectedErrors) async {
+    String code,
+    List<ExpectedError> expectedErrors, {
+    LintRuleProvider? provider,
+  }) async {
     var path = convertPath('/analysis_options.yaml');
     newFile(path, code);
     var diagnostics = analyzeAnalysisOptions(
-        TestSource(path), code, sourceFactory, '/', sdkVersionConstraint);
+      TestSource(path),
+      code,
+      sourceFactory,
+      '/',
+      sdkVersionConstraint,
+      provider: provider,
+    );
     var errorListener = GatheringErrorListener();
     errorListener.addAll(diagnostics);
     errorListener.assertErrors(expectedErrors);

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

@@ -15,10 +15,12 @@ import 'package:test_reflective_loader/test_reflective_loader.dart';
 import 'package:yaml/yaml.dart';
 
 import '../../generated/test_support.dart';
+import '../diagnostics/analysis_options/analysis_options_test_support.dart';
 
 main() {
   defineReflectiveSuite(() {
     defineReflectiveTests(OptionsRuleValidatorTest);
+    defineReflectiveTests(OptionsRuleValidatorIncludedFileTest);
   });
 }
 
@@ -45,34 +47,44 @@ class DeprecatedSince3Lint extends LintRule {
 }
 
 @reflectiveTest
-class OptionsRuleValidatorTest extends Object with ResourceProviderMixin {
-  final rules = [
-    DeprecatedLint(),
-    DeprecatedSince3Lint(),
-    StableLint(),
-    RuleNeg(),
-    RulePos(),
-    RemovedIn2_12Lint(),
-    ReplacedLint(),
-    ReplacingLint(),
-  ];
+class OptionsRuleValidatorIncludedFileTest extends AbstractAnalysisOptionsTest
+    with OptionsRuleValidatorTestMixin {
+  test_deprecated_rule_inInclude_ok() {
+    newFile('/included.yaml', '''
+linter:
+  rules:
+    - deprecated_lint
+''');
 
-  /// Assert that when the validator is used on the given [content] the
-  /// [expectedErrorCodes] are produced.
-  void assertErrors(String content, List<ErrorCode> expectedErrorCodes,
-      {VersionConstraint? sdk}) {
-    GatheringErrorListener listener = GatheringErrorListener();
-    ErrorReporter reporter = ErrorReporter(
-      listener,
-      StringSource(content, 'analysis_options.yaml'),
-      isNonNullableByDefault: false,
+    assertErrorsInCode(
+      '''
+include: included.yaml
+''',
+      [],
+      provider: () => rules,
     );
-    var validator = LinterRuleOptionsValidator(
-        provider: () => rules, sdkVersionConstraint: sdk);
-    validator.validate(reporter, loadYamlNode(content) as YamlMap);
-    listener.assertErrorsWithCodes(expectedErrorCodes);
   }
 
+  test_removed_rule_inInclude_ok() {
+    newFile('/included.yaml', '''
+linter:
+  rules:
+    - removed_in_2_12_lint
+''');
+
+    assertErrorsInCode(
+      '''
+include: included.yaml
+''',
+      [],
+      provider: () => rules,
+    );
+  }
+}
+
+@reflectiveTest
+class OptionsRuleValidatorTest
+    with OptionsRuleValidatorTestMixin, ResourceProviderMixin {
   test_deprecated_rule() {
     assertErrors('''
 linter:
@@ -231,6 +243,35 @@ linter:
   }
 }
 
+mixin OptionsRuleValidatorTestMixin {
+  final rules = [
+    DeprecatedLint(),
+    DeprecatedSince3Lint(),
+    StableLint(),
+    RuleNeg(),
+    RulePos(),
+    RemovedIn2_12Lint(),
+    ReplacedLint(),
+    ReplacingLint(),
+  ];
+
+  /// Assert that when the validator is used on the given [content] the
+  /// [expectedErrorCodes] are produced.
+  void assertErrors(String content, List<ErrorCode> expectedErrorCodes,
+      {VersionConstraint? sdk}) {
+    GatheringErrorListener listener = GatheringErrorListener();
+    ErrorReporter reporter = ErrorReporter(
+      listener,
+      StringSource(content, 'analysis_options.yaml'),
+      isNonNullableByDefault: false,
+    );
+    var validator = LinterRuleOptionsValidator(
+        provider: () => rules, sdkVersionConstraint: sdk);
+    validator.validate(reporter, loadYamlNode(content) as YamlMap);
+    listener.assertErrorsWithCodes(expectedErrorCodes);
+  }
+}
+
 class RemovedIn2_12Lint extends LintRule {
   RemovedIn2_12Lint()
       : super(

pkg/analyzer/test/src/task/options_test.dart

@@ -271,8 +271,11 @@ class ErrorProcessorMatcher extends Matcher {
 
 @reflectiveTest
 class OptionsFileValidatorTest {
-  final OptionsFileValidator validator =
-      OptionsFileValidator(TestSource(), sdkVersionConstraint: null);
+  final OptionsFileValidator validator = OptionsFileValidator(
+    TestSource(),
+    sdkVersionConstraint: null,
+    sourceIsOptionsForContextRoot: true,
+  );
   final AnalysisOptionsProvider optionsProvider = AnalysisOptionsProvider();
 
   test_analyzer_cannotIgnore_badValue() {