Add hierarchical analysis_options.yaml support for test files

milkyway-12 · milkyway-12 · commit adcaefd770cb · 2025-09-09T08:58:40.000+03:00
diff --git a/lib/src/lints/avoid_debug_print_in_release/avoid_debug_print_in_release_rule.dart b/lib/src/lints/avoid_debug_print_in_release/avoid_debug_print_in_release_rule.dart
@@ -59,7 +59,7 @@ your `debugPrint` call in a `!kReleaseMode` check.""",
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/avoid_final_with_getter/avoid_final_with_getter_rule.dart b/lib/src/lints/avoid_final_with_getter/avoid_final_with_getter_rule.dart
@@ -54,7 +54,7 @@ class AvoidFinalWithGetterRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart b/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart
@@ -55,7 +55,7 @@ class AvoidGlobalStateRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/avoid_late_keyword/avoid_late_keyword_rule.dart b/lib/src/lints/avoid_late_keyword/avoid_late_keyword_rule.dart
@@ -69,7 +69,7 @@ class AvoidLateKeywordRule extends SolidLintRule<AvoidLateKeywordParameters> {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/avoid_non_null_assertion/avoid_non_null_assertion_rule.dart b/lib/src/lints/avoid_non_null_assertion/avoid_non_null_assertion_rule.dart
@@ -58,7 +58,7 @@ class AvoidNonNullAssertionRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart b/lib/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart
@@ -75,7 +75,7 @@ class AvoidReturningWidgetsRule
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/avoid_unnecessary_setstate/avoid_unnecessary_set_state_rule.dart b/lib/src/lints/avoid_unnecessary_setstate/avoid_unnecessary_set_state_rule.dart
@@ -75,7 +75,7 @@ class AvoidUnnecessarySetStateRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/avoid_unnecessary_type_assertions/avoid_unnecessary_type_assertions_rule.dart b/lib/src/lints/avoid_unnecessary_type_assertions/avoid_unnecessary_type_assertions_rule.dart
@@ -70,7 +70,7 @@ class AvoidUnnecessaryTypeAssertions extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/avoid_unnecessary_type_casts/avoid_unnecessary_type_casts_rule.dart b/lib/src/lints/avoid_unnecessary_type_casts/avoid_unnecessary_type_casts_rule.dart
@@ -31,7 +31,7 @@ class AvoidUnnecessaryTypeCastsRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     error_listener.ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/avoid_unrelated_type_assertions/avoid_unrelated_type_assertions_rule.dart b/lib/src/lints/avoid_unrelated_type_assertions/avoid_unrelated_type_assertions_rule.dart
@@ -29,7 +29,7 @@ class AvoidUnrelatedTypeAssertionsRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/avoid_unused_parameters/avoid_unused_parameters_rule.dart b/lib/src/lints/avoid_unused_parameters/avoid_unused_parameters_rule.dart
@@ -88,7 +88,7 @@ class AvoidUnusedParametersRule extends SolidLintRule<AvoidUnusedParameters> {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/avoid_using_api/avoid_using_api_rule.dart b/lib/src/lints/avoid_using_api/avoid_using_api_rule.dart
@@ -87,7 +87,7 @@ class AvoidUsingApiRule extends SolidLintRule<AvoidUsingApiParameters> {
   }
 
   @override
-  Future<void> run(
+  Future<void> runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/cyclomatic_complexity/cyclomatic_complexity_rule.dart b/lib/src/lints/cyclomatic_complexity/cyclomatic_complexity_rule.dart
@@ -46,7 +46,7 @@ class CyclomaticComplexityRule
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/double_literal_format/double_literal_format_rule.dart b/lib/src/lints/double_literal_format/double_literal_format_rule.dart
@@ -72,7 +72,7 @@ class DoubleLiteralFormatRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/function_lines_of_code/function_lines_of_code_rule.dart b/lib/src/lints/function_lines_of_code/function_lines_of_code_rule.dart
@@ -43,7 +43,7 @@ class FunctionLinesOfCodeRule
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/member_ordering/member_ordering_rule.dart b/lib/src/lints/member_ordering/member_ordering_rule.dart
@@ -108,7 +108,7 @@ class MemberOrderingRule extends SolidLintRule<MemberOrderingParameters> {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/named_parameters_ordering/named_parameters_ordering_rule.dart b/lib/src/lints/named_parameters_ordering/named_parameters_ordering_rule.dart
@@ -123,7 +123,7 @@ class NamedParametersOrderingRule
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/newline_before_return/newline_before_return_rule.dart b/lib/src/lints/newline_before_return/newline_before_return_rule.dart
@@ -92,7 +92,7 @@ class NewlineBeforeReturnRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/no_empty_block/no_empty_block_rule.dart b/lib/src/lints/no_empty_block/no_empty_block_rule.dart
@@ -72,7 +72,7 @@ class NoEmptyBlockRule extends SolidLintRule<NoEmptyBlockParameters> {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/no_equal_then_else/no_equal_then_else_rule.dart b/lib/src/lints/no_equal_then_else/no_equal_then_else_rule.dart
@@ -61,7 +61,7 @@ class NoEqualThenElseRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/no_magic_number/no_magic_number_rule.dart b/lib/src/lints/no_magic_number/no_magic_number_rule.dart
@@ -155,7 +155,7 @@ class NoMagicNumberRule extends SolidLintRule<NoMagicNumberParameters> {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/number_of_parameters/number_of_parameters_rule.dart b/lib/src/lints/number_of_parameters/number_of_parameters_rule.dart
@@ -59,7 +59,7 @@ class NumberOfParametersRule
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/prefer_conditional_expressions/prefer_conditional_expressions_rule.dart b/lib/src/lints/prefer_conditional_expressions/prefer_conditional_expressions_rule.dart
@@ -79,7 +79,7 @@ class PreferConditionalExpressionsRule
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/prefer_early_return/prefer_early_return_rule.dart b/lib/src/lints/prefer_early_return/prefer_early_return_rule.dart
@@ -51,7 +51,7 @@ class PreferEarlyReturnRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/prefer_first/prefer_first_rule.dart b/lib/src/lints/prefer_first/prefer_first_rule.dart
@@ -47,7 +47,7 @@ class PreferFirstRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/prefer_last/prefer_last_rule.dart b/lib/src/lints/prefer_last/prefer_last_rule.dart
@@ -47,7 +47,7 @@ class PreferLastRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/prefer_match_file_name/prefer_match_file_name_rule.dart b/lib/src/lints/prefer_match_file_name/prefer_match_file_name_rule.dart
@@ -73,7 +73,7 @@ class PreferMatchFileNameRule
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/lints/proper_super_calls/proper_super_calls_rule.dart b/lib/src/lints/proper_super_calls/proper_super_calls_rule.dart
@@ -81,7 +81,7 @@ class ProperSuperCallsRule extends SolidLintRule {
   }
 
   @override
-  void run(
+  void runRule(
     CustomLintResolver resolver,
     ErrorReporter reporter,
     CustomLintContext context,
diff --git a/lib/src/models/solid_lint_rule.dart b/lib/src/models/solid_lint_rule.dart
@@ -1,5 +1,10 @@
+import 'dart:io';
+
+import 'package:analyzer/error/listener.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 import 'package:solid_lints/src/models/rule_config.dart';
+import 'package:solid_lints/src/utils/path_utils.dart';
+import 'package:yaml/yaml.dart';
 
 /// A base class for emitting information about
 /// issues with user's `.dart` files.
@@ -11,6 +16,74 @@ abstract class SolidLintRule<T extends Object?> extends DartLintRule {
   /// defined custom parameters.
   final RuleConfig<T> config;
 
-  /// A flag which indicates whether this rule was enabled by the user.
+  /// A flag which indicates whether this rule was enabled by the user (globally).
   bool get enabled => config.enabled;
+
+  @override
+  void run(CustomLintResolver resolver,
+      ErrorReporter reporter,
+      CustomLintContext context,) {
+    if (!isEnabledForFile(resolver.path)) return;
+    runRule(resolver, reporter, context);
+  }
+
+  /// Override this method instead of run() in your rule implementations
+  void runRule(CustomLintResolver resolver,
+      ErrorReporter reporter,
+      CustomLintContext context,);
+
+  /// Determines if the rule should run for the given file.
+  bool isEnabledForFile(String filePath) {
+    if (!enabled) return false;
+    if (_isTestFile(filePath) && _isRuleDisabledInLocalConfig(filePath)) {
+      return false;
+    }
+    return true;
+  }
+
+  /// Checking if the file is a test file.
+  bool _isTestFile(String filePath) {
+    return filePath.contains('/test/') ||
+        filePath.contains(r'\test\') ||
+        filePath.endsWith('_test.dart');
+  }
+
+  /// Check if rule is disabled in local analysis_options.yaml config.
+  bool _isRuleDisabledInLocalConfig(String filePath) {
+    final configPath = findAnalysisOptionsForFile(filePath);
+    if (configPath == null) return false;
+
+    try {
+      final file = File(configPath);
+      if (!file.existsSync()) return false;
+
+      final content = file.readAsStringSync();
+      final yaml = loadYaml(content) as Map<String, dynamic>?;
+
+      if (yaml == null) return false;
+
+      final customLint = yaml['custom_lint'] as Map<String, dynamic>?;
+      if (customLint == null) return false;
+
+      final rules = customLint['rules'] as List?;
+      if (rules == null) return false;
+
+      /// Searching rule in rules list
+      for (final rule in rules) {
+        if (rule is String && rule == config.name) {
+          return false;
+        } else if (rule is Map) {
+          final key = rule.keys.first as String;
+          if (key == config.name) {
+            final value = rule.values.first;
+            return value == false;
+          }
+        }
+      }
+
+      return false;
+    } catch (e) {
+      return false;
+    }
+  }
 }
diff --git a/lib/src/utils/path_utils.dart b/lib/src/utils/path_utils.dart
@@ -1,3 +1,5 @@
+import 'dart:io';
+
 import 'package:glob/glob.dart';
 import 'package:path/path.dart' as p;
 
@@ -45,3 +47,53 @@ String relativePath(String path, [String? root]) {
   final relative = p.posix.relative(uriNormlizedPath, from: uriNormlizedRoot);
   return relative;
 }
+
+/// Finds the appropriate analysis options file for the given file path
+/// Supports hierarchical search for nested analysis_options.yaml files
+String? findAnalysisOptionsForFile(String filePath) {
+  final directory = p.dirname(filePath);
+  return _findSpecificAnalysisOptions(directory, 'analysis_options.yaml');
+}
+
+/// Recursively searches for a specific analysis options file
+String? _findSpecificAnalysisOptions(String dirPath, String fileName) {
+  final analysisOptions = p.join(dirPath, fileName);
+  if (File(analysisOptions).existsSync()) {
+    return analysisOptions;
+  }
+
+  final parent = p.dirname(dirPath);
+
+  /// Reached filesystem root
+  if (parent == dirPath) return null;
+
+  if (!_isWithinProject(parent)) return null;
+
+  return _findSpecificAnalysisOptions(parent, fileName);
+}
+
+/// Checking if we are still in project
+bool _isWithinProject(String dirPath) {
+  try {
+    final dir = Directory(dirPath);
+
+    /// Using custom_lint logic to find project directory
+    final projectDir = _findProjectDirectory(dir);
+    return projectDir != null;
+  } catch (e) {
+    return false;
+  }
+}
+
+/// Finds the project directory (contains pubspec.yaml)
+Directory? _findProjectDirectory(Directory directory) {
+  if (File(p.join(directory.path, 'pubspec.yaml')).existsSync()) {
+    return directory;
+  }
+
+  if (directory.parent.uri == directory.uri) {
+    return null;
+  }
+
+  return _findProjectDirectory(directory.parent);
+}

Original file line number	Diff line number	Diff line change
@@ -59,7 +59,7 @@ your `debugPrint` call in a `!kReleaseMode` check.""",
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`@override`
`62`		`- void run(`
	`62`	`+ void runRule(`
