Skip to content

Commit 612c9f6

Browse files
srawlinsCommit Queue
srawlins
authored and
Commit Queue
committed
analyzer: rename AnalysisRule 'errorCode' parameters
Work towards #50986 Change-Id: I3d5a55f6638b18e2941a574a71c89fc142f0c206 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/430060 Reviewed-by: Konstantin Shcheglov <[email protected]> Commit-Queue: Samuel Rawlins <[email protected]>
1 parent f637435 commit 612c9f6

22 files changed

+114
-98
lines changed

‎pkg/analyzer/lib/src/lint/linter.dart‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -115,14 +115,14 @@ sealed class AbstractAnalysisRule {
115115
PSNode node, {
116116
List<Object> arguments = const [],
117117
List<DiagnosticMessage> contextMessages = const [],
118-
required DiagnosticCode errorCode,
118+
required DiagnosticCode diagnosticCode,
119119
}) {
120120
// Cache diagnostic and location info for creating `AnalysisErrorInfo`s.
121121
var diagnostic = Diagnostic.tmp(
122122
source: node.source,
123123
offset: node.span.start.offset,
124124
length: node.span.length,
125-
errorCode: errorCode,
125+
errorCode: diagnosticCode,
126126
arguments: arguments,
127127
contextMessages: contextMessages,
128128
);
@@ -193,7 +193,7 @@ abstract class AnalysisRule extends AbstractAnalysisRule {
193193
List<DiagnosticMessage> contextMessages = const [],
194194
}) => _reportAtPubNode(
195195
node,
196-
errorCode: diagnosticCode,
196+
diagnosticCode: diagnosticCode,
197197
arguments: arguments,
198198
contextMessages: contextMessages,
199199
);
@@ -389,41 +389,41 @@ abstract class MultiAnalysisRule extends AbstractAnalysisRule {
389389
super.state,
390390
});
391391

392-
/// Reports [errorCode] at [node] with message [arguments] and
392+
/// Reports [diagnosticCode] at [node] with message [arguments] and
393393
/// [contextMessages].
394394
void reportAtNode(
395395
AstNode? node, {
396396
List<Object> arguments = const [],
397397
List<DiagnosticMessage>? contextMessages,
398-
required DiagnosticCode errorCode,
398+
required DiagnosticCode diagnosticCode,
399399
}) => _reportAtNode(
400400
node,
401-
diagnosticCode: errorCode,
401+
diagnosticCode: diagnosticCode,
402402
arguments: arguments,
403403
contextMessages: contextMessages,
404404
);
405405

406-
/// Reports [errorCode] at [offset], with [length], with message [arguments]
406+
/// Reports [diagnosticCode] at [offset], with [length], with message [arguments]
407407
/// and [contextMessages].
408408
void reportAtOffset(
409409
int offset,
410410
int length, {
411-
required DiagnosticCode errorCode,
411+
required DiagnosticCode diagnosticCode,
412412
List<Object> arguments = const [],
413413
List<DiagnosticMessage>? contextMessages,
414414
}) => _reportAtOffset(
415415
offset,
416416
length,
417-
diagnosticCode: errorCode,
417+
diagnosticCode: diagnosticCode,
418418
arguments: arguments,
419419
contextMessages: contextMessages,
420420
);
421421

422-
/// Reports [errorCode] at Pubspec [node], with message [arguments] and
422+
/// Reports [diagnosticCode] at Pubspec [node], with message [arguments] and
423423
/// [contextMessages].
424424
void reportAtPubNode(
425425
PSNode node, {
426-
required DiagnosticCode errorCode,
426+
required DiagnosticCode diagnosticCode,
427427
List<Object> arguments = const [],
428428
List<DiagnosticMessage> contextMessages = const [],
429429
}) {
@@ -432,23 +432,23 @@ abstract class MultiAnalysisRule extends AbstractAnalysisRule {
432432
source: node.source,
433433
offset: node.span.start.offset,
434434
length: node.span.length,
435-
errorCode: errorCode,
435+
errorCode: diagnosticCode,
436436
arguments: arguments,
437437
contextMessages: contextMessages,
438438
);
439439
_reporter.reportError(error);
440440
}
441441

