feat: support excludes for a separate anti-pattern. (#637)

Author: dkrutskikh

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+* feat: support excludes for a separate anti-pattern.
+
 ## 4.9.0
 
 * feat: add static code diagnostics `avoid-global-state`, `avoid-unrelated-type-assertions`.

lib/src/analyzers/lint_analyzer/anti_patterns/anti_patterns_list/long_method.dart

@@ -38,6 +38,7 @@ class LongMethod extends Pattern {
           id: patternId,
           supportedType: EntityType.methodEntity,
           severity: readSeverity(patternSettings, Severity.none),
+          excludes: readExcludes(patternSettings),
         );
 
   @override

lib/src/analyzers/lint_analyzer/anti_patterns/anti_patterns_list/long_parameter_list.dart

@@ -36,6 +36,7 @@ class LongParameterList extends Pattern {
           id: patternId,
           supportedType: EntityType.methodEntity,
           severity: readSeverity(patternSettings, Severity.none),
+          excludes: readExcludes(patternSettings),
         );
 
   @override

lib/src/analyzers/lint_analyzer/anti_patterns/models/pattern.dart

@@ -19,13 +19,17 @@ abstract class Pattern {
   /// The severity of issues emitted by the pattern.
   final Severity severity;
 
+  /// A list of excluded files for the pattern.
+  final Iterable<String> excludes;
+
   /// Metric ids which values are used by the anti-pattern to detect a violation.
   Iterable<String> get dependentMetricIds;
 
   const Pattern({
     required this.id,
     required this.supportedType,
     required this.severity,
+    required this.excludes,
   });
 
   /// Returns [Iterable] with [Issue]'s detected while check the passed [source].

lib/src/analyzers/lint_analyzer/lint_analyzer.dart

@@ -187,7 +187,6 @@ class LintAnalyzer {
             ignores,
             internalResult,
             config,
-            filePath,
           ),
         );
       }
@@ -249,13 +248,12 @@ class LintAnalyzer {
     Suppression ignores,
     InternalResolvedUnitResult source,
     LintAnalysisConfig config,
-    String filePath,
   ) =>
       config.codeRules
           .where((rule) =>
               !ignores.isSuppressed(rule.id) &&
               !isExcluded(
-                filePath,
+                source.path,
                 prepareExcludes(rule.excludes, config.excludesRootFolder),
               ))
           .expand(
@@ -275,7 +273,12 @@ class LintAnalyzer {
     Map<ScopedFunctionDeclaration, Report> functionMetrics,
   ) =>
       config.antiPatterns
-          .where((pattern) => !ignores.isSuppressed(pattern.id))
+          .where((pattern) =>
+              !ignores.isSuppressed(pattern.id) &&
+              !isExcluded(
+                source.path,
+                prepareExcludes(pattern.excludes, config.excludesRootFolder),
+              ))
           .expand((pattern) => pattern
               .check(source, classMetrics, functionMetrics)
               .where((issue) => !ignores.isSuppressedAt(

lib/src/analyzers/lint_analyzer/lint_utils.dart

@@ -3,3 +3,15 @@ import 'models/severity.dart';
 /// Returns a [Severity] from map based [config] otherwise [defaultValue]
 Severity readSeverity(Map<String, Object?> config, Severity defaultValue) =>
     Severity.fromString(config['severity'] as String?) ?? defaultValue;
+
+/// Returns a list of excludes from the given [config]
+Iterable<String> readExcludes(Map<String, Object> config) {
+  final data = config['exclude'];
+
+  return _isIterableOfStrings(data)
+      ? (data as Iterable).cast<String>()
+      : const <String>[];
+}
+
+bool _isIterableOfStrings(Object? object) =>
+    object is Iterable<Object> && object.every((node) => node is String);

lib/src/analyzers/lint_analyzer/rules/rule_utils.dart

@@ -35,15 +35,3 @@ Uri documentation(Rule rule) => Uri(
         rule.id,
       ],
     );
-
-/// Returns a list of excludes from the given [config]
-Iterable<String> readExcludes(Map<String, Object> config) {
-  final data = config['exclude'];
-
-  return _isIterableOfStrings(data)
-      ? (data as Iterable).cast<String>()
-      : const <String>[];
-}
-
-bool _isIterableOfStrings(Object? object) =>
-    object is Iterable<Object> && object.every((node) => node is String);

test/src/analyzers/lint_analyzer/lint_utils_test.dart

@@ -3,22 +3,38 @@ import 'package:dart_code_metrics/src/analyzers/lint_analyzer/models/severity.da
 import 'package:test/test.dart';
 
 void main() {
-  test('readSeverity returns a Severity from Map based config', () {
-    expect(
-      [
-        {'severity': 'ERROR'},
-        {'severity': 'wArnInG'},
-        {'severity': 'performance'},
-        {'severity': ''},
-        {'': null},
-      ].map((data) => readSeverity(data, Severity.style)),
-      equals([
-        Severity.error,
-        Severity.warning,
-        Severity.performance,
-        Severity.none,
-        Severity.style,
-      ]),
-    );
+  group('Lint utils', () {
+    test('readSeverity returns a Severity from Map based config', () {
+      expect(
+        [
+          {'severity': 'ERROR'},
+          {'severity': 'wArnInG'},
+          {'severity': 'performance'},
+          {'severity': ''},
+          {'': null},
+        ].map((data) => readSeverity(data, Severity.style)),
+        equals([
+          Severity.error,
+          Severity.warning,
+          Severity.performance,
+          Severity.none,
+          Severity.style,
+        ]),
+      );
+    });
+
+    group('readExcludes', () {
+      test('returns a list of excludes', () {
+        const excludes = ['hello.dart', 'world/**'];
+
+        expect(readExcludes({'exclude': excludes}), equals(excludes));
+      });
+
+      test('returns an empty list', () {
+        const wrongExcludes = [1, 2];
+
+        expect(readExcludes({'exclude': wrongExcludes}), isEmpty);
+      });
+    });
   });
 }

test/src/analyzers/lint_analyzer/rules/rule_utils_test.dart

@@ -80,22 +80,5 @@ void main() {
       expect(doc2.removeLast(), equals(ruleId2));
       expect(doc2.removeLast(), equals(RuleType.angular.value));
     });
-
-    group('readExcludes', () {
-      test('returns a list of excludes', () {
-        const excludes = [
-          'hello.dart',
-          'world/**',
-        ];
-
-        expect(readExcludes({'exclude': excludes}), equals(excludes));
-      });
-
-      test('returns an empty list', () {
-        const wrongExcludes = [1, 2];
-
-        expect(readExcludes({'exclude': wrongExcludes}), isEmpty);
-      });
-    });
   });
 }

website/docs/getting-started/configuration.md

@@ -150,7 +150,17 @@ If you want a specific rule to ignore files, you can configure `exclude` entry f
 ```yaml title="analysis_options.yaml"
 dart_code_metrics:
   rules:
-    no-equal-arguments:
-      exclude:
-        - test/**
+    - no-equal-arguments:
+        exclude:
+          - test/**
+```
+
+and similar example for anti-pattern,
+
+```yaml title="analysis_options.yaml"
+dart_code_metrics:
+  anti-patterns:
+    - long-method:
+        exclude:
+          - test/**
 ```