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

Commit 98b79b3

Browse files
dkrutskikhdkrutskikh
authored
feat: improve avoid unnecessary type assertions (#560)
* chore: update cSpell dictionary * chore: activate avoid-unnecessary-type-casts rule * feat: `avoid-unnecessary-type-assertions` now support `is!` * chore: facelift changelog
1 parent bd19b37 commit 98b79b3

File tree

7 files changed

+70
-48
lines changed

7 files changed

+70
-48
lines changed

‎.vscode/settings.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"cSpell.words": [
55
"ansicolor",
66
"Backport",
7+
"bools",
78
"codeclimate",
89
"codecov",
910
"cyclomatic",
@@ -14,6 +15,7 @@
1415
"Gitlab",
1516
"Halstead",
1617
"incendial",
18+
"ints",
1719
"lcov",
1820
"McCabe's",
1921
"mocktail",
@@ -23,6 +25,7 @@
2325
"semver",
2426
"setstate",
2527
"SLOC",
28+
"todos",
2629
"unawaited"
2730
]
2831
}

‎CHANGELOG.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22

33
## Unreleased
44

5-
* feat: add static code diagnostics `avoid-unnecessary-type-casts`
6-
* fix: fixed issue with type check in `avoid-unnecessary-type-assertions`
5+
* feat: add static code diagnostics `avoid-unnecessary-type-assertions`, `avoid-unnecessary-type-casts`
76
* feat: introduce file metrics
8-
* feat: add static code diagnostics `avoid-unnecessary-type-assertions`
7+
* chore: activate self implemented rules: `avoid-unnecessary-type-assertions`, `avoid-unnecessary-type-casts`, `prefer-first`, `prefer-last`, `prefer-match-file-name`
98
* refactor: cleanup anti-patterns, metrics and rules documentation
10-
* chore: activate self implemented rules: avoid-unnecessary-type-assertions, prefer-first, prefer-last, prefer-match-file-name
11-
* fix: no-magic-number not working in array of widgets
9+
* fix: `no-magic-number` not working in array of widgets
1210

1311
## 4.6.0
1412

‎analysis_options.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ dart_code_metrics:
3434
rules:
3535
- avoid-unused-parameters
3636
- avoid-unnecessary-type-assertions
37+
- avoid-unnecessary-type-casts
3738
- binary-expression-operand-order
3839
- double-literal-format
3940
- newline-before-return

‎lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_unnecessary_type_assertions/avoid_unnecessary_type_assertions_rule.dart‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ class AvoidUnnecessaryTypeAssertionsRule extends CommonRule {
3636
(node) => createIssue(
3737
rule: this,
3838
location: nodeLocation(node: node.key, source: source),
39-
message: 'Avoid unnecessary "${node.value}" assertion.',
39+
message: node.key is IsExpression
40+
? 'Avoid unnecessary "${node.value}" assertion. The result is always "${node.value == 'is'}".'
41+
: 'Avoid unnecessary "${node.value}" assertion.',
4042
),
4143
)
4244
.toList(growable: false);

‎lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_unnecessary_type_assertions/visitor.dart‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ class _Visitor extends RecursiveAstVisitor<void> {
2828
targetType.typeArguments.first,
2929
node.typeArguments?.arguments.first.type,
3030
)) {
31-
_expressions[node] = methodName;
31+
_expressions[node] =
32+
'${node.methodName}${node.typeArguments ?? ''}${node.argumentList}';
3233
}
3334
}
3435
}
@@ -38,7 +39,8 @@ class _Visitor extends RecursiveAstVisitor<void> {
3839
final objectType = node.expression.staticType;
3940
final castedType = node.type.type;
4041
if (_isUselessTypeCheck(objectType, castedType)) {
41-
_expressions[node] = 'is';
42+
_expressions[node] =
43+
'${node.isOperator.keyword?.lexeme ?? ''}${node.notOperator ?? ''}';
4244
}
4345
}
4446

‎test/src/analyzers/lint_analyzer/rules/rules_list/avoid_unnecessary_type_assertions/avoid_unnecessary_type_assertions_rule_test.dart‎

