add quick fix to avoid_final_with_getter (#164)

* add avoid_final_with_getter rule

* Update analysis_options.yaml to exclude final fields with getters

* Refactor avoid_final_with_getter_rule.dart and avoid_final_with_getter_visitor.dart

* Fix incorrect test comments in avoid_final_with_getter_test.dart

* change avoid_final_with_getter, now it lints getter, no getter name equality

* Refactor avoid_final_with_getter_visitor.dart to remove isStatic property from declaredElement

* add more tests to avoid_final_with_getter_test.dart

* Add avoid_final_with_getter rule to CHANGELOG.md

* add quick fix to avoid_final_with_getter

* Refactor avoid_final_with_getter_visitor.dart to use local variable instead of accessing visitor.variable directly

Author: 4akloon

lib/src/lints/avoid_final_with_getter/avoid_final_with_getter_fix.dart

@@ -0,0 +1,36 @@
+part of 'avoid_final_with_getter_rule.dart';
+
+class _FinalWithGetterFix extends DartFix {
+  @override
+  void run(
+    CustomLintResolver resolver,
+    ChangeReporter reporter,
+    CustomLintContext context,
+    AnalysisError analysisError,
+    List<AnalysisError> others,
+  ) {
+    context.registry.addMethodDeclaration((node) {
+      if (analysisError.sourceRange.intersects(node.sourceRange)) {
+        final info = analysisError.data as FinalWithGetterInfo?;
+        if (info == null) return;
+
+        _addReplacement(reporter, info);
+      }
+    });
+  }
+
+  void _addReplacement(
+    ChangeReporter reporter,
+    FinalWithGetterInfo info,
+  ) {
+    final changeBuilder = reporter.createChangeBuilder(
+      message: "Remove getter and make variable public.",
+      priority: 1,
+    );
+
+    changeBuilder.addDartFileEdit((builder) {
+      builder.addDeletion(info.getter.sourceRange);
+      builder.addDeletion(SourceRange(info.variable.name.offset, 1));
+    });
+  }
+}

lib/src/lints/avoid_final_with_getter/avoid_final_with_getter_rule.dart

@@ -1,9 +1,13 @@
+import 'package:analyzer/error/error.dart';
 import 'package:analyzer/error/listener.dart';
+import 'package:analyzer/source/source_range.dart';
 import 'package:custom_lint_builder/custom_lint_builder.dart';
 import 'package:solid_lints/src/lints/avoid_final_with_getter/visitors/avoid_final_with_getter_visitor.dart';
 import 'package:solid_lints/src/models/rule_config.dart';
 import 'package:solid_lints/src/models/solid_lint_rule.dart';
 
+part 'avoid_final_with_getter_fix.dart';
+
 /// Avoid using final private fields with getters.
 ///
 /// Final private variables used in a pair with a getter
@@ -59,9 +63,18 @@ class AvoidFinalWithGetterRule extends SolidLintRule {
       final visitor = AvoidFinalWithGetterVisitor();
       node.accept(visitor);
 
-      for (final getter in visitor.getters) {
-        reporter.reportErrorForNode(code, getter);
+      for (final element in visitor.getters) {
+        reporter.reportErrorForNode(
+          code,
+          element.getter,
+          null,
+          null,
+          element,
+        );
       }
     });
   }
+
+  @override
+  List<Fix> getFixes() => [_FinalWithGetterFix()];
 }

lib/src/lints/avoid_final_with_getter/visitors/avoid_final_with_getter_visitor.dart

@@ -6,10 +6,10 @@ import 'package:solid_lints/src/lints/avoid_final_with_getter/visitors/getter_va
 /// A visitor that checks for final private fields with getters.
 /// If a final private field has a getter, it is considered as a public field.
 class AvoidFinalWithGetterVisitor extends RecursiveAstVisitor<void> {
-  final _getters = <MethodDeclaration>[];
+  final _getters = <FinalWithGetterInfo>{};
 
   /// List of getters
-  Iterable<MethodDeclaration> get getters => _getters;
+  Set<FinalWithGetterInfo> get getters => _getters;
 
   @override
   void visitMethodDeclaration(MethodDeclaration node) {
@@ -24,10 +24,24 @@ class AvoidFinalWithGetterVisitor extends RecursiveAstVisitor<void> {
       final visitor = GetterVariableVisitor(node);
       node.parent?.accept(visitor);
 
-      if (visitor.hasVariable) {
-        _getters.add(node);
+      final variable = visitor.variable;
+
+      if (variable != null) {
+        _getters.add(FinalWithGetterInfo(node, variable));
       }
     }
     super.visitMethodDeclaration(node);
   }
 }
+
+/// Information about the final private field with a getter.
+class FinalWithGetterInfo {
+  /// The getter method declaration.
+  final MethodDeclaration getter;
+
+  /// The variable declaration.
+  final VariableDeclaration variable;
+
+  /// Creates a new instance of [FinalWithGetterInfo]
+  const FinalWithGetterInfo(this.getter, this.variable);
+}

lib/src/lints/avoid_final_with_getter/visitors/getter_variable_visitor.dart

@@ -13,7 +13,7 @@ class GetterVariableVisitor extends RecursiveAstVisitor<void> {
       : _getterId = getter.getterReferenceId;
 
   /// Is there a variable associated with the getter
-  bool get hasVariable => _variable != null;
+  VariableDeclaration? get variable => _variable;
 
   @override
   void visitVariableDeclaration(VariableDeclaration node) {