fix: support package-level analysis options and rule suppression

lib/analysis_options.yaml

@@ -1,6 +1,4 @@
 analyzer:
-  plugins:
-    - custom_lint
   exclude:
     # General generated files
     - "**/*.g.dart"

lib/main.dart

@@ -1,5 +1,7 @@
 import 'package:analysis_server_plugin/plugin.dart';
 import 'package:analysis_server_plugin/registry.dart';
+import 'package:analyzer/analysis_rule/analysis_rule.dart';
+import 'package:solid_lints/src/common/constants.dart';
 import 'package:solid_lints/src/common/parameter_parser/analysis_options_loader.dart';
 import 'package:solid_lints/src/lints/avoid_debug_print_in_release/avoid_debug_print_in_release_rule.dart';
 import 'package:solid_lints/src/lints/avoid_final_with_getter/avoid_final_with_getter_rule.dart';
@@ -30,6 +32,8 @@ import 'package:solid_lints/src/lints/prefer_last/prefer_last_rule.dart';
 import 'package:solid_lints/src/lints/prefer_match_file_name/prefer_match_file_name_rule.dart';
 import 'package:solid_lints/src/lints/proper_super_calls/proper_super_calls_rule.dart';
 import 'package:solid_lints/src/lints/use_nearest_context/use_nearest_context_rule.dart';
+import 'package:solid_lints/src/models/proxy_analysis_rule.dart';
+import 'package:solid_lints/src/models/proxy_multi_analysis_rule.dart';
 import 'package:solid_lints/src/models/rule_with_fixes.dart';
 
 /// The entry point for the Solid Lints analyser server plugin.
