feat: method config for use-setstate-synchronously

Author: Desdaemon

lib/src/analyzers/lint_analyzer/rules/rules_list/use_setstate_synchronously/config.dart

@@ -0,0 +1,9 @@
+part of 'use_setstate_synchronously_rule.dart';
+
+Set<String> readMethods(Map<String, Object> options) {
+  final fromConfig = options['methods'];
+
+  return fromConfig is List
+      ? fromConfig.whereType<String>().toSet()
+      : {'setState'};
+}

lib/src/analyzers/lint_analyzer/rules/rules_list/use_setstate_synchronously/use_setstate_synchronously_rule.dart

@@ -13,15 +13,17 @@ import '../../rule_utils.dart';
 
 part 'fact.dart';
 part 'helpers.dart';
+part 'config.dart';
 part 'visitor.dart';
 
 class UseSetStateSynchronouslyRule extends FlutterRule {
   static const ruleId = 'use-setstate-synchronously';
-  static const _warning =
-      "Avoid calling 'setState' past an await point without checking if the widget is mounted.";
+
+  Set<String> methods;
 
   UseSetStateSynchronouslyRule([Map<String, Object> options = const {}])
-      : super(
+      : methods = readMethods(options),
+        super(
           id: ruleId,
           severity: readSeverity(options, Severity.warning),
           excludes: readExcludes(options),
@@ -30,14 +32,15 @@ class UseSetStateSynchronouslyRule extends FlutterRule {
 
   @override
   Iterable<Issue> check(InternalResolvedUnitResult source) {
-    final visitor = _Visitor();
+    final visitor = _Visitor(methods: methods);
     source.unit.visitChildren(visitor);
 
     return visitor.nodes
         .map((node) => createIssue(
               rule: this,
               location: nodeLocation(node: node, source: source),
-              message: _warning,
+              message: "Avoid calling '${node.name}' past an await point "
+                  'without checking if the widget is mounted.',
             ))
         .toList(growable: false);
   }

lib/src/analyzers/lint_analyzer/rules/rules_list/use_setstate_synchronously/visitor.dart

@@ -1,6 +1,9 @@
 part of 'use_setstate_synchronously_rule.dart';
 
 class _Visitor extends RecursiveAstVisitor<void> {
+  final Set<String> methods;
+  _Visitor({required this.methods});
+
   final nodes = <SimpleIdentifier>[];
 
   @override
@@ -15,13 +18,18 @@ class _Visitor extends RecursiveAstVisitor<void> {
     if (!node.isAsynchronous) {
       return super.visitBlockFunctionBody(node);
     }
-    final visitor = _AsyncSetStateVisitor();
+    final visitor = _AsyncSetStateVisitor(validateMethod: methods.contains);
     node.visitChildren(visitor);
     nodes.addAll(visitor.nodes);
   }
 }
 
 class _AsyncSetStateVisitor extends RecursiveAstVisitor<void> {
+  static bool _noop(String _) => false;
+
+  bool Function(String) validateMethod;
+  _AsyncSetStateVisitor({this.validateMethod = _noop});
+
   MountedFact mounted = true.asFact();
   final nodes = <SimpleIdentifier>[];
 
@@ -36,8 +44,8 @@ class _AsyncSetStateVisitor extends RecursiveAstVisitor<void> {
     // [this.]setState()
     final mounted_ = mounted.value ?? false;
     if (!mounted_ &&
-        node.methodName.name == 'setState' &&
-        node.target is ThisExpression?) {
+        (node.target is ThisExpression?) &&
+        validateMethod(node.methodName.name)) {
       nodes.add(node.methodName);
     }
 

website/docs/rules/flutter/use-setstate-synchronously.mdx

@@ -1,6 +1,6 @@
 import RuleDetails from '@site/src/components/RuleDetails';
 
-<RuleDetails version="UNRELEASED" severity="warning" />
+<RuleDetails version="UNRELEASED" severity="warning" hasConfig />
 
 Warns when [`setState`] is called past an *await point* (also known as asynchronous gap) within a subclass of State.
 
@@ -42,6 +42,21 @@ Additional resources:
 - [`use_build_context_synchronously`](https://dart-lang.github.io/linter/lints/use_build_context_synchronously.html),
   a lint that checks for async usages of `BuildContext`
 
+### ⚙️ Config example {#config-example}
+
+```yaml
+dart_code_metrics:
+  ...
+  rules:
+    ...
+    - use-setstate-synchronously:
+        methods:
+          - setState
+          - yourMethod
+```
+
+configures the methods `setState` and `yourMethod` to be scanned for unchecked async calls.
+
 ### Example {#example}
 
 **❌ Bad:**

website/docs/rules/index.mdx

@@ -602,6 +602,7 @@ Rules are grouped by category to help you understand their purpose. Each rule ha
   type="flutter"
   severity="warning"
   version="UNRELEASED"
+  hasConfig
 >
   Warns when <code>setState</code> is called past an await point.
 </RuleEntry>