`63`	`63`	`CustomLintResolver resolver,`
`64`	`64`	`ErrorReporter reporter,`
`65`	`65`	`CustomLintContext context,`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ class AvoidFinalWithGetterRule extends SolidLintRule {`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`@override`
`57`		`- void run(`
	`57`	`+ void runRule(`
`58`	`58`	`CustomLintResolver resolver,`
`59`	`59`	`ErrorReporter reporter,`
`60`	`60`	`CustomLintContext context,`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ class AvoidGlobalStateRule extends SolidLintRule {`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`@override`
`58`		`- void run(`
	`58`	`+ void runRule(`
`59`	`59`	`CustomLintResolver resolver,`
`60`	`60`	`ErrorReporter reporter,`
`61`	`61`	`CustomLintContext context,`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ class AvoidLateKeywordRule extends SolidLintRule<AvoidLateKeywordParameters> {`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`@override`
`72`		`- void run(`
	`72`	`+ void runRule(`
`73`	`73`	`CustomLintResolver resolver,`
`74`	`74`	`ErrorReporter reporter,`
`75`	`75`	`CustomLintContext context,`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ class AvoidNonNullAssertionRule extends SolidLintRule {`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`@override`
`61`		`- void run(`
	`61`	`+ void runRule(`
`62`	`62`	`CustomLintResolver resolver,`
`63`	`63`	`ErrorReporter reporter,`
`64`	`64`	`CustomLintContext context,`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ class AvoidReturningWidgetsRule`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`@override`
`78`		`- void run(`
	`78`	`+ void runRule(`
`79`	`79`	`CustomLintResolver resolver,`
`80`	`80`	`ErrorReporter reporter,`
`81`	`81`	`CustomLintContext context,`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ class AvoidUnnecessarySetStateRule extends SolidLintRule {`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`@override`
`78`		`- void run(`
	`78`	`+ void runRule(`
`79`	`79`	`CustomLintResolver resolver,`
`80`	`80`	`ErrorReporter reporter,`
`81`	`81`	`CustomLintContext context,`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ class AvoidUnnecessaryTypeAssertions extends SolidLintRule {`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`@override`
`73`		`- void run(`
	`73`	`+ void runRule(`
`74`	`74`	`CustomLintResolver resolver,`
`75`	`75`	`ErrorReporter reporter,`
`76`	`76`	`CustomLintContext context,`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class AvoidUnnecessaryTypeCastsRule extends SolidLintRule {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`@override`
`34`		`- void run(`
	`34`	`+ void runRule(`
`35`	`35`	`CustomLintResolver resolver,`
`36`	`36`	`error_listener.ErrorReporter reporter,`
`37`	`37`	`CustomLintContext context,`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class AvoidUnrelatedTypeAssertionsRule extends SolidLintRule {`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`@override`
`32`		`- void run(`
	`32`	`+ void runRule(`
`33`	`33`	`CustomLintResolver resolver,`
`34`	`34`	`ErrorReporter reporter,`
`35`	`35`	`CustomLintContext context,`