feat: add support for global rules-exclude

Author: xsahil03x

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 4.2.0-dev.5
+
+* Add support for global rules-exclude
+
 ## 4.2.0-dev.4
 
 * Fix rule and metrics excludes for monorepos.

example/example.dart

@@ -17,6 +17,7 @@ Future<void> main() async {
       'maximum-nesting-level': '5',
       'number-of-methods': '10',
     },
+    excludeForRulesPatterns: ['test/**'],
     rules: {
       'double-literal-format': {},
       'newline-before-return': {'severity': 'info'},

lib/src/analyzers/lint_analyzer/lint_analysis_config.dart

@@ -11,6 +11,7 @@ import 'rules/models/rule.dart';
 class LintAnalysisConfig {
   final Iterable<Glob> globalExcludes;
   final Iterable<Rule> codeRules;
+  final Iterable<Glob> rulesExcludes;
   final Iterable<ObsoletePattern> antiPatterns;
   final Iterable<Metric> classesMetrics;
   final Iterable<Metric> methodsMetrics;
@@ -21,6 +22,7 @@ class LintAnalysisConfig {
   const LintAnalysisConfig(
     this.globalExcludes,
     this.codeRules,
+    this.rulesExcludes,
     this.antiPatterns,
     this.classesMetrics,
     this.methodsMetrics,

lib/src/analyzers/lint_analyzer/lint_analyzer.dart

@@ -151,12 +151,17 @@ class LintAnalyzer {
       );
       final relativePath = relative(filePath, from: rootFolder);
 
-      final issues = _checkOnCodeIssues(
-        ignores,
-        internalResult,
-        config,
-        filePath,
-      );
+      final issues = <Issue>[];
+      if (!isExcluded(filePath, config.rulesExcludes)) {
+        issues.addAll(
+          _checkOnCodeIssues(
+            ignores,
+            internalResult,
+            config,
+            filePath,
+          ),
+        );
+      }
 
       if (!isExcluded(filePath, config.metricsExcludes)) {
         final visitor = ScopeVisitor();

lib/src/analyzers/lint_analyzer/lint_config.dart

@@ -12,13 +12,15 @@ class LintConfig {
   final Iterable<String> excludeForMetricsPatterns;
   final Map<String, Object> metrics;
   final Map<String, Map<String, Object>> rules;
+  final Iterable<String> excludeForRulesPatterns;
   final Map<String, Map<String, Object>> antiPatterns;
 
   const LintConfig({
     required this.excludePatterns,
     required this.excludeForMetricsPatterns,
     required this.metrics,
     required this.rules,
+    required this.excludeForRulesPatterns,
     required this.antiPatterns,
   });
 
@@ -31,6 +33,8 @@ class LintConfig {
           options.readIterableOfString([_rootKey, 'metrics-exclude']),
       metrics: options.readMap([_rootKey, 'metrics']),
       rules: options.readMapOfMap([_rootKey, 'rules']),
+      excludeForRulesPatterns:
+          options.readIterableOfString([_rootKey, 'rules-exclude']),
       antiPatterns: options.readMapOfMap([_rootKey, 'anti-patterns']),
     );
   }
@@ -44,6 +48,7 @@ class LintConfig {
               metric.id: arguments.metricsConfig[metric.id]!,
         },
         rules: const {},
+        excludeForRulesPatterns: const [],
         antiPatterns: const {},
       );
 
@@ -56,6 +61,10 @@ class LintConfig {
         metrics: mergeMaps(defaults: metrics, overrides: overrides.metrics),
         rules: mergeMaps(defaults: rules, overrides: overrides.rules)
             .cast<String, Map<String, Object>>(),
+        excludeForRulesPatterns: {
+          ...excludeForRulesPatterns,
+          ...overrides.excludeForRulesPatterns,
+        },
         antiPatterns:
             mergeMaps(defaults: antiPatterns, overrides: overrides.antiPatterns)
                 .cast<String, Map<String, Object>>(),

lib/src/config_builder/config_builder.dart

@@ -27,6 +27,7 @@ class ConfigBuilder {
       LintAnalysisConfig(
         prepareExcludes(config.excludePatterns, excludesRootFolder),
         getRulesById(config.rules),
+        prepareExcludes(config.excludeForRulesPatterns, excludesRootFolder),
         getPatternsById(config.antiPatterns),
         classMetrics ??
             getMetrics(

test/analyzers/lint_analyzer/lint_analyzer_test.dart

@@ -130,6 +130,23 @@ void main() {
 
         expect(ids, List.filled(1, 'avoid-late-keyword'));
       });
+
+      test('should not report rules', () async {
+        final config = _createConfig(
+          rules: {'avoid-late-keyword': {}},
+          excludeForRulesPatterns: ['test/**'],
+        );
+
+        final result = await analyzer.runCliAnalysis(
+          folders,
+          rootDirectory,
+          config,
+        );
+
+        final report =
+            reportForFile(result, 'lint_analyzer_exclude_example.dart').issues;
+        expect(report, isEmpty);
+      });
     },
     testOn: 'posix',
   );
@@ -141,13 +158,15 @@ LintConfig _createConfig({
   Map<String, Object> metrics = const {},
   Iterable<String> excludeForMetricsPatterns = const [],
   Map<String, Map<String, Object>> rules = const {},
+  Iterable<String> excludeForRulesPatterns = const [],
 }) =>
     LintConfig(
       antiPatterns: antiPatterns,
       excludePatterns: excludePatterns,
       metrics: metrics,
       excludeForMetricsPatterns: excludeForMetricsPatterns,
       rules: rules,
+      excludeForRulesPatterns: excludeForRulesPatterns,
     );
 
 LintFileReport reportForFile(

test/analyzers/lint_analyzer/lint_config_test.dart

@@ -24,6 +24,7 @@ const _options = AnalysisOptions('path', {
     },
     'metrics-exclude': ['test/**', 'examples/**'],
     'rules': {'rule-id1': false, 'rule-id2': true, 'rule-id3': true},
+    'rules-exclude': ['test/**', 'examples/**'],
   },
 });
 
@@ -35,6 +36,7 @@ const _defaults = LintConfig(
     'metric-id2': '10',
     'metric-id3': '5',
   },
+  excludeForRulesPatterns: ['test/**'],
   rules: {
     'rule-id1': {},
     'rule-id2': {'severity': 'info'},
@@ -48,6 +50,7 @@ const _empty = LintConfig(
   excludePatterns: [],
   excludeForMetricsPatterns: [],
   metrics: {},
+  excludeForRulesPatterns: [],
   rules: {},
   antiPatterns: {},
 );
@@ -61,6 +64,7 @@ const _merged = LintConfig(
     'metric-id3': '5',
     'metric-id4': '0',
   },
+  excludeForRulesPatterns: ['test/**', 'examples/**'],
   rules: {
     'rule-id1': {},
     'rule-id2': {'severity': 'warning'},
@@ -78,6 +82,7 @@ const _overrides = LintConfig(
     'metric-id1': '5',
     'metric-id4': '0',
   },
+  excludeForRulesPatterns: ['examples/**'],
   rules: {
     'rule-id2': {'severity': 'warning'},
   },
@@ -96,6 +101,7 @@ void main() {
         expect(config.excludePatterns, isEmpty);
         expect(config.excludeForMetricsPatterns, isEmpty);
         expect(config.metrics, isEmpty);
+        expect(config.excludeForRulesPatterns, isEmpty);
         expect(config.rules, isEmpty);
       });
 
@@ -116,6 +122,10 @@ void main() {
             'metric-id4': '0',
           }),
         );
+        expect(
+          config.excludeForRulesPatterns,
+          equals(['test/**', 'examples/**']),
+        );
         expect(
           config.rules,
           equals({
@@ -136,6 +146,10 @@ void main() {
           equals(_defaults.excludeForMetricsPatterns),
         );
         expect(result.metrics, equals(_defaults.metrics));
+        expect(
+          result.excludeForRulesPatterns,
+          equals(_defaults.excludeForRulesPatterns),
+        );
         expect(result.rules, equals(_defaults.rules));
       });
       test('empty and overrides configs', () {
@@ -147,6 +161,10 @@ void main() {
           equals(_overrides.excludeForMetricsPatterns),
         );
         expect(result.metrics, equals(_overrides.metrics));
+        expect(
+          result.excludeForRulesPatterns,
+          equals(_overrides.excludeForRulesPatterns),
+        );
         expect(result.rules, equals(_overrides.rules));
       });
       test('defaults and overrides configs', () {
@@ -158,6 +176,10 @@ void main() {
           equals(_merged.excludeForMetricsPatterns),
         );
         expect(result.metrics, equals(_merged.metrics));
+        expect(
+          result.excludeForRulesPatterns,
+          equals(_merged.excludeForRulesPatterns),
+        );
         expect(result.rules, equals(_merged.rules));
       });
     });