chore: renew New Line Before Return rule

Author: dkrutskikh

lib/src/obsoleted/rules_factory.dart

@@ -1,4 +1,5 @@
 import '../rules/double_literal_format/double_literal_format.dart';
+import '../rules/newline_before_return/newline_before_return.dart';
 import '../rules/rule.dart';
 import 'rules/avoid_late_keyword.dart';
 import 'rules/avoid_non_null_assertion_rule.dart';
@@ -9,7 +10,6 @@ import 'rules/binary_expression_operand_order_rule.dart';
 import 'rules/component_annotation_arguments_ordering.dart';
 import 'rules/member_ordering.dart';
 import 'rules/member_ordering_extended/member_ordering_extended_rule.dart';
-import 'rules/newline_before_return.dart';
 import 'rules/no_boolean_literal_compare_rule.dart';
 import 'rules/no_empty_block.dart';
 import 'rules/no_equal_arguments.dart';

lib/src/obsoleted/rules/newline_before_return.dart renamed to lib/src/rules/newline_before_return/newline_before_return.dart

@@ -5,40 +5,49 @@ import 'package:analyzer/dart/ast/visitor.dart';
 import 'package:analyzer/source/line_info.dart';
 
 import '../../models/issue.dart';
+import '../../models/rule_documentation.dart';
 import '../../models/severity.dart';
 import '../../utils/node_utils.dart';
 import '../../utils/rule_utils.dart';
-import 'obsolete_rule.dart';
+import '../rule.dart';
 
-// Inspired by TSLint (https://palantir.github.io/tslint/rules/newline-before-return/)
+part 'return_statement_visitor.dart';
 
-class NewlineBeforeReturnRule extends ObsoleteRule {
-  static const String ruleId = 'newline-before-return';
+// Inspired by ESLint (https://eslint.org/docs/rules/newline-before-return)
+
+const _documentation = RuleDocumentation(
+  name: 'New Line Before Return',
+  brief: 'Enforces blank line between statements and return in a block',
+);
 
-  static const _failure = 'Missing blank line before return';
+const _failure = 'Missing blank line before return';
+
+class NewlineBeforeReturnRule extends Rule {
+  static const String ruleId = 'newline-before-return';
 
   NewlineBeforeReturnRule({Map<String, Object> config = const {}})
       : super(
           id: ruleId,
+          documentation: _documentation,
           severity: readSeverity(config, Severity.style),
           excludes: readExcludes(config),
         );
 
   @override
   Iterable<Issue> check(ResolvedUnitResult source) {
-    final _visitor = _Visitor();
+    final visitor = _Visitor();
 
-    source.unit?.visitChildren(_visitor);
+    source.unit?.visitChildren(visitor);
 
-    return _visitor.statements
+    return visitor.statements
         // return statement is in a block
-        .where((statement) =>
-            statement.parent != null && statement.parent is Block)
+        .where((statement) => statement.parent is Block)
         // return statement isn't first token in a block
         .where((statement) =>
             statement.returnKeyword.previous != statement.parent?.beginToken)
         .where((statement) {
           final lineInfo = source.unit!.lineInfo!;
+          
           final previousTokenLine = lineInfo
               .getLocation(statement.returnKeyword.previous!.end)
               .lineNumber;
@@ -52,48 +61,32 @@ class NewlineBeforeReturnRule extends ObsoleteRule {
         })
         .map((statement) => createIssue(
               rule: this,
-              location: nodeLocation(
-                node: statement,
-                source: source,
-                withCommentOrMetadata: true,
-              ),
+              location: nodeLocation(node: statement, source: source),
               message: _failure,
             ))
         .toList(growable: false);
   }
+}
 
-  Token _optimalToken(Token token, LineInfo lineInfo) {
-    var optimalToken = token;
-
-    var commentToken = _latestCommentToken(token);
-    while (commentToken != null &&
-        lineInfo.getLocation(commentToken.end).lineNumber + 1 >=
-            lineInfo.getLocation(optimalToken.offset).lineNumber) {
-      optimalToken = commentToken;
-      commentToken = commentToken.previous;
-    }
+Token _optimalToken(Token token, LineInfo lineInfo) {
+  var optimalToken = token;
 
-    return optimalToken;
+  var commentToken = _latestCommentToken(token);
+  while (commentToken != null &&
+      lineInfo.getLocation(commentToken.end).lineNumber + 1 >=
+          lineInfo.getLocation(optimalToken.offset).lineNumber) {
+    optimalToken = commentToken;
+    commentToken = commentToken.previous;
   }
 
-  Token? _latestCommentToken(Token token) {
-    Token? latestCommentToken = token.precedingComments;
-    while (latestCommentToken?.next != null) {
-      latestCommentToken = latestCommentToken?.next;
-    }
-
-    return latestCommentToken;
-  }
+  return optimalToken;
 }
 
-class _Visitor extends RecursiveAstVisitor<void> {
-  final _statements = <ReturnStatement>[];
-
-  Iterable<ReturnStatement> get statements => _statements;
-
-  @override
-  void visitReturnStatement(ReturnStatement node) {
-    super.visitReturnStatement(node);
-    _statements.add(node);
+Token? _latestCommentToken(Token token) {
+  Token? latestCommentToken = token.precedingComments;
+  while (latestCommentToken?.next != null) {
+    latestCommentToken = latestCommentToken?.next;
   }
+
+  return latestCommentToken;
 }

lib/src/rules/newline_before_return/return_statement_visitor.dart

@@ -0,0 +1,13 @@
+part of 'newline_before_return.dart';
+
+class _Visitor extends RecursiveAstVisitor<void> {
+  final _statements = <ReturnStatement>[];
+
+  Iterable<ReturnStatement> get statements => _statements;
+
+  @override
+  void visitReturnStatement(ReturnStatement node) {
+    super.visitReturnStatement(node);
+    _statements.add(node);
+  }
+}

test/obsoleted/rules/newline_before_return/examples/example.dart renamed to test/resources/newline_before_return_example.dart

@@ -1,3 +1,4 @@
+// ignore_for_file: always_put_control_body_on_new_line, newline-before-return
 int simpleFunction() {
   var a = 4;
 

test/obsoleted/rules/newline_before_return/newline_before_return_test.dart renamed to test/rules/newline_before_return_test.dart

@@ -1,12 +1,11 @@
 @TestOn('vm')
 import 'package:dart_code_metrics/src/models/severity.dart';
-import 'package:dart_code_metrics/src/obsoleted/rules/newline_before_return.dart';
+import 'package:dart_code_metrics/src/rules/newline_before_return/newline_before_return.dart';
 import 'package:test/test.dart';
 
-import '../../../helpers/rule_test_helper.dart';
+import '../helpers/rule_test_helper.dart';
 
-const _examplePath =
-    'test/obsoleted/rules/newline_before_return/examples/example.dart';
+const _examplePath = 'test/resources/newline_before_return_example.dart';
 
 void main() {
   group('NewlineBeforeReturnRule', () {
@@ -27,10 +26,10 @@ void main() {
 
       RuleTestHelper.verifyIssues(
         issues: issues,
-        startOffsets: [177, 898, 1060],
-        startLines: [12, 57, 69],
+        startOffsets: [256, 977, 1139],
+        startLines: [13, 58, 70],
         startColumns: [5, 5, 5],
-        endOffsets: [190, 911, 1073],
+        endOffsets: [269, 990, 1152],
         locationTexts: [
           'return a + 1;',
           'return a + 2;',