Skip to content
This repository was archived by the owner on Jul 16, 2023. It is now read-only.

Commit 42893bd

Browse files
committed
chore: rename rule to use-setstate-synchronously
1 parent 4c04f83 commit 42893bd

File tree

9 files changed

+19
-15
lines changed

9 files changed

+19
-15
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## Unreleased
4+
5+
* feat: add [`use-setstate-synchronously`](https://dartcodemetrics.dev/docs/rules/flutter/use-setstate-synchronously)
6+
37
## 5.3.0
48

59
* feat: add static code diagnostic [`list-all-equatable-fields`](https://dartcodemetrics.dev/docs/rules/common/list-all-equatable-fields).

lib/src/analyzers/lint_analyzer/rules/rules_factory.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import 'models/rule.dart';
22
import 'rules_list/always_remove_listener/always_remove_listener_rule.dart';
33
import 'rules_list/arguments_ordering/arguments_ordering_rule.dart';
4-
import 'rules_list/avoid_async_setstate/avoid_async_setstate_rule.dart';
54
import 'rules_list/avoid_banned_imports/avoid_banned_imports_rule.dart';
65
import 'rules_list/avoid_border_all/avoid_border_all_rule.dart';
76
import 'rules_list/avoid_cascade_after_if_null/avoid_cascade_after_if_null_rule.dart';
@@ -72,6 +71,7 @@ import 'rules_list/prefer_trailing_comma/prefer_trailing_comma_rule.dart';
7271
import 'rules_list/prefer_using_list_view/prefer_using_list_view_rule.dart';
7372
import 'rules_list/provide_correct_intl_args/provide_correct_intl_args_rule.dart';
7473
import 'rules_list/tag_name/tag_name_rule.dart';
74+
import 'rules_list/use_setstate_synchronously/use_setstate_synchronously_rule.dart';
7575

7676
final _implementedRules = <String, Rule Function(Map<String, Object>)>{
7777
AlwaysRemoveListenerRule.ruleId: AlwaysRemoveListenerRule.new,
@@ -103,7 +103,7 @@ final _implementedRules = <String, Rule Function(Map<String, Object>)>{
103103
AvoidTopLevelMembersInTestsRule.ruleId: AvoidTopLevelMembersInTestsRule.new,
104104
AvoidUnnecessaryConditionalsRule.ruleId: AvoidUnnecessaryConditionalsRule.new,
105105
AvoidUnnecessarySetStateRule.ruleId: AvoidUnnecessarySetStateRule.new,
106-
AvoidAsyncSetStateRule.ruleId: AvoidAsyncSetStateRule.new,
106+
UseSetStateSynchronouslyRule.ruleId: UseSetStateSynchronouslyRule.new,
107107
AvoidUnnecessaryTypeAssertionsRule.ruleId:
108108
AvoidUnnecessaryTypeAssertionsRule.new,
109109
AvoidUnnecessaryTypeCastsRule.ruleId: AvoidUnnecessaryTypeCastsRule.new,

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_async_setstate/helpers.dart renamed to lib/src/analyzers/lint_analyzer/rules/rules_list/use_setstate_synchronously/helpers.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
part of 'avoid_async_setstate_rule.dart';
1+
part of 'use_setstate_synchronously_rule.dart';
22

33
/// If null, the check was not indicative of whether mounted was true.
44
bool? _extractMountedCheck(Expression node) {

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_async_setstate/avoid_async_setstate_rule.dart renamed to lib/src/analyzers/lint_analyzer/rules/rules_list/use_setstate_synchronously/use_setstate_synchronously_rule.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ import '../../../models/severity.dart';
1111
import '../../models/flutter_rule.dart';
1212
import '../../rule_utils.dart';
1313

14-
part 'visitor.dart';
1514
part 'helpers.dart';
15+
part 'visitor.dart';
1616

17-
class AvoidAsyncSetStateRule extends FlutterRule {
18-
static const ruleId = 'avoid-async-setstate';
17+
class UseSetStateSynchronouslyRule extends FlutterRule {
18+
static const ruleId = 'use-setstate-synchronously';
1919
static const _warning =
2020
"Avoid calling 'setState' past an await point without checking if the widget is mounted.";
2121

22-
AvoidAsyncSetStateRule([Map<String, Object> options = const {}])
22+
UseSetStateSynchronouslyRule([Map<String, Object> options = const {}])
2323
: super(
2424
id: ruleId,
2525
severity: readSeverity(options, Severity.warning),

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_async_setstate/visitor.dart renamed to lib/src/analyzers/lint_analyzer/rules/rules_list/use_setstate_synchronously/visitor.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
part of 'avoid_async_setstate_rule.dart';
1+
part of 'use_setstate_synchronously_rule.dart';
22

33
class _Visitor extends RecursiveAstVisitor<void> {
44
final nodes = <SimpleIdentifier>[];

test/src/analyzers/lint_analyzer/rules/rules_list/avoid_async_setstate/avoid_async_setstate_rule_test.dart renamed to test/src/analyzers/lint_analyzer/rules/rules_list/use_setstate_synchronously/use_setstate_synchronously_rule_test.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/models/severity.dart';
2-
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/rules/rules_list/avoid_async_setstate/avoid_async_setstate_rule.dart';
2+
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/rules/rules_list/use_setstate_synchronously/use_setstate_synchronously_rule.dart';
33
import 'package:test/test.dart';
44

55
import '../../../../../helpers/rule_test_helper.dart';
66

7-
const _examplePath = 'avoid_async_setstate/examples/example.dart';
7+
const _examplePath = 'use_setstate_synchronously/examples/example.dart';
88

99
void main() {
10-
group('AvoidAsyncSetStateRule', () {
10+
group('UseSetStateSynchronouslyTest', () {
1111
test('initialization', () async {
1212
final unit = await RuleTestHelper.resolveFromFile(_examplePath);
13-
final issues = AvoidAsyncSetStateRule().check(unit);
13+
final issues = UseSetStateSynchronouslyRule().check(unit);
1414

1515
RuleTestHelper.verifyInitialization(
1616
issues: issues,
17-
ruleId: 'avoid-async-setstate',
17+
ruleId: 'use-setstate-synchronously',
1818
severity: Severity.warning,
1919
);
2020
});
2121

2222
test('reports about found issues', () async {
2323
final unit = await RuleTestHelper.resolveFromFile(_examplePath);
24-
final issues = AvoidAsyncSetStateRule().check(unit);
24+
final issues = UseSetStateSynchronouslyRule().check(unit);
2525

2626
RuleTestHelper.verifyIssues(
2727
issues: issues,

website/docs/rules/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,7 @@ Rules are grouped by category to help you understand their purpose. Each rule ha
598598
</RuleEntry>
599599

600600
<RuleEntry
601-
name="avoid-async-setstate"
601+
name="use-setstate-synchronously"
602602
type="flutter"
603603
severity="warning"
604604
version="UNRELEASED"

0 commit comments

Comments
 (0)