@@ -44,7 +48,7 @@ final plugin = SolidLintsPlugin();
 /// by the Dart analyzer during code analysis.
 class SolidLintsPlugin extends Plugin {
   @override
-  String get name => 'solid_lints';
+  String get name => kPluginName;
 
   @override
   void register(PluginRegistry registry) {
@@ -83,7 +87,13 @@ class SolidLintsPlugin extends Plugin {
     ];
 
     for (final lintRule in lintRules) {
-      registry.registerLintRule(lintRule);
+      final ruleToRegister = switch (lintRule) {
+        MultiAnalysisRule() => ProxyMultiAnalysisRule(lintRule, analysisLoader),
+        AnalysisRule() => ProxyAnalysisRule(lintRule, analysisLoader),
+      };
+
+      registry.registerWarningRule(ruleToRegister);
+
       if (lintRule is RuleWithFixes) {
         for (final entry in (lintRule as RuleWithFixes).fixesForCodes) {
           registry.registerFixForRule(entry.key, entry.value);

lib/src/common/constants.dart

@@ -0,0 +1,2 @@
+/// Shared constants for the solid_lints package.
+const kPluginName = 'solid_lints';

lib/src/common/parameter_parser/analysis_options_loader.dart

@@ -1,17 +1,32 @@
 import 'package:analyzer/analysis_rule/rule_context.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/physical_file_system.dart';
+import 'package:solid_lints/src/common/parameter_parser/analysis_options_parser.dart';
 import 'package:solid_lints/src/common/parameter_parser/cached_package_rules.dart';
-import 'package:yaml/yaml.dart';
+import 'package:solid_lints/src/common/parameter_parser/package_config_resolver.dart';
 
 /// Loads and parses analysis options from a Dart project's YAML file.
 class AnalysisOptionsLoader {
   final ResourceProvider _resourceProvider;
   final Map<String, CachedPackageRules> _rulesCache = {};
 
-  /// Creates an instance of [AnalysisOptionsLoader]
-  AnalysisOptionsLoader({ResourceProvider? resourceProvider})
-    : _resourceProvider = resourceProvider ?? PhysicalResourceProvider.INSTANCE;
+  // Caches directory path -> nearest analysis_options.yaml file path
+  final Map<String, String?> _nearestYamlCache = {};
+
+  late final AnalysisOptionsParser _parser;
+
+  /// Creates an instance of [AnalysisOptionsLoader].
+  AnalysisOptionsLoader({
+    ResourceProvider? resourceProvider,
+    AnalysisOptionsParser? parser,
+  }) : _resourceProvider =
+            resourceProvider ?? PhysicalResourceProvider.INSTANCE {
+    _parser = parser ??
+        AnalysisOptionsParser(
+          _resourceProvider,
+          PackageConfigResolver(_resourceProvider),
+        );
+  }
 
   /// Gets the options for a specific rule by its name.
   Map<String, Object?>? getRuleOptions(RuleContext context, String ruleName) =>
@@ -36,6 +51,17 @@ class AnalysisOptionsLoader {
     return _rulesCache[yamlPath]?.rules[ruleName];
   }
 
+  /// Checks if a rule is explicitly disabled.
+  bool isRuleDisabled(RuleContext context, String ruleName) =>
+      _withNearestAnalysisOptionsFilePathForContext<bool>(
+        context,
+        (path) {
+          _loadRulesOptionsIfNewer(path);
+          return _rulesCache[path]?.disabledRules.contains(ruleName) ?? false;
+        },
+      ) ??
+      false;
+
   /// Loads lint rules from the analysis options file for all rules
   /// using the provided [RuleContext].
   void loadRulesOptionsFromContext(RuleContext context) =>
@@ -66,70 +92,38 @@ class AnalysisOptionsLoader {
       return;
     }
 
-    final rules = _getRules(analysisOptionsFile);
+    final rulesData = _parser.parse(analysisOptionsFile);
     _rulesCache[yamlPath] = CachedPackageRules(
       modificationStamp: modificationStamp,
-      rules: rules,
+      rules: rulesData.rules,
+      disabledRules: rulesData.disabledRules,
     );
   }
 
   String? _findNearestAnalysisOptionsFilePath(String startDirectoryPath) {
-    final pathContext = _resourceProvider.pathContext;
-    String currentDirectoryPath = startDirectoryPath;
-
-    while (true) {
-      final candidatePath = pathContext.join(
-        currentDirectoryPath,
-        'analysis_options.yaml',
-      );
-      final candidateFile = _resourceProvider.getFile(candidatePath);
-
-      if (candidateFile.exists) {
-        return candidatePath;
-      }
-
-      final parentDir = pathContext.dirname(currentDirectoryPath);
-      if (parentDir == currentDirectoryPath) {
-        break;
+    return _nearestYamlCache.putIfAbsent(startDirectoryPath, () {
+      final pathContext = _resourceProvider.pathContext;
+      var currentDirectoryPath = startDirectoryPath;
+
+      while (currentDirectoryPath.isNotEmpty) {
+        final candidatePath = pathContext.join(
+          currentDirectoryPath,
+          'analysis_options.yaml',
+        );
+        final candidateFile = _resourceProvider.getFile(candidatePath);
+
+        if (candidateFile.exists) {
+          return candidatePath;
+        }
+
+        final parentDir = pathContext.dirname(currentDirectoryPath);
+        if (parentDir == currentDirectoryPath) {
+          break;
+        }
+        currentDirectoryPath = parentDir;
       }
-      currentDirectoryPath = parentDir;
-    }
-
-    return null;
-  }
-
-  Map<String, Map<String, Object?>> _getRules(File? analysisOptionsFile) {
-    if (analysisOptionsFile == null || !analysisOptionsFile.exists) {
-      return {};
-    }
-
-    Object? yaml;
-    try {
-      final optionsString = analysisOptionsFile.readAsStringSync();
-      yaml = loadYaml(optionsString);
-    } catch (_) {
-      return {};
-    }
-
-    Object? rawDiagnostics;
-    if (yaml case {'solid_lints': {'diagnostics': final diagnostics}}) {
-      rawDiagnostics = diagnostics;
-    } else if (yaml case {
-      'plugins': {'solid_lints': {'diagnostics': final diagnostics}},
-    }) {
-      rawDiagnostics = diagnostics;
-    }
 
-    if (rawDiagnostics is! Map) return {};
-
-    return {
-      for (final entry in rawDiagnostics.entries)
-        if (entry.key is String && entry.value is Map)
-          entry.key as String: <String, Object?>{
-            for (final optionEntry in (entry.value as Map).entries)
-              if (optionEntry.key is String)
-                optionEntry.key as String: optionEntry.value,
-          },
-    };
+      return null;
+    });
   }
 }

lib/src/common/parameter_parser/analysis_options_parser.dart

@@ -0,0 +1,196 @@
+import 'package:analyzer/file_system/file_system.dart';
+import 'package:solid_lints/src/common/constants.dart';
+import 'package:solid_lints/src/common/parameter_parser/package_config_resolver.dart';
+import 'package:solid_lints/src/common/parameter_parser/rules_data.dart';
+import 'package:yaml/yaml.dart';
+
+/// Parser for analysis_options.yaml files to extract RulesData.
+class AnalysisOptionsParser {
+  final ResourceProvider _resourceProvider;
+  final PackageConfigResolver _packageConfigResolver;
+
+  /// Creates a new instance of [AnalysisOptionsParser].
+  AnalysisOptionsParser(this._resourceProvider, this._packageConfigResolver);
+
+  /// Parses the given [analysisOptionsFile] and resolves its imports
+  /// to return [RulesData].
+  RulesData parse(File? analysisOptionsFile) {
+    return _parseWithSeen(analysisOptionsFile, {});
+  }
+
+  RulesData _parseWithSeen(File? analysisOptionsFile, Set<String> seenPaths) {
+    if (analysisOptionsFile == null || !analysisOptionsFile.exists) {
+      return const RulesData.empty();
+    }
+
+    final path = analysisOptionsFile.path;
+    if (seenPaths.contains(path)) {
+      return const RulesData.empty();
+    }
+    seenPaths.add(path);
+
+    final yaml = _parseYaml(analysisOptionsFile);
+    if (yaml == null) {
+      return const RulesData.empty();
+    }
+
+    final mergedRules = <String, Map<String, Object?>>{};
+    final disabledRules = <String>{};
+
+    _resolveAndMergeIncludes(
+      analysisOptionsFile,
+      yaml,
+      seenPaths,
+      mergedRules,
+      disabledRules,
+    );
+    _parseRuleOptions(yaml, mergedRules, disabledRules);
+    _parseSuppressedErrors(yaml, mergedRules, disabledRules);
+
+    return RulesData(rules: mergedRules, disabledRules: disabledRules);
+  }
+
+  Map<dynamic, dynamic>? _parseYaml(File file) {
+    try {
+      final optionsString = file.readAsStringSync();
+      final parsed = loadYaml(optionsString);
+      return parsed is Map ? parsed : null;
+    } catch (_) {
+      return null;
+    }
+  }
+
+  void _resolveAndMergeIncludes(
+    File baseFile,
+    Map<dynamic, dynamic> yaml,
+    Set<String> seenPaths,
+    Map<String, Map<String, Object?>> mergedRules,
+    Set<String> disabledRules,
+  ) {
+    final includeOption = yaml['include'];
+    if (includeOption is! String) return;
+
+    final includedFile = _resolveIncludedFile(baseFile, includeOption);
+    if (includedFile == null) return;
+
+    final includedData = _parseWithSeen(includedFile, seenPaths);
+    mergedRules.addAll(includedData.rules);
+    disabledRules.addAll(includedData.disabledRules);
+  }
+
+  File? _resolveIncludedFile(File baseFile, String includePath) {
+    final pathContext = _resourceProvider.pathContext;
+    if (includePath.startsWith('package:')) {
+      final resolvedPath = _packageConfigResolver.resolvePackageUri(
+        baseFile.path,
+        includePath,
+      );
+      if (resolvedPath != null) {
+        return _resourceProvider.getFile(resolvedPath);
+      }
+      return null;
+    }
+
+    final baseDir = pathContext.dirname(baseFile.path);
+    final resolvedPath = pathContext.join(baseDir, includePath);
+    return _resourceProvider.getFile(resolvedPath);
+  }
+
+  void _parseRuleOptions(
+    Map<dynamic, dynamic> yaml,
+    Map<String, Map<String, Object?>> mergedRules,
+    Set<String> disabledRules,
+  ) {
+    final rawDiagnostics = _extractDiagnostics(yaml);
+    if (rawDiagnostics is! Map) return;
+
+    for (final entry in rawDiagnostics.entries) {
+      final key = entry.key;
+      if (key is! String) continue;
+
+      final ruleName = key;
+      final value = entry.value;
+
+      if (value is Map) {
+        final existingOptions = mergedRules[ruleName] ?? {};
+        mergedRules[ruleName] = <String, Object?>{
+          ...existingOptions,
+          for (final optionEntry in value.entries)
+            if (optionEntry.key is String)
+              optionEntry.key as String: optionEntry.value,
+        };
+        disabledRules.remove(ruleName);
+      } else if (value is bool) {
+        if (value) {
+          disabledRules.remove(ruleName);
+        } else {
+          mergedRules.remove(ruleName);
+          disabledRules.add(ruleName);
+        }
+      }
+    }
+  }
+
+  Object? _extractDiagnostics(Map<dynamic, dynamic> yaml) {
+    final pluginConfig = yaml[kPluginName];
+    if (pluginConfig is Map) {
+      return pluginConfig['diagnostics'];
+    }
+
+    final pluginsConfig = yaml['plugins'];
+    if (pluginsConfig is Map) {
+      final pluginSubConfig = pluginsConfig[kPluginName];
+      if (pluginSubConfig is Map) {
+        return pluginSubConfig['diagnostics'];
+      }
+    }
+
+    return null;
+  }
+
+  /// Parses rule suppression configured under `analyzer: errors:`.
+  ///
+  /// By default, when a user excludes/ignores a rule using the IDE
+  /// quick fix or standard settings, the Dart analysis server appends
+  /// the following to `analysis_options.yaml`:
+  ///
+  /// ```yaml
+  /// analyzer:
+  ///   errors:
+  ///     solid_lints/rule_name: ignore
+  /// ```
+  ///
+  /// To respect this standard mechanism and prevent the plugin rules
+  /// from running, we parse this section and add suppressed rules
+  /// to [disabledRules].
+  void _parseSuppressedErrors(
+    Map<dynamic, dynamic> yaml,
+    Map<String, Map<String, Object?>> mergedRules,
+    Set<String> disabledRules,
+  ) {
+    final analyzer = yaml['analyzer'];
+    if (analyzer is! Map) return;
+
+    final errors = analyzer['errors'];
+    if (errors is! Map) return;
+
+    const pluginPrefix = '$kPluginName/';
+
+    for (final entry in errors.entries) {
+      final key = entry.key;
+      if (key is! String) continue;
+
+      final errorValue = entry.value;
+      final ruleName = key.startsWith(pluginPrefix)
+          ? key.substring(pluginPrefix.length)
+          : key;
+
+      if (errorValue == 'ignore') {
+        mergedRules.remove(ruleName);
+        disabledRules.add(ruleName);
+      } else {
+        disabledRules.remove(ruleName);
+      }
+    }
+  }
+}