442-
/// Reports [errorCode] at [token], with message [arguments] and
442+
/// Reports [diagnosticCode] at [token], with message [arguments] and
443443
/// [contextMessages].
444444
void reportAtToken(
445445
Token token, {
446-
required DiagnosticCode errorCode,
446+
required DiagnosticCode diagnosticCode,
447447
List<Object> arguments = const [],
448448
List<DiagnosticMessage>? contextMessages,
449449
}) => _reportAtToken(
450450
token,
451-
diagnosticCode: errorCode,
451+
diagnosticCode: diagnosticCode,
452452
arguments: arguments,
453453
contextMessages: contextMessages,
454454
);

‎pkg/analyzer/test/src/lint/lint_rule_test.dart‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ main() {
2828

2929
rule.reportAtToken(
3030
SimpleToken(TokenType.SEMICOLON, 0),
31-
errorCode: TestRule.customCode,
31+
diagnosticCode: TestRule.customCode,
3232
);
3333
expect(reporter.code, TestRule.customCode);
3434
});
@@ -42,7 +42,7 @@ main() {
4242

4343
rule.reportAtToken(
4444
SimpleToken(TokenType.SEMICOLON, 0),
45-
errorCode: TestRule.code,
45+
diagnosticCode: TestRule.code,
4646
);
4747
expect(reporter.code, TestRule.code);
4848
});
@@ -57,7 +57,7 @@ main() {
5757
var node = EmptyStatementImpl(
5858
semicolon: SimpleToken(TokenType.SEMICOLON, 0),
5959
);
60-
rule.reportAtNode(node, errorCode: TestRule.customCode);
60+
rule.reportAtNode(node, diagnosticCode: TestRule.customCode);
6161
expect(reporter.code, TestRule.customCode);
6262
});
6363
test('reportLint (default)', () {
@@ -71,7 +71,7 @@ main() {
7171
var node = EmptyStatementImpl(
7272
semicolon: SimpleToken(TokenType.SEMICOLON, 0),
7373
);
74-
rule.reportAtNode(node, errorCode: TestRule.code);
74+
rule.reportAtNode(node, diagnosticCode: TestRule.code);
7575
expect(reporter.code, TestRule.code);
7676
});
7777
});

‎pkg/linter/lib/src/rules/always_declare_return_types.dart‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ class _Visitor extends SimpleAstVisitor<void> {
4646
rule.reportAtToken(
4747
node.name,
4848
arguments: [node.name.lexeme],
49-
errorCode: LinterLintCode.always_declare_return_types_of_functions,
49+
diagnosticCode: LinterLintCode.always_declare_return_types_of_functions,
5050
);
5151
}
5252
}
@@ -57,7 +57,7 @@ class _Visitor extends SimpleAstVisitor<void> {
5757
rule.reportAtToken(
5858
node.name,
5959
arguments: [node.name.lexeme],
60-
errorCode: LinterLintCode.always_declare_return_types_of_functions,
60+
diagnosticCode: LinterLintCode.always_declare_return_types_of_functions,
6161
);
6262
}
6363
}
@@ -79,7 +79,7 @@ class _Visitor extends SimpleAstVisitor<void> {
7979
rule.reportAtToken(
8080
node.name,
8181
arguments: [node.name.lexeme],
82-
errorCode: LinterLintCode.always_declare_return_types_of_methods,
82+
diagnosticCode: LinterLintCode.always_declare_return_types_of_methods,
8383
);
8484
}
8585
}

