[messages] Remove inconsistency in linter's messages.yaml.

Changes the class heading in `pkg/linter/messages.yaml` from
`LintCode` to `LinterLintCode`. This fixes an inconsistency by
ensuring that in both analyzer-style `messages.yaml` files
(`pkg/linter/messages.yaml` and `pkg/analyzer/messages.yaml`), all
class headings match the name of the corresponding generated error
class.

Fixing this inconsistency allows the signature of
`MessageWithAnalyzerCode.toAnalyzerCode` to be simplified--it no
longer needs a `diagnosticClassInfo` parameter, since it can obtain
one from `analyzerCode.diagnosticClass`.

Note that there are no changes to generated code, so the behavior of
the analyzer and linter is unaffected.

Change-Id: I6a6a69644221d8d93b32a454bd5ff8519fbd6971
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/458960
Commit-Queue: Paul Berry <[email protected]>
Reviewed-by: Samuel Rawlins <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>

Author: stereotype441

pkg/analyzer/test/verify_diagnostics_test.dart

@@ -101,49 +101,49 @@ class DocumentationValidator {
     'HintCode.DEPRECATED_MEMBER_USE',
 
     // Need a way to specify the existance of files whose content is irrelevant.
-    'LintCode.always_use_package_imports',
+    'LinterLintCode.always_use_package_imports',
     // Missing support for example files outside of `lib`.
-    'LintCode.avoid_relative_lib_imports',
+    'LinterLintCode.avoid_relative_lib_imports',
     // The example isn't being recognized as a flutter app. We might need to
     // build a pubspec.yaml when analyzing flutter code.
-    'LintCode.avoid_web_libraries_in_flutter',
+    'LinterLintCode.avoid_web_libraries_in_flutter',
     // Produces a CompileTimeErrorCode.BODY_MIGHT_COMPLETE_NORMALLY.
-    'LintCode.control_flow_in_finally',
+    'LinterLintCode.control_flow_in_finally',
     // Missing support for creating an indirect dependency on a package.
-    'LintCode.depend_on_referenced_packages',
+    'LinterLintCode.depend_on_referenced_packages',
     // Missing support for specifying the name of the test file.
-    'LintCode.file_names',
+    'LinterLintCode.file_names',
     // Produces an unused import diagnostic.
-    'LintCode.implementation_imports',
+    'LinterLintCode.implementation_imports',
     // Doesn't produce a lint for the second example, even though the analyzer
     // does when the example is pasted into a file.
-    'LintCode.prefer_inlined_adds_single',
+    'LinterLintCode.prefer_inlined_adds_single',
     // No mock 'test' package, no good library annotations in 'meta'.
-    'LintCode.library_annotations',
+    'LinterLintCode.library_annotations',
     // Produces an unused import diagnostic.
-    'LintCode.library_prefixes',
+    'LinterLintCode.library_prefixes',
     // Produces an unused element diagnostic.
-    'LintCode.library_private_types_in_public_api',
+    'LinterLintCode.library_private_types_in_public_api',
     // Missing support for YAML files.
-    'LintCode.package_names',
+    'LinterLintCode.package_names',
     // The lint does nothing.
-    'LintCode.package_prefixed_library_names',
+    'LinterLintCode.package_prefixed_library_names',
     // Need a way to specify the existance of files whose content is irrelevant.
-    'LintCode.prefer_relative_imports',
+    'LinterLintCode.prefer_relative_imports',
     // The test file is in a basic workspace, so it can't have public API. I
     // think we'd need to add a `pubspec.yaml` file to the example.
-    'LintCode.public_member_api_docs',
+    'LinterLintCode.public_member_api_docs',
     // Missing support for YAML files.
-    'LintCode.secure_pubspec_urls',
+    'LinterLintCode.secure_pubspec_urls',
     // The test framework doesn't yet support lints in non-dart files.
-    'LintCode.sort_pub_dependencies',
+    'LinterLintCode.sort_pub_dependencies',
     // Doesn't produce a lint for the first example, even though the analyzer
     // does when the example is pasted into a file.
-    'LintCode.unnecessary_lambdas',
+    'LinterLintCode.unnecessary_lambdas',
     // Produces an unused_field warning.
-    'LintCode.use_setters_to_change_properties',
+    'LinterLintCode.use_setters_to_change_properties',
     // Extra warning.
-    'LintCode.recursive_getters',
+    'LinterLintCode.recursive_getters',
 
     // Has `language=2.9`
     'CompileTimeErrorCode.EXTENSION_DECLARES_INSTANCE_FIELD',
@@ -370,7 +370,7 @@ class DocumentationValidator {
         }
         for (int i = 0; i < exampleSnippets.length; i++) {
           _SnippetData snippet = exampleSnippets[i];
-          if (message.analyzerCode.diagnosticClass == lintCodeInfo) {
+          if (message.analyzerCode.diagnosticClass == linterLintCodeInfo) {
             snippet.lintCode = codeName;
           }
           await _validateSnippet('example', i, snippet);
@@ -385,7 +385,7 @@ class DocumentationValidator {
           if (firstExample != null) {
             snippet.auxiliaryFiles.addAll(firstExample.auxiliaryFiles);
           }
-          if (message.analyzerCode.diagnosticClass == lintCodeInfo) {
+          if (message.analyzerCode.diagnosticClass == linterLintCodeInfo) {
             snippet.lintCode = codeName;
           }
           await _validateSnippet('fixes', i, snippet);

pkg/analyzer/tool/messages/generate.dart

@@ -119,10 +119,7 @@ part of ${json.encode(file.parentLibrary)};
         if (message.analyzerCode.diagnosticClass != diagnosticClass) continue;
 
         LocatedError.wrap(span: message.keySpan, () {
-          message.toAnalyzerCode(
-            diagnosticClass,
-            memberAccumulator: memberAccumulator,
-          );
+          message.toAnalyzerCode(memberAccumulator: memberAccumulator);
         });
       }
 

pkg/analyzer_utilities/lib/analyzer_messages.dart

@@ -22,7 +22,6 @@ const codesFile = GeneratedDiagnosticFile(
 ///
 /// Note: to look up an error class by name, use [DiagnosticClassInfo.byName].
 const List<DiagnosticClassInfo> diagnosticClasses = [
-  lintCodeInfo,
   linterLintCodeInfo,
   GeneratedDiagnosticClassInfo(
     file: optionCodesFile,
@@ -115,8 +114,6 @@ const hintCodesFile = GeneratedDiagnosticFile(
   parentLibrary: 'package:analyzer/src/dart/error/hint_codes.dart',
 );
 
-const lintCodeInfo = DiagnosticClassInfo(name: 'LintCode');
-
 const lintCodesFile = GeneratedDiagnosticFile(
   path: generatedLintCodesPath,
   parentLibrary: 'package:linter/src/lint_codes.dart',
@@ -333,8 +330,7 @@ class AliasMessage extends AnalyzerMessage {
   String get aliasForClass => aliasFor.split('.').first;
 
   @override
-  void toAnalyzerCode(
-    DiagnosticClassInfo diagnosticClassInfo, {
+  void toAnalyzerCode({
     String? sharedNameReference,
     required MemberAccumulator memberAccumulator,
   }) {
@@ -398,6 +394,9 @@ class AnalyzerMessage extends Message with MessageWithAnalyzerCode {
 /// Interface class for diagnostic messages that have an analyzer code, and thus
 /// can be reported by the analyzer.
 mixin MessageWithAnalyzerCode on Message {
+  late final GeneratedDiagnosticClassInfo diagnosticClassInfo =
+      analyzerCode.diagnosticClass as GeneratedDiagnosticClassInfo;
+
   /// The code used by the analyzer to refer to this diagnostic message.
   AnalyzerCode get analyzerCode;
 
@@ -422,8 +421,7 @@ mixin MessageWithAnalyzerCode on Message {
   /// in the diagnostic class [className].
   ///
   /// [diagnosticCode] is the name of the diagnostic to be generated.
-  void toAnalyzerCode(
-    GeneratedDiagnosticClassInfo diagnosticClassInfo, {
+  void toAnalyzerCode({
     String? sharedNameReference,
     required MemberAccumulator memberAccumulator,
   }) {

pkg/linter/messages.yaml

@@ -27,7 +27,7 @@
 # * unusedCode - rules that protect against unused code.
 # * web - rules that help to write code deployed to the web.
 
-LintCode:
+LinterLintCode:
   always_declare_return_types_of_functions:
     parameters:
       Object p0: undocumented

pkg/linter/tool/generate_lints.dart

@@ -52,7 +52,6 @@ class LinterLintCode extends LintCodeWithExpectedTypes {
         var lintName = message.sharedName ?? analyzerCode.snakeCaseName;
         if (messagesRuleInfo[lintName]!.removed) continue;
         message.toAnalyzerCode(
-          linterLintCodeInfo,
           sharedNameReference: 'LintNames.$lintName',
           memberAccumulator: memberAccumulator,
         );

pkg/linter/tool/messages_info.dart

@@ -44,10 +44,10 @@ final Map<String, RuleInfo> messagesRuleInfo = () {
   if (messagesYaml is! YamlMap) {
     throw StateError("The '$_messagesFileName' file is not a YAML map.");
   }
-  var lintCodes = messagesYaml['LintCode'] as YamlMap?;
+  var lintCodes = messagesYaml['LinterLintCode'] as YamlMap?;
   if (lintCodes == null) {
     throw StateError(
-      "The '$_messagesFileName' file does not have a 'LintCode' section.",
+      "The '$_messagesFileName' file does not have a 'LinterLintCode' section.",
     );
   }