Issue #92: fixed formatting with 'dart format'

Author: tozpeak

lib/src/lints/dont_create_a_return_var/dont_create_a_return_var_rule.dart

@@ -14,17 +14,17 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// ### Example
 ///
 /// #### BAD:
-/// 
+///
 /// ```dart
 /// void x() {
 ///   final y = 1;
-/// 
+///
 ///   return y;
 /// }
 /// ```
-/// 
+///
 /// #### GOOD:
-/// 
+///
 /// ```dart
 /// void x() {
 ///   return 1;
@@ -35,7 +35,7 @@ class DontCreateAReturnVarRule extends SolidLintRule {
   /// This lint rule represents the error
   /// when unnecessary return variable statement is found
   static const lintName = 'dont_create_a_return_var';
-  
+
   DontCreateAReturnVarRule._(super.config);
 
   /// Creates a new instance of [DontCreateAReturnVarRule]
@@ -52,7 +52,6 @@ Rewrite the variable evaluation into return statement instead.""",
     return DontCreateAReturnVarRule._(rule);
   }
 
-
   @override
   void run(
     CustomLintResolver resolver,
@@ -79,16 +78,18 @@ Rewrite the variable evaluation into return statement instead.""",
     if (expr is! SimpleIdentifier) return;
 
     final element = expr.element;
-    if(element is! LocalVariableElement2) return;
+    if (element is! LocalVariableElement2) return;
     final returnVariableElement = element;
 
-    if(!returnVariableElement.isFinal && !returnVariableElement.isConst) return;
-    
+    if (!returnVariableElement.isFinal && !returnVariableElement.isConst) {
+      return;
+    }
+
     final blockBody = statement.parent;
     if (blockBody == null) return;
 
     final visitor = DontCreateAReturnVarVisitor(
-      returnVariableElement, 
+      returnVariableElement,
       statement,
     );
     blockBody.visitChildren(visitor);
@@ -102,7 +103,7 @@ Rewrite the variable evaluation into return statement instead.""",
     }
 
     final declaration = visitor.variableDeclaration;
-    
+
     //check if immutable
     final initializer = declaration?.initializer;
     if (initializer == null) return;
@@ -111,20 +112,18 @@ Rewrite the variable evaluation into return statement instead.""",
 
     reporter.atNode(statement, code);
   }