Lines changed: 52 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,12 @@ void main() {
4444
1620,
4545
1744,
4646
1954,
47-
2021,
48-
2099,
49-
2204,
50-
2263,
47+
1995,
48+
2096,
49+
2139,
50+
2259,
51+
2364,
52+
2423,
5153
],
5254
startLines: [
5355
6,
@@ -66,10 +68,12 @@ void main() {
6668
65,
6769
67,
6870
77,
69-
79,
71+
78,
72+
81,
7073
82,
71-
84,
72-
85,
74+
86,
75+
88,
76+
89,
7377
],
7478
startColumns: [
7579
20,
@@ -88,7 +92,9 @@ void main() {
8892
18,
8993
18,
9094
18,
95+
21,
9196
18,
97+
21,
9298
18,
9399
18,
94100
18,
@@ -110,10 +116,12 @@ void main() {
110116
1653,
111117
1774,
112118
1965,
113-
2034,
114-
2121,
115-
2228,
116-
2291,
119+
2007,
120+
2109,
121+
2153,
122+
2281,
123+
2388,
124+
2451,
117125
],
118126
locationTexts: [
119127
'regularString is String',
@@ -132,32 +140,36 @@ void main() {
132140
'nonNullableCats.whereType<Cat?>()',
133141
'nullableCats.whereType<Cat?>()',
134142
'cat is Cat?',
143+
'cat is! Cat?',
135144
'cat is Animal',
145+
'cat is! Animal',
136146
'dogs.whereType<Dog?>()',
137147
'dogs.whereType<Animal>()',
138148
'animals.whereType<Animal?>()',
139149
],
140150
messages: [
141-
'Avoid unnecessary "is" assertion.',
142-
'Avoid unnecessary "is" assertion.',
143-
'Avoid unnecessary "is" assertion.',
144-
'Avoid unnecessary "is" assertion.',
145-
'Avoid unnecessary "is" assertion.',
146-
'Avoid unnecessary "is" assertion.',
147-
'Avoid unnecessary "is" assertion.',
148-
'Avoid unnecessary "is" assertion.',
149-
'Avoid unnecessary "is" assertion.',
150-
'Avoid unnecessary "is" assertion.',
151-
'Avoid unnecessary "is" assertion.',
152-
'Avoid unnecessary "is" assertion.',
153-
'Avoid unnecessary "whereType" assertion.',
154-
'Avoid unnecessary "whereType" assertion.',
155-
'Avoid unnecessary "whereType" assertion.',
156-
'Avoid unnecessary "is" assertion.',
157-
'Avoid unnecessary "is" assertion.',
158-
'Avoid unnecessary "whereType" assertion.',
159-
'Avoid unnecessary "whereType" assertion.',
160-
'Avoid unnecessary "whereType" assertion.',
151+
'Avoid unnecessary "is" assertion. The result is always "true".',
152+
'Avoid unnecessary "is" assertion. The result is always "true".',
153+
'Avoid unnecessary "is" assertion. The result is always "true".',
154+
'Avoid unnecessary "is" assertion. The result is always "true".',
155+
'Avoid unnecessary "is" assertion. The result is always "true".',
156+
'Avoid unnecessary "is" assertion. The result is always "true".',
157+
'Avoid unnecessary "is" assertion. The result is always "true".',
158+
'Avoid unnecessary "is" assertion. The result is always "true".',
159+
'Avoid unnecessary "is" assertion. The result is always "true".',
160+
'Avoid unnecessary "is" assertion. The result is always "true".',
161+
'Avoid unnecessary "is" assertion. The result is always "true".',
162+
'Avoid unnecessary "is" assertion. The result is always "true".',
163+
'Avoid unnecessary "whereType<Cat>()" assertion.',
164+
'Avoid unnecessary "whereType<Cat?>()" assertion.',
165+
'Avoid unnecessary "whereType<Cat?>()" assertion.',
166+
'Avoid unnecessary "is" assertion. The result is always "true".',
167+
'Avoid unnecessary "is!" assertion. The result is always "false".',
168+
'Avoid unnecessary "is" assertion. The result is always "true".',
169+
'Avoid unnecessary "is!" assertion. The result is always "false".',
170+
'Avoid unnecessary "whereType<Dog?>()" assertion.',
171+
'Avoid unnecessary "whereType<Animal>()" assertion.',
172+
'Avoid unnecessary "whereType<Animal?>()" assertion.',
161173
],
162174
);
163175
});
@@ -184,15 +196,15 @@ void main() {
184196
'myList is List<Object>',
185197
],
186198
messages: [
187-
'Avoid unnecessary "whereType" assertion.',
188-
'Avoid unnecessary "whereType" assertion.',
189-
'Avoid unnecessary "whereType" assertion.',
190-
'Avoid unnecessary "whereType" assertion.',
191-
'Avoid unnecessary "whereType" assertion.',
192-
'Avoid unnecessary "is" assertion.',
193-
'Avoid unnecessary "is" assertion.',
194-
'Avoid unnecessary "is" assertion.',
195-
'Avoid unnecessary "is" assertion.',
199+
'Avoid unnecessary "whereType<String?>()" assertion.',
200+
'Avoid unnecessary "whereType<int>()" assertion.',
201+
'Avoid unnecessary "whereType<String?>()" assertion.',
202+
'Avoid unnecessary "whereType<String>()" assertion.',
203+
'Avoid unnecessary "whereType<String?>()" assertion.',
204+
'Avoid unnecessary "is" assertion. The result is always "true".',
205+
'Avoid unnecessary "is" assertion. The result is always "true".',
206+
'Avoid unnecessary "is" assertion. The result is always "true".',
207+
'Avoid unnecessary "is" assertion. The result is always "true".',
196208
],
197209
);
198210
});

‎test/src/analyzers/lint_analyzer/rules/rules_list/avoid_unnecessary_type_assertions/examples/example_with_is.dart‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,13 @@ void checkSameOrInheritor() {
7575
final animals = <Animal>[];
7676

7777
final check1 = cat is Cat?; // Lint
78+
final check1Not = cat is! Cat?; // Lint
7879
final check2 = cat is Dog;
80+
final check2Not = cat is! Dog;
7981
final check3 = cat is Animal; // Lint
82+
final check3Not = cat is! Animal; // Lint
8083
final check4 = homeAnimal is Dog?;
84+
final check4Not = homeAnimal is! Dog?;
8185

8286
final check5 = dogs.whereType<Dog?>().isEmpty; // Lint
8387
final check6 = dogs.whereType<Cat>().isEmpty;

0 commit comments

Comments
 (0)