‎pkg/linter/lib/src/rules/always_specify_types.dart‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ class _Visitor extends SimpleAstVisitor<void> {
5959
if (literal.typeArguments == null) {
6060
rule.reportAtToken(
6161
literal.beginToken,
62-
errorCode: LinterLintCode.always_specify_types_add_type,
62+
diagnosticCode: LinterLintCode.always_specify_types_add_type,
6363
);
6464
}
6565
}
@@ -73,13 +73,13 @@ class _Visitor extends SimpleAstVisitor<void> {
7373
if (keyword.keyword == Keyword.VAR) {
7474
rule.reportAtToken(
7575
keyword,
76-
errorCode: LinterLintCode.always_specify_types_replace_keyword,
76+
diagnosticCode: LinterLintCode.always_specify_types_replace_keyword,
7777
arguments: [keyword.lexeme, element!.type],
7878
);
7979
} else {
8080
rule.reportAtToken(
8181
keyword,
82-
errorCode: LinterLintCode.always_specify_types_specify_type,
82+
diagnosticCode: LinterLintCode.always_specify_types_specify_type,
8383
arguments: [element!.type],
8484
);
8585
}
@@ -97,13 +97,13 @@ class _Visitor extends SimpleAstVisitor<void> {
9797
rule.reportAtToken(
9898
tokenToLint,
9999
arguments: [keyword.lexeme, type],
100-
errorCode: LinterLintCode.always_specify_types_replace_keyword,
100+
diagnosticCode: LinterLintCode.always_specify_types_replace_keyword,
101101
);
102102
} else {
103103
rule.reportAtToken(
104104
tokenToLint,
105105
arguments: [type],
106-
errorCode: LinterLintCode.always_specify_types_specify_type,
106+
diagnosticCode: LinterLintCode.always_specify_types_specify_type,
107107
);
108108
}
109109
}
@@ -126,7 +126,7 @@ class _Visitor extends SimpleAstVisitor<void> {
126126
!element.metadata2.hasOptionalTypeArgs) {
127127
rule.reportAtNode(
128128
namedType,
129-
errorCode: LinterLintCode.always_specify_types_add_type,
129+
diagnosticCode: LinterLintCode.always_specify_types_add_type,
130130
);
131131
}
132132
}
@@ -150,25 +150,25 @@ class _Visitor extends SimpleAstVisitor<void> {
150150
rule.reportAtToken(
151151
keyword,
152152
arguments: [keyword.lexeme, type],
153-
errorCode: LinterLintCode.always_specify_types_replace_keyword,
153+
diagnosticCode: LinterLintCode.always_specify_types_replace_keyword,
154154
);
155155
} else {
156156
rule.reportAtToken(
157157
keyword,
158-
errorCode: LinterLintCode.always_specify_types_add_type,
158+
diagnosticCode: LinterLintCode.always_specify_types_add_type,
159159
);
160160
}
161161
} else if (type != null) {
162162
if (type is DynamicType) {
163163
rule.reportAtNode(
164164
param,
165-
errorCode: LinterLintCode.always_specify_types_add_type,
165+
diagnosticCode: LinterLintCode.always_specify_types_add_type,
166166
);
167167
} else {
168168
rule.reportAtNode(
169169
param,
170170
arguments: [type],
171-
errorCode: LinterLintCode.always_specify_types_specify_type,
171+
diagnosticCode: LinterLintCode.always_specify_types_specify_type,
172172
);
173173
}
174174
}
@@ -217,7 +217,11 @@ class _Visitor extends SimpleAstVisitor<void> {
217217
lintCode = LinterLintCode.always_specify_types_add_type;
218218
}
219219
}
220-
rule.reportAtToken(keyword, arguments: arguments, errorCode: lintCode);
220+
rule.reportAtToken(
221+
keyword,
222+
arguments: arguments,
223+
diagnosticCode: lintCode,
224+
);
221225
}
222226
}
223227

‎pkg/linter/lib/src/rules/analyzer_public_api.dart‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ class _Visitor extends SimpleAstVisitor<void> {
169169
if (badNames != null) {
170170
rule.reportAtNode(
171171
node,
172-
errorCode: AnalyzerPublicApi.exportsNonPublicName,
172+
diagnosticCode: AnalyzerPublicApi.exportsNonPublicName,
173173
arguments: [badNames.join(', ')],
174174
);
175175
}
@@ -184,7 +184,10 @@ class _Visitor extends SimpleAstVisitor<void> {
184184
return;
185185
}
186186
if (!partElement.includedFragment!.source.uri.isInAnalyzerPublicLib) {
187-
rule.reportAtNode(node, errorCode: AnalyzerPublicApi.badPartDirective);
187+
rule.reportAtNode(
188+
node,
189+
diagnosticCode: AnalyzerPublicApi.badPartDirective,
190+
);
188191
}
189192
}
190193