-  
+
   bool _isExpressionImmutable(Expression expr) {
     if (expr is Literal) return true;
 
     if (expr case final PrefixedIdentifier prefixed) {
-      return
-        _isExpressionImmutable(prefixed.prefix)
-        && _isExpressionImmutable(prefixed.identifier);
+      return _isExpressionImmutable(prefixed.prefix) &&
+          _isExpressionImmutable(prefixed.identifier);
     }
 
     if (expr case final BinaryExpression binExpr) {
-      return
-        _isExpressionImmutable(binExpr.leftOperand)
-        && _isExpressionImmutable(binExpr.rightOperand);
+      return _isExpressionImmutable(binExpr.leftOperand) &&
+          _isExpressionImmutable(binExpr.rightOperand);
     }
 
     if (expr case final SimpleIdentifier identifier) {
@@ -135,20 +134,16 @@ Rewrite the variable evaluation into return statement instead.""",
   }
 
   bool _isSimpleIdentifierImmutable(SimpleIdentifier identifier) {
-    if (identifier.element
-      case final VariableElement2 variable
-      when variable.isFinal || variable.isConst
-      ) {
-        return true;
+    if (identifier.element case final VariableElement2 variable
+        when variable.isFinal || variable.isConst) {
+      return true;
     }
 
     if (identifier.element is ClassElement2) return true;
-    
+
     if (identifier.element case final GetterElement getter) {
-      if (getter.variable3
-        case final PropertyInducingElement2 property
-        when property.isFinal || property.isConst
-        ) {
+      if (getter.variable3 case final PropertyInducingElement2 property
+          when property.isFinal || property.isConst) {
         return true;
       }
     }

lib/src/lints/dont_create_a_return_var/visitors/dont_create_a_return_var_visitor.dart

@@ -17,26 +17,26 @@ class DontCreateAReturnVarVisitor extends RecursiveAstVisitor<void> {
   bool _foundTokensBetweenDeclarationAndReturn = false;
   VariableDeclaration? _variableDeclaration;
   int _variableStatementCounter = 0;
-  
+
   final ReturnStatement _returnStatement;
 
   /// After visiting holds info about whether there are any tokens
   /// between variable declaration and return statement
   bool get foundTokensBetweenDeclarationAndReturn =>
-    _foundTokensBetweenDeclarationAndReturn;
+      _foundTokensBetweenDeclarationAndReturn;
+
   /// Returns statement of local variable declaration
-  VariableDeclaration? get variableDeclaration
-    => _variableDeclaration;
+  VariableDeclaration? get variableDeclaration => _variableDeclaration;
 
   /// Creates a new instance of [DontCreateAReturnVarVisitor].
   DontCreateAReturnVarVisitor(
-    this._returnVariableElement, 
+    this._returnVariableElement,
     this._returnStatement,
   );
 
   /// Defines whether the variables is used in return statement only.
   bool hasBadStatementCount() =>
-    _variableStatementCounter == _badStatementCount;
+      _variableStatementCounter == _badStatementCount;
 
   @override
   void visitVariableDeclarationStatement(VariableDeclarationStatement node) {
@@ -48,34 +48,31 @@ class DontCreateAReturnVarVisitor extends RecursiveAstVisitor<void> {
 
   @override
   void visitSimpleIdentifier(SimpleIdentifier node) {
-    if(node.element?.id == _returnVariableElement.id) {
+    if (node.element?.id == _returnVariableElement.id) {
       _variableStatementCounter++;
     }
 
     super.visitSimpleIdentifier(node);
   }
-  
+
   bool _collectVariableDeclaration(VariableDeclarationStatement node) {
-    final targetVariable =
-      node.variables.variables
-      .firstWhereOrNull(
-        (v)
-        => v.declaredElement2?.id == _returnVariableElement.id,
-      );
+    final targetVariable = node.variables.variables.firstWhereOrNull(
+      (v) => v.declaredElement2?.id == _returnVariableElement.id,
+    );
     if (targetVariable == null) return false;
 
     _variableDeclaration = targetVariable;
     return true;
   }
-  
+
   void _checkTokensInBetween(
-    VariableDeclarationStatement variableDeclaration, 
+    VariableDeclarationStatement variableDeclaration,
     ReturnStatement returnStatement,
   ) {
-    final tokenBeforeReturn = 
-      _returnStatement.findPrevious(_returnStatement.beginToken);
-    
-    if(tokenBeforeReturn != variableDeclaration.endToken) {
+    final tokenBeforeReturn =
+        _returnStatement.findPrevious(_returnStatement.beginToken);
+
+    if (tokenBeforeReturn != variableDeclaration.endToken) {
       _foundTokensBetweenDeclarationAndReturn = true;
     }
   }

lint_test/dont_create_a_return_var_test.dart

@@ -27,7 +27,7 @@ int returnVarTestCachedMutable() {
   var a = 1;
   final result = a;
   _doNothing();
-  
+
   return result;
 }
 
@@ -39,7 +39,7 @@ int returnVarTestReturnFollowsDeclaration() {
   final result = a;
 
   //Some comment here
-  
+
   //expect_lint: dont_create_a_return_var
   return result;
 }
@@ -52,7 +52,7 @@ int returnVarTestCachedAnotherMethodResult() {
   var a = 1;
   final result = _testValueEval();
   _doNothing();
-  
+
   return result;
 }
 
@@ -64,7 +64,7 @@ int returnVarTestCachedObjectField() {
   final obj = _TestClass();
   final result = obj.varField;
   _doNothing();
-  
+
   return result;
 }
 
@@ -75,15 +75,15 @@ int returnVarTestUsedVariable() {
   var a = 1;
   final result = 2;
   a += result;
-  
+
   return result;
 }
 
 /// Test the dont_create_a_return_var.
 /// Bad code, trivial example.
 int returnVarTestBadTrivial() {
   final result = 1;
-  
+
   //expect_lint: dont_create_a_return_var
   return result;
 }
@@ -95,13 +95,12 @@ int returnVarTestBadImmutableExpression() {
   const constLocal = 1;
   final finalLocal = 1;
   final testObj = _TestClass();
-  final result =
-    constLocal
-    + finalLocal
-    + 1 //const literal
-    + _TestClass.constValue
-    + _TestClass.finalValue
-    + testObj.finalField;
+  final result = constLocal +
+      finalLocal +
+      1 + //const literal
+      _TestClass.constValue +
+      _TestClass.finalValue +
+      testObj.finalField;
   _doNothing();
 
   //expect_lint: dont_create_a_return_var
@@ -114,7 +113,7 @@ int _testValueEval() {
 
 /// This method is a placeholder for unpredictable behaviour
 /// which can potentially change any mutable variables
-void _doNothing() { }
+void _doNothing() {}
 
 //ignore: prefer_match_file_name
 class _TestClass {
@@ -123,4 +122,4 @@ class _TestClass {
   //ignore: member_ordering
   final finalField = 1;
   var varField = 1;
-}
+}