Issue #92: renaming rule to avoid_unnecessary_return_variable

Author: tozpeak

lib/analysis_options.yaml

@@ -56,7 +56,7 @@ custom_lint:
     - cyclomatic_complexity:
       max_complexity: 10
 
-    - dont_create_a_return_var
+    - avoid_unnecessary_return_variable
     - double_literal_format
 
     - function_lines_of_code:

lib/solid_lints.dart

@@ -7,14 +7,14 @@ import 'package:solid_lints/src/lints/avoid_global_state/avoid_global_state_rule
 import 'package:solid_lints/src/lints/avoid_late_keyword/avoid_late_keyword_rule.dart';
 import 'package:solid_lints/src/lints/avoid_non_null_assertion/avoid_non_null_assertion_rule.dart';
 import 'package:solid_lints/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart';
+import 'package:solid_lints/src/lints/avoid_unnecessary_return_variable/avoid_unnecessary_return_variable_rule.dart';
 import 'package:solid_lints/src/lints/avoid_unnecessary_setstate/avoid_unnecessary_set_state_rule.dart';
 import 'package:solid_lints/src/lints/avoid_unnecessary_type_assertions/avoid_unnecessary_type_assertions_rule.dart';
 import 'package:solid_lints/src/lints/avoid_unnecessary_type_casts/avoid_unnecessary_type_casts_rule.dart';
 import 'package:solid_lints/src/lints/avoid_unrelated_type_assertions/avoid_unrelated_type_assertions_rule.dart';
 import 'package:solid_lints/src/lints/avoid_unused_parameters/avoid_unused_parameters_rule.dart';
 import 'package:solid_lints/src/lints/avoid_using_api/avoid_using_api_rule.dart';
 import 'package:solid_lints/src/lints/cyclomatic_complexity/cyclomatic_complexity_rule.dart';
-import 'package:solid_lints/src/lints/dont_create_a_return_var/dont_create_a_return_var_rule.dart';
 import 'package:solid_lints/src/lints/double_literal_format/double_literal_format_rule.dart';
 import 'package:solid_lints/src/lints/function_lines_of_code/function_lines_of_code_rule.dart';
 import 'package:solid_lints/src/lints/member_ordering/member_ordering_rule.dart';
@@ -68,7 +68,7 @@ class _SolidLints extends PluginBase {
       PreferEarlyReturnRule.createRule(configs),
       AvoidFinalWithGetterRule.createRule(configs),
       NamedParametersOrderingRule.createRule(configs),
-      DontCreateAReturnVarRule.createRule(configs),
+      AvoidUnnecessaryReturnVariableRule.createRule(configs),
     ];
 
     // Return only enabled rules

…n_var/dont_create_a_return_var_rule.dart …id_unnecessary_return_variable_rule.dartlib/src/lints/dont_create_a_return_var/dont_create_a_return_var_rule.dart renamed to lib/src/lints/avoid_unnecessary_return_variable/avoid_unnecessary_return_variable_rule.dart lib/src/lints/dont_create_a_return_var/dont_create_a_return_var_rule.dart renamed to lib/src/lints/avoid_unnecessary_return_variable/avoid_unnecessary_return_variable_rule.dart

@@ -2,12 +2,12 @@ import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element2.dart';
 import 'package:analyzer/error/listener.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
-import 'package:solid_lints/src/lints/dont_create_a_return_var/visitors/dont_create_a_return_var_visitor.dart';
+import 'package:solid_lints/src/lints/avoid_unnecessary_return_variable/visitors/avoid_unnecessary_return_variable_visitor.dart';
 import 'package:solid_lints/src/models/rule_config.dart';
 import 'package:solid_lints/src/models/solid_lint_rule.dart';
 
-/// A `dont_create_a_return_var` rule which forbids returning an immutable
-/// variable if it can be rewritten in return statement itself.
+/// An `avoid_unnecessary_return_variable` rule which forbids returning
+/// an immutable variable if it can be rewritten in return statement itself.
 ///
 /// See more here: https://github.com/solid-software/solid_lints/issues/92
 ///
@@ -31,16 +31,18 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
 /// }
 /// ```
 ///