@@ -213,7 +216,7 @@ class _Visitor extends SimpleAstVisitor<void> {
213216
rule.reportAtOffset(
214217
fragment.nameOffset2!,
215218
name.length,
216-
errorCode: AnalyzerPublicApi.implInPublicApi,
219+
diagnosticCode: AnalyzerPublicApi.implInPublicApi,
217220
);
218221
}
219222
switch (fragment) {
@@ -299,7 +302,7 @@ class _Visitor extends SimpleAstVisitor<void> {
299302
rule.reportAtOffset(
300303
offset,
301304
length,
302-
errorCode: AnalyzerPublicApi.badType,
305+
diagnosticCode: AnalyzerPublicApi.badType,
303306
arguments: [problems.join(', ')],
304307
);
305308
}

‎pkg/linter/lib/src/rules/avoid_catching_errors.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ class _Visitor extends SimpleAstVisitor<void> {
4343
if (exceptionType.isSameAs('Error', 'dart.core')) {
4444
rule.reportAtNode(
4545
node,
46-
errorCode: LinterLintCode.avoid_catching_errors_class,
46+
diagnosticCode: LinterLintCode.avoid_catching_errors_class,
4747
);
4848
} else {
4949
rule.reportAtNode(
5050
node,
51-
errorCode: LinterLintCode.avoid_catching_errors_subclass,
51+
diagnosticCode: LinterLintCode.avoid_catching_errors_subclass,
5252
arguments: [exceptionType!.getDisplayString()],
5353
);
5454
}

‎pkg/linter/lib/src/rules/avoid_returning_null_for_void.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@ class _Visitor extends SimpleAstVisitor<void> {
7373
if (type == null) return;
7474

7575
if (!isAsync && type is VoidType) {
76-
rule.reportAtNode(node, errorCode: code);
76+
rule.reportAtNode(node, diagnosticCode: code);
7777
} else if (isAsync &&
7878
type.isDartAsyncFuture &&
7979
(type as InterfaceType).typeArguments.first is VoidType) {
80-
rule.reportAtNode(node, errorCode: code);
80+
rule.reportAtNode(node, diagnosticCode: code);
8181
}
8282
}
8383
}

‎pkg/linter/lib/src/rules/avoid_types_as_parameter_names.dart‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ class _Visitor extends SimpleAstVisitor<void> {
5050
rule.reportAtNode(
5151
parameter,
5252
arguments: [parameter.name.lexeme],
53-
errorCode:
53+
diagnosticCode:
5454
LinterLintCode.avoid_types_as_parameter_names_formal_parameter,
5555
);
5656
}
@@ -69,7 +69,7 @@ class _Visitor extends SimpleAstVisitor<void> {
6969
rule.reportAtToken(
7070
name,
7171
arguments: [name.lexeme],
72-
errorCode:
72+
diagnosticCode:
7373
LinterLintCode.avoid_types_as_parameter_names_formal_parameter,
7474
);
7575
}
@@ -110,7 +110,7 @@ class _Visitor extends SimpleAstVisitor<void> {
110110
rule.reportAtToken(
111111
name,
112112
arguments: [name.lexeme],
113-
errorCode:
113+
diagnosticCode:
114114
LinterLintCode.avoid_types_as_parameter_names_type_parameter,
115115
);
116116
}

‎pkg/linter/lib/src/rules/deprecated_consistency.dart‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class _Visitor extends SimpleAstVisitor<void> {
4848
rule.reportAtOffset(
4949
nodeToAnnotate.offset,
5050
nodeToAnnotate.length,
51-
errorCode: LinterLintCode.deprecated_consistency_constructor,
51+
diagnosticCode: LinterLintCode.deprecated_consistency_constructor,
5252
);
5353
}
5454
}
@@ -64,7 +64,7 @@ class _Visitor extends SimpleAstVisitor<void> {
6464
if (field.hasDeprecated && !declaredElement.hasDeprecated) {
6565
rule.reportAtNode(
6666
node,
67-
errorCode: LinterLintCode.deprecated_consistency_field,
67+
diagnosticCode: LinterLintCode.deprecated_consistency_field,
6868
);
6969
}
7070
if (!field.hasDeprecated && declaredElement.hasDeprecated) {
@@ -76,7 +76,7 @@ class _Visitor extends SimpleAstVisitor<void> {
7676
rule.reportAtOffset(
7777
nameOffset,
7878
nameLength,
79-
errorCode: LinterLintCode.deprecated_consistency_parameter,
79+
diagnosticCode: LinterLintCode.deprecated_consistency_parameter,
8080
);
8181
}
8282
}

‎pkg/linter/lib/src/rules/deprecated_member_use_from_same_package.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class _DeprecatedMemberUseVerifier extends BaseDeprecatedMemberUseVerifier {
7171
errorEntity.offset,
7272
errorEntity.length,
7373
arguments: [displayName],
74-
errorCode:
74+
diagnosticCode:
7575
LinterLintCode
7676
.deprecated_member_use_from_same_package_without_message,
7777
);
@@ -85,7 +85,7 @@ class _DeprecatedMemberUseVerifier extends BaseDeprecatedMemberUseVerifier {
8585
errorEntity.offset,
8686
errorEntity.length,
8787
arguments: [displayName, normalizedMessage],
88-
errorCode:
88+
diagnosticCode:
8989
LinterLintCode.deprecated_member_use_from_same_package_with_message,
9090
);
9191
}

0 commit comments

Comments
 (0)