[analyzer/linter] Prevent backsliding to the old messages.yaml format.

Error checking is added to:

- `class ErrorCodeInfo`, to ensure that old-style place holders
  (`{N}`) are no longer used.

- `class AnalyzerErrorCodeInfo`, to ensure that all error codes
  contain a `parameters` entry. (This check can't be in
  `ErrorCodeInfo`, because the CFE's `messages.yaml` doesn't contain
  `parameters` entries yet).

This will prevent adding new error messages that use the old format.

Change-Id: If37b912d4dfbfd74339c813673571092f4471bda
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/444364
Commit-Queue: Paul Berry <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>
Reviewed-by: Johnni Winther <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>

Author: stereotype441

pkg/analyzer/messages.yaml

@@ -45,9 +45,7 @@
 # strings take the form `#NAME`.
 #
 # If a diagnostic takes no parameters, it should have an entry of the
-# form `parameters: none`. (If there is no `parameters:` entry, then
-# the error hasn't been translated from the old placeholder format
-# yet).
+# form `parameters: none`.
 #
 # At the time the analyzer reports the error, it supplies
 # substitutions to take the place of the `#NAME` placeholders in the

pkg/analyzer/tool/messages/error_code_info.dart

@@ -146,6 +146,13 @@ final String linterPkgPath = normalize(join(pkg_root.packageRoot, 'linter'));
 final Map<String, Map<String, AnalyzerErrorCodeInfo>> lintMessages =
     _loadLintMessages();
 
+/// Pattern formerly used by the analyzer to identify placeholders in error
+/// message strings.
+///
+/// (This pattern is still used internally by the analyzer implementation, but
+/// it is no longer supported in `messages.yaml`.)
+final RegExp oldPlaceholderPattern = RegExp(r'\{\d+\}');
+
 /// Pattern for placeholders in error message strings.
 // TODO(paulberry): share this regexp (and the code for interpreting
 // it) between the CFE and analyzer.
@@ -357,7 +364,9 @@ class AnalyzerErrorCodeInfo extends ErrorCodeInfo {
     required super.problemMessage,
     super.removedIn,
     super.sharedName,
-  });
+  }) {
+    _check();
+  }
 
   factory AnalyzerErrorCodeInfo.fromYaml(Map<Object?, Object?> yaml) {
     if (yaml['aliasFor'] case var aliasFor?) {
@@ -367,7 +376,13 @@ class AnalyzerErrorCodeInfo extends ErrorCodeInfo {
     }
   }
 
-  AnalyzerErrorCodeInfo._fromYaml(super.yaml) : super.fromYaml();
+  AnalyzerErrorCodeInfo._fromYaml(super.yaml) : super.fromYaml() {
+    _check();
+  }
+
+  void _check() {
+    if (parameters == null) throw StateError('Missing `parameters` entry.');
+  }
 }
 
 /// Data tables mapping between CFE errors and their corresponding automatically
@@ -563,7 +578,21 @@ abstract class ErrorCodeInfo {
     this.previousName,
     this.removedIn,
     this.parameters,
-  });
+  }) {
+    for (var MapEntry(:key, :value)
+        in {
+          'problemMessage': problemMessage,
+          'correctionMessage': correctionMessage,
+        }.entries) {
+      if (value == null) continue;
+      if (value.contains(oldPlaceholderPattern)) {
+        throw StateError(
+          '$key is ${json.encode(value)}, which contains an old-style analyzer '
+          'placeholder pattern. Please convert to #NAME format.',
+        );
+      }
+    }
+  }
 
   /// Decodes an [ErrorCodeInfo] object from its YAML representation.
   ErrorCodeInfo.fromYaml(Map<Object?, Object?> yaml)

pkg/analyzer/tool/messages/generate.dart

@@ -339,9 +339,10 @@ class _SyntacticErrorGenerator {
     // Build a map of error message to ParserErrorCode
     var messageToName = <String, String>{};
     for (var entry in analyzerMessages['ParserErrorCode']!.entries) {
-      String message = entry.value.problemMessage
-          .replaceAll(RegExp(r'\{\d+\}'), '')
-          .replaceAll(placeholderPattern, '');
+      String message = entry.value.problemMessage.replaceAll(
+        placeholderPattern,
+        '',
+      );
       messageToName[message] = entry.key;
     }