chore: review fixes

Author: incendial

doc/rules/avoid-unnecessary-setstate.md

@@ -45,7 +45,7 @@ class _MyWidgetState extends State<MyWidget> {
       });
     }
 
-    myMethod(); // LINT
+    myStateUpdateMethod(); // LINT
   }
 
   @override
@@ -56,7 +56,7 @@ class _MyWidgetState extends State<MyWidget> {
     });
   }
 
-  void myMethod() {
+  void myStateUpdateMethod() {
     setState(() {
       myString = "Hello";
     });
@@ -76,10 +76,10 @@ class _MyWidgetState extends State<MyWidget> {
       });
     }
 
-    myMethod(); // LINT
+    myStateUpdateMethod(); // LINT
 
     return ElevatedButton(
-      onPressed: () => myMethod(),
+      onPressed: () => myStateUpdateMethod(),
       onLongPress: () {
         setState(() {
           myString = data;
@@ -108,16 +108,18 @@ class _MyWidgetState extends State<MyWidget> {
   void initState() {
     super.initState();
 
+    myString = "Hello";
+
     classWithMethod.myMethod();
     myAsyncMethod();
   }
 
   @override
   void didUpdateWidget(MyWidget oldWidget) {
-    ...
+    myString = "Hello";
   }
 
-  void myMethod() {
+  void myStateUpdateMethod() {
     setState(() {
       myString = "Hello";
     });
@@ -136,7 +138,7 @@ class _MyWidgetState extends State<MyWidget> {
     myAsyncMethod();
 
     return ElevatedButton(
-      onPressed: () => myMethod(),
+      onPressed: () => myStateUpdateMethod(),
       onLongPress: () {
         setState(() {
           myString = data;

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_unnecessary_setstate/avoid_unnecessary_setstate.dart

@@ -16,15 +16,17 @@ part 'visitor.dart';
 class AvoidUnnecessarySetStateRule extends Rule {
   static const String ruleId = 'avoid-unnecessary-setstate';
 
-  static const _warningMessage = 'Avoid calling unnecessary setState.';
+  static const _warningMessage =
+      'Avoid calling unnecessary setState. Consider changing the state directly.';
   static const _methodWarningMessage = 'Avoid calling a method with setState.';
 
   AvoidUnnecessarySetStateRule([Map<String, Object> config = const {}])
       : super(
           id: ruleId,
           documentation: const RuleDocumentation(
             name: 'Avoid returning widgets',
-            brief: 'Warns ',
+            brief:
+                'Warns when `setState` is called inside `initState`, `didUpdateWidget` or `build` methods and when it is called from a `sync` method that is called inside those methods.',
           ),
           severity: readSeverity(config, Severity.warning),
           excludes: readExcludes(config),
@@ -37,26 +39,22 @@ class AvoidUnnecessarySetStateRule extends Rule {
     source.unit.visitChildren(_visitor);
 
     return [
-      ..._visitor.setStateInvocations
-          .map((invocation) => createIssue(
-                rule: this,
-                location: nodeLocation(
-                  node: invocation,
-                  source: source,
-                ),
-                message: _warningMessage,
-              ))
-          .toList(growable: false),
-      ..._visitor.classMethodsInvocations
-          .map((invocation) => createIssue(
-                rule: this,
-                location: nodeLocation(
-                  node: invocation,
-                  source: source,
-                ),
-                message: _methodWarningMessage,
-              ))
-          .toList(growable: false)
+      ..._visitor.setStateInvocations.map((invocation) => createIssue(
+            rule: this,
+            location: nodeLocation(
+              node: invocation,
+              source: source,
+            ),
+            message: _warningMessage,
+          )),
+      ..._visitor.classMethodsInvocations.map((invocation) => createIssue(
+            rule: this,
+            location: nodeLocation(
+              node: invocation,
+              source: source,
+            ),
+            message: _methodWarningMessage,
+          ))
     ];
   }
 }

test/analyzers/lint_analyzer/rules/rules_list/avoid_unnecessary_setstate/avoid_unnecessary_setstate_test.dart

@@ -8,6 +8,8 @@ import '../../../../../helpers/rule_test_helper.dart';
 // ignore_for_file: no_adjacent_strings_in_list
 
 const _examplePath = 'avoid_unnecessary_setstate/examples/example.dart';
+const _stateSubclassExamplePath =
+    'avoid_unnecessary_setstate/examples/state_subclass_example.dart';
 
 void main() {
   group('AvoidUnnecessarySetStateRule', () {
@@ -62,5 +64,13 @@ void main() {
         ],
       );
     });
+
+    test('reports no issues with State subclass', () async {
+      final unit =
+          await RuleTestHelper.resolveFromFile(_stateSubclassExamplePath);
+      final issues = AvoidUnnecessarySetStateRule().check(unit);
+
+      RuleTestHelper.verifyNoIssues(issues);
+    });
   });
 }

test/analyzers/lint_analyzer/rules/rules_list/avoid_unnecessary_setstate/examples/state_subclass_example.dart

@@ -0,0 +1,75 @@
+class MyWidget extends StatefulWidget {
+  @override
+  _MyWidgetState createState() => _MyWidgetState();
+}
+
+class _MyWidgetState extends BaseState<MyWidget> {
+  String myString = '';
+
+  @override
+  void initState() {
+    super.initState();
+
+    classWithMethod.myMethod();
+    myAsyncMethod();
+  }
+
+  void myMethod() {
+    setState(() {
+      myString = "Hello";
+    });
+  }
+
+  Future<void> myAsyncMethod() async {
+    final data = await service.fetchData();
+
+    setState(() {
+      myString = data;
+    });
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    final widget = ElevatedButton(
+      onPressed: () => myMethod(),
+      onLongPress: () {
+        setState(() {
+          myString = data;
+        });
+      },
+      child: Text('PRESS'),
+    );
+
+    myAsyncMethod();
+
+    return ElevatedButton(
+      onPressed: () => myMethod(),
+      onLongPress: () {
+        setState(() {
+          myString = data;
+        });
+      },
+      child: Text('PRESS'),
+    );
+  }
+}
+
+class ElevatedButton {
+  final Function onPressed;
+  final Function onLongPress;
+  final dynamic child;
+
+  const ElevatedButton(
+    this.onPressed,
+    this.onLongPress,
+    this.child,
+  );
+}
+
+class SomeClassWithMethod {
+  void myMethod() {}
+}
+
+class State<T> {}
+
+class BaseState<T> extends State<T> {}