- Added excludeNames param for function_lines_of_code lint (#141)

- Added `excludeNames` param for `function_lines_of_code` lint
- Refactored tests for function_lines_of_code

Author: aderhachev

CHANGELOG.md

@@ -7,6 +7,7 @@
   - ignores methods that override ones that return widget (build() for example)
   - no longer allows returning widgets from methods/functions named build
 - Fixed unexpected avoid_unnecessary_type_assertions
+- Added `excludeNames` param for `function_lines_of_code` lint
 
 ## 0.1.4
 

lib/src/lints/function_lines_of_code/function_lines_of_code_metric.dart

@@ -16,6 +16,8 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 ///   rules:
 ///     - function_lines_of_code:
 ///       max_lines: 100
+///       excludeNames:
+///         - "Build"
 /// ```
 class FunctionLinesOfCodeMetric
     extends SolidLintRule<FunctionLinesOfCodeParameters> {
@@ -49,6 +51,7 @@ class FunctionLinesOfCodeMetric
     void checkNode(AstNode node) => _checkNode(resolver, reporter, node);
 
     context.registry.addMethodDeclaration(checkNode);
+    context.registry.addFunctionDeclaration(checkNode);
     context.registry.addFunctionExpression(checkNode);
   }
 
@@ -57,6 +60,12 @@ class FunctionLinesOfCodeMetric
     ErrorReporter reporter,
     AstNode node,
   ) {
+    final functionName = _getFunctionName(node);
+    if (functionName != null &&
+        config.parameters.excludeNames.contains(functionName)) {
+      return;
+    }
+
     final visitor = FunctionLinesOfCodeVisitor(resolver.lineInfo);
     node.visitChildren(visitor);
 
@@ -75,4 +84,16 @@ class FunctionLinesOfCodeMetric
       );
     }
   }
+
+  String? _getFunctionName(AstNode node) {
+    if (node is FunctionDeclaration) {
+      return node.name.lexeme;
+    } else if (node is MethodDeclaration) {
+      return node.name.lexeme;
+    } else if (node is FunctionExpression) {
+      return node.declaredElement?.name;
+    } else {
+      return null;
+    }
+  }
 }

lib/src/lints/function_lines_of_code/models/function_lines_of_code_parameters.dart

@@ -5,16 +5,22 @@ class FunctionLinesOfCodeParameters {
   /// exceeding this limit triggers a warning.
   final int maxLines;
 
+  /// Function names to be excluded from the rule check
+  final List<String> excludeNames;
+
   static const _defaultMaxLines = 200;
 
   /// Constructor for [FunctionLinesOfCodeParameters] model
   const FunctionLinesOfCodeParameters({
     required this.maxLines,
+    required this.excludeNames,
   });
 
   /// Method for creating from json data
   factory FunctionLinesOfCodeParameters.fromJson(Map<String, Object?> json) =>
       FunctionLinesOfCodeParameters(
         maxLines: json['max_lines'] as int? ?? _defaultMaxLines,
+        excludeNames:
+            List<String>.from(json['excludeNames'] as Iterable? ?? []),
       );
 }

lint_test/function_lines_of_code_test/analysis_options.yaml

@@ -0,0 +1,11 @@
+analyzer:
+  plugins:
+    - ../custom_lint
+
+custom_lint:
+  rules:
+    - function_lines_of_code:
+      max_lines: 5
+      excludeNames:
+        - "longFunctionExcluded"
+        - "longMethodExcluded"

lint_test/function_lines_of_code_test/function_lines_of_code_test.dart

@@ -0,0 +1,57 @@
+class ClassWithLongMethods {
+  int notLongMethod() {
+    var i = 0;
+    i++;
+    i++;
+    i++;
+    return i;
+  }
+
+  // expect_lint: function_lines_of_code
+  int longMethod() {
+    var i = 0;
+    i++;
+    i++;
+    i++;
+    i++;
+    return i;
+  }
+
+  // Excluded by excludeNames
+  int longMethodExcluded() {
+    var i = 0;
+    i++;
+    i++;
+    i++;
+    i++;
+    return i;
+  }
+}
+
+int notLongFunction() {
+  var i = 0;
+  i++;
+  i++;
+  i++;
+  return i;
+}
+
+// expect_lint: function_lines_of_code
+int longFunction() {
+  var i = 0;
+  i++;
+  i++;
+  i++;
+  i++;
+  return i;
+}
+
+// Excluded by excludeNames
+int longFunctionExcluded() {
+  var i = 0;
+  i++;
+  i++;
+  i++;
+  i++;
+  return i;
+}