-class DontCreateAReturnVarRule extends SolidLintRule {
+class AvoidUnnecessaryReturnVariableRule extends SolidLintRule {
   /// This lint rule represents the error
   /// when unnecessary return variable statement is found
-  static const lintName = 'dont_create_a_return_var';
+  static const lintName = 'avoid_unnecessary_return_variable';
 
-  DontCreateAReturnVarRule._(super.config);
+  AvoidUnnecessaryReturnVariableRule._(super.config);
 
-  /// Creates a new instance of [DontCreateAReturnVarRule]
+  /// Creates a new instance of [AvoidUnnecessaryReturnVariableRule]
   /// based on the lint configuration.
-  factory DontCreateAReturnVarRule.createRule(CustomLintConfigs configs) {
+  factory AvoidUnnecessaryReturnVariableRule.createRule(
+    CustomLintConfigs configs,
+  ) {
     final rule = RuleConfig(
       configs: configs,
       name: lintName,
@@ -49,7 +51,7 @@ Avoid creating unnecessary variable only for return.
 Rewrite the variable evaluation into return statement instead.""",
     );
 
-    return DontCreateAReturnVarRule._(rule);
+    return AvoidUnnecessaryReturnVariableRule._(rule);
   }
 
   @override
@@ -88,7 +90,7 @@ Rewrite the variable evaluation into return statement instead.""",
     final blockBody = statement.parent;
     if (blockBody == null) return;
 
-    final visitor = DontCreateAReturnVarVisitor(
+    final visitor = AvoidUnnecessaryReturnVariableVisitor(
       returnVariableElement,
       statement,
     );

…rs/dont_create_a_return_var_visitor.dart …unnecessary_return_variable_visitor.dartlib/src/lints/dont_create_a_return_var/visitors/dont_create_a_return_var_visitor.dart renamed to lib/src/lints/avoid_unnecessary_return_variable/visitors/avoid_unnecessary_return_variable_visitor.dart lib/src/lints/dont_create_a_return_var/visitors/dont_create_a_return_var_visitor.dart renamed to lib/src/lints/avoid_unnecessary_return_variable/visitors/avoid_unnecessary_return_variable_visitor.dart

@@ -5,7 +5,7 @@ import 'package:collection/collection.dart';
 
 /// This visitor is searches all uses of a single local variable,
 /// including variable declaration.
-class DontCreateAReturnVarVisitor extends RecursiveAstVisitor<void> {
+class AvoidUnnecessaryReturnVariableVisitor extends RecursiveAstVisitor<void> {
   /// The problem expects that exactly 1 mention of return variable.
   /// VariableDeclarationStatement doesn't count when visiting SimpleIdentifier.
   /// Any other amount of variable mentions implies that it is used somewhere
@@ -28,8 +28,8 @@ class DontCreateAReturnVarVisitor extends RecursiveAstVisitor<void> {
   /// Returns statement of local variable declaration
   VariableDeclaration? get variableDeclaration => _variableDeclaration;
 
-  /// Creates a new instance of [DontCreateAReturnVarVisitor].
-  DontCreateAReturnVarVisitor(
+  /// Creates a new instance of [AvoidUnnecessaryReturnVariableVisitor].
+  AvoidUnnecessaryReturnVariableVisitor(
     this._returnVariableElement,
     this._returnStatement,
   );

lint_test/analysis_options.yaml

@@ -89,4 +89,4 @@ custom_lint:
         - required
         - nullable
         - default
-    - dont_create_a_return_var
+    - avoid_unnecessary_return_variable

lint_test/dont_create_a_return_var_test.dart

@@ -1,12 +1,12 @@
 // ignore_for_file: unused_local_variable, newline_before_return, no_empty_block
 
-/// Test the dont_create_a_return_var.
+/// Test the avoid_unnecessary_return_variable.
 /// Good code, trivial case.
 int returnVarTestGoodTrivial() {
   return 1;
 }
 
-/// Test the dont_create_a_return_var.
+/// Test the avoid_unnecessary_return_variable.
 /// Returning mutable variable should not trigger the lint.
 int returnVarTestReturnMutable() {
   var a = 1;
@@ -19,7 +19,7 @@ int returnVarTestReturnParameter(int param) {
   return param;
 }
 
-/// Test the dont_create_a_return_var.
+/// Test the avoid_unnecessary_return_variable.
 /// Caching mutable variable value.
 /// Unpredictable: may be useful to cache value
 /// before operation can change it.
@@ -31,7 +31,7 @@ int returnVarTestCachedMutable() {
   return result;
 }
 
-/// Test the dont_create_a_return_var.
+/// Test the avoid_unnecessary_return_variable.
 /// Caching mutable variable value, but return goes
 /// right after declaration, which makes it bad.
 int returnVarTestReturnFollowsDeclaration() {
@@ -40,11 +40,11 @@ int returnVarTestReturnFollowsDeclaration() {
 
   //Some comment here
 
-  //expect_lint: dont_create_a_return_var
+  //expect_lint: avoid_unnecessary_return_variable
   return result;
 }
 
-/// Test the dont_create_a_return_var.
+/// Test the avoid_unnecessary_return_variable.
 /// Caching another method result.
 /// Unpredictable: may be useful to cache value
 /// before operation can change it.
@@ -56,7 +56,7 @@ int returnVarTestCachedAnotherMethodResult() {
   return result;
 }
 
-/// Test the dont_create_a_return_var.
+/// Test the avoid_unnecessary_return_variable.
 /// Caching value of object's field.
 /// Unpredictable: may be useful to cache value
 /// before operation can change it.
@@ -68,7 +68,7 @@ int returnVarTestCachedObjectField() {
   return result;
 }
 
-/// Test the dont_create_a_return_var.
+/// Test the avoid_unnecessary_return_variable.
 /// Good: variable is created not only for return
 /// but is used in following expressions as well.
 int returnVarTestUsedVariable() {
@@ -79,16 +79,16 @@ int returnVarTestUsedVariable() {
   return result;
 }
 
-/// Test the dont_create_a_return_var.
+/// Test the avoid_unnecessary_return_variable.
 /// Bad code, trivial example.
 int returnVarTestBadTrivial() {
   final result = 1;
 
-  //expect_lint: dont_create_a_return_var
+  //expect_lint: avoid_unnecessary_return_variable
   return result;
 }
 
-/// Test the dont_create_a_return_var.
+/// Test the avoid_unnecessary_return_variable.
 /// Bad code: result expression is immutable,
 /// so can be written in return statement directly.
 int returnVarTestBadImmutableExpression() {
@@ -103,7 +103,7 @@ int returnVarTestBadImmutableExpression() {
       testObj.finalField;
   _doNothing();
 
-  //expect_lint: dont_create_a_return_var
+  //expect_lint: avoid_unnecessary_return_variable
   return result;
 }