Skip to content

Commit 21f365f

Browse files
stereotype441Commit Queue
authored andcommitted
[front end] Change Template class to extend Code.
This is part of a series of CLs that will standardize CFE error reporting to always use `codeFoo.withArguments(...)` when reporting errors that take arguments and `codeFoo` when reporting errors that don't take arguments, rather than `templateFoo.withArguments(...)` when reporting errors that take arguments and `messageFoo` when reporting errors that don't take arguments. This change will have two advantages: - It will lend greater consistency to the CFE codebase, by allowing the same `code...` objects to be used both to name error codes (e.g., in test expectations) and to report errors. This will allow everything associated with a certain error code to be found using a single invocation of "Find References" in the editor, rather than having to search separately for uses of the code and the message or template. - It should hopefully make the experience of writing code that reports errors more pleasant, since it will no longer be necessary to look up an error to see whether it takes arguments before using it; instead, the developer will be able to type the name of the message `code...` declaration, and then use autocompletion to see whether `.withArguments(...)` is required. In this CL, the `Template` class is changed so that it extends `Code`. In follow up CLs, this will allow the `Template` objects to serve the dual role of being either a template or an error code, in much the same way that for errors that don't take arguments, the `MessageCode` objects serve the dual role of being either an error code or an error message. Change-Id: I2e25419e47d2b0b601488b929ab5415d7039abea Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/443002 Reviewed-by: Johnni Winther <[email protected]> Commit-Queue: Paul Berry <[email protected]>
1 parent 446346a commit 21f365f

File tree

1 file changed

+6
-6
lines changed
  • pkg/_fe_analyzer_shared/lib/src/messages

1 file changed

+6
-6
lines changed

pkg/_fe_analyzer_shared/lib/src/messages/codes.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ class MessageCode extends Code implements Message {
104104
}
105105
}
106106

107-
class Template<T> {
108-
final String messageCode;
107+
class Template<T> extends Code {
108+
String get messageCode => name;
109109

110110
final String problemMessageTemplate;
111111

@@ -114,13 +114,13 @@ class Template<T> {
114114
final T withArguments;
115115

116116
const Template(
117-
this.messageCode, {
117+
super.name, {
118118
this.correctionMessageTemplate,
119119
required this.problemMessageTemplate,
120120
required this.withArguments,
121-
int index = -1,
122-
List<String>? analyzerCodes,
123-
CfeSeverity severity = CfeSeverity.error,
121+
super.index = -1,
122+
super.analyzerCodes,
123+
super.severity = CfeSeverity.error,
124124
});
125125

126126
@override

0 commit comments

Comments
 (0)