Implementation of parameter parser

lib/main.dart

@@ -1,5 +1,6 @@
 import 'package:analysis_server_plugin/plugin.dart';
 import 'package:analysis_server_plugin/registry.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_global_state/avoid_global_state_rule.dart';
 import 'package:solid_lints/src/lints/avoid_non_null_assertion/avoid_non_null_assertion_rule.dart';
@@ -21,8 +22,9 @@ class SolidLintsPlugin extends Plugin {
 
   @override
   void register(PluginRegistry registry) {
+    final analysisLoader = AnalysisOptionsLoader();
     registry.registerLintRule(
-      AvoidGlobalStateRule(),
+      AvoidGlobalStateRule(analysisLoader),
     );
     registry.registerLintRule(
       AvoidNonNullAssertionRule(),

lib/src/common/parameter_parser/analysis_options_loader.dart

@@ -0,0 +1,104 @@
+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/cached_package_rules.dart';
+import 'package:yaml/yaml.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;
+
+  /// Gets the options for a specific rule by its name.
+  Map<String, Object?>? getRuleOptions(RuleContext context, String ruleName) {
+    final packageRootPath = context.package?.root.path;
+    if (packageRootPath == null) return null;
+
+    final yamlPath = _findNearestAnalysisOptionsFilePath(packageRootPath);
+    if (yamlPath == null) return null;
+
+    return _rulesCache[yamlPath]?.rules[ruleName];
+  }
+
+  /// Loads lint rules from the analysis options file for all rules
+  /// using the provided [RuleContext].
+  void loadRulesOptionsFromContext(RuleContext context) {
+    final packageRootPath = context.package?.root.path;
+    if (packageRootPath == null) return;
+
+    _loadRulesOptionsIfNewer(packageRootPath);
+  }
+
+  void _loadRulesOptionsIfNewer(String rootPath) {
+    final yamlPath = _findNearestAnalysisOptionsFilePath(rootPath);
+    if (yamlPath == null) return;
+
+    final analysisOptionsFile = _resourceProvider.getFile(yamlPath);
+    final modificationStamp = analysisOptionsFile.modificationStamp;
+    final cachedRules = _rulesCache[yamlPath];
+
+    if (cachedRules?.modificationStamp == modificationStamp) {
+      return;
+    }
+
+    final rules = _getRules(analysisOptionsFile);
+    _rulesCache[yamlPath] = CachedPackageRules(
+      modificationStamp: modificationStamp,
+      rules: rules,
+    );
+  }
+
+  String? _findNearestAnalysisOptionsFilePath(String packageRootPath) {
+    final pathContext = _resourceProvider.pathContext;
+    String currentDirectoryPath = packageRootPath;
+
+    while (pathContext.dirname(currentDirectoryPath) != currentDirectoryPath) {
+      final candidatePath =
+          pathContext.join(currentDirectoryPath, 'analysis_options.yaml');
+      final candidateFile = _resourceProvider.getFile(candidatePath);
+
+      if (candidateFile.exists) {
+        return candidatePath;
+      }
+
+      final parentDir = pathContext.dirname(currentDirectoryPath);
+      currentDirectoryPath = parentDir;
+    }
+
+    return null;
+  }
+
+  Map<String, Map<String, Object?>> _getRules(File? analysisOptionsFile) {
+    if (analysisOptionsFile == null || !analysisOptionsFile.exists) {
+      return {};
+    }
+
+    final optionsString = analysisOptionsFile.readAsStringSync();
+    Object? yaml;
+    try {
+      yaml = loadYaml(optionsString) as Object?;
+    } catch (err) {
+      return {};
+    }
+
+    if (yaml
+        case {'plugins': {'solid_lints': {'diagnostics': final diagnostics?}}}
+        when diagnostics is Map) {
+      return Map.fromEntries(
+        diagnostics.entries.where((e) => e.key is String && e.value is Map).map(
+              (e) => MapEntry(
+                e.key as String,
+                Map<String, Object?>.from(e.value as Map),
+              ),
+            ),
+      );
+    }
+
+    return {};
+  }
+}

lib/src/common/parameter_parser/cached_package_rules.dart

@@ -0,0 +1,14 @@
+/// Cached rules for a dart package
+class CachedPackageRules {
+  /// The last modification stamp of the analysis options file
+  final int modificationStamp;
+
+  /// Cached rules options by rule name for the package
+  final Map<String, Map<String, Object?>> rules;
+
+  /// Creates an instance of [CachedPackageRules]
+  const CachedPackageRules({
+    required this.modificationStamp,
+    required this.rules,
+  });
+}

lib/src/lints/avoid_global_state/avoid_global_state_rule.dart

@@ -2,6 +2,7 @@ import 'package:analyzer/analysis_rule/analysis_rule.dart';
 import 'package:analyzer/analysis_rule/rule_context.dart';
 import 'package:analyzer/analysis_rule/rule_visitor_registry.dart';
 import 'package:analyzer/error/error.dart';
+import 'package:solid_lints/src/common/parameter_parser/analysis_options_loader.dart';
 import 'package:solid_lints/src/lints/avoid_global_state/visitors/avoid_global_state_visitor.dart';
 
 /// Avoid top-level and static mutable variables.
@@ -46,8 +47,10 @@ class AvoidGlobalStateRule extends AnalysisRule {
         'Prefer using final/const or a state management solution.',
   );
 
+  final AnalysisOptionsLoader _analysisLoader;
+
   /// Creates an instance of [AvoidGlobalStateRule].
-  AvoidGlobalStateRule()
+  AvoidGlobalStateRule(this._analysisLoader)
       : super(
           name: lintName,
           description: 'Avoid top-level or static mutable variables ',
@@ -63,6 +66,10 @@ class AvoidGlobalStateRule extends AnalysisRule {
   ) {
     final visitor = AvoidGlobalStateVisitor(this);
 
+    _analysisLoader.loadRulesOptionsFromContext(context);
+    // To get the options of the rule:
+    // _analysisLoader.getRuleOptions(context, lintName);
+
     registry.addTopLevelVariableDeclaration(this, visitor);
     registry.addFieldDeclaration(this, visitor);
   }

lib/src/models/solid_lint_rule.dart

@@ -1,16 +1,43 @@
-import 'package:custom_lint_builder/custom_lint_builder.dart';
-import 'package:solid_lints/src/models/rule_config.dart';
+import 'package:analyzer/analysis_rule/analysis_rule.dart';
+import 'package:analyzer/analysis_rule/rule_context.dart';
+import 'package:solid_lints/src/common/parameter_parser/analysis_options_loader.dart';
+
+/// A function that parses the rule parameters from analysis options json
+typedef RuleParametersParser<T> = T Function(Map<String, Object?>);
 
 /// A base class for emitting information about
 /// issues with user's `.dart` files.
-abstract class SolidLintRule<T extends Object?> extends DartLintRule {
+abstract class SolidLintRule<T extends Object?> extends AnalysisRule {
+  final AnalysisOptionsLoader? _analysisOptionsLoader;
+
+  final RuleParametersParser<T>? _parametersParser;
+
   /// Constructor for [SolidLintRule] model.
-  SolidLintRule(this.config) : super(code: config.lintCode);
+  SolidLintRule({
+    required super.name,
+    required super.description,
+    super.state,
+  })  : _analysisOptionsLoader = null,
+        _parametersParser = null;
+
+  /// Constructor for [SolidLintRule] model with parameters.
+  SolidLintRule.withParameters({
+    required AnalysisOptionsLoader analysisOptionsLoader,
+    required RuleParametersParser<T> parametersParser,
+    required super.name,
+    required super.description,
+    super.state,
+  })  : _analysisOptionsLoader = analysisOptionsLoader,
+        _parametersParser = parametersParser;
+
+  /// Reads the rule parameters from analysis options and parses them to [T]
+  T? getParametersForContext(RuleContext context) {
+    _analysisOptionsLoader?.loadRulesOptionsFromContext(context);
 
-  /// Configuration for a particular rule with all the
-  /// defined custom parameters.
-  final RuleConfig<T> config;
+    final unparsedParameters =
+        _analysisOptionsLoader?.getRuleOptions(context, name);
+    if (unparsedParameters == null) return null;
 
-  /// A flag which indicates whether this rule was enabled by the user.
-  bool get enabled => config.enabled;
+    return _parametersParser?.call(unparsedParameters);
+  }
 }