[messages] Clean up generation of ignore comments.

stereotype441 · Commit Queue · commit 9d1c453a1368 · 2025-11-11T16:02:42.000-08:00
Refactors the diagnostic message generation logic, specifically the logic for generating `// ignore_for_file:` comments. This logic is now encapsulated in a single method, `AnalyzerDiagnosticPackage.writeIgnoresTo`. Also removes the logic for generating `// ignore_for_file: deprecated_member_use_from_same_package` and `ignore_for_file: constant_identifier_names`, which are no longer needed in any of these generated files. This paves the way for a follow-up CL that will introduce a new generated file, ensuring that we won't have to duplicate this logic when the new generated file is introduced. Change-Id: I6a6a6964d0164244aa29b2a08dcca4c920f72e7a Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/461143 Reviewed-by: Konstantin Shcheglov <scheglov@google.com> Commit-Queue: Paul Berry <paulberry@google.com> Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
diff --git a/pkg/analysis_server/lib/src/services/correction/fix/data_driven/transform_set_error_code.g.dart b/pkg/analysis_server/lib/src/services/correction/fix/data_driven/transform_set_error_code.g.dart
@@ -7,11 +7,10 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
-// codes here.
-// ignore_for_file: deprecated_member_use_from_same_package
+// Code generation is easier using double quotes (since we can use json.convert
+// to quote strings).
 // ignore_for_file: prefer_single_quotes
-//
+
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
diff --git a/pkg/analyzer/lib/src/analysis_options/error/option_codes.g.dart b/pkg/analyzer/lib/src/analysis_options/error/option_codes.g.dart
@@ -7,10 +7,6 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
-// codes here.
-// ignore_for_file: deprecated_member_use_from_same_package
-//
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
diff --git a/pkg/analyzer/lib/src/dart/error/ffi_code.g.dart b/pkg/analyzer/lib/src/dart/error/ffi_code.g.dart
@@ -7,10 +7,6 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
-// codes here.
-// ignore_for_file: deprecated_member_use_from_same_package
-//
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
diff --git a/pkg/analyzer/lib/src/dart/error/hint_codes.g.dart b/pkg/analyzer/lib/src/dart/error/hint_codes.g.dart
@@ -7,10 +7,6 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
-// codes here.
-// ignore_for_file: deprecated_member_use_from_same_package
-//
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
diff --git a/pkg/analyzer/lib/src/dart/error/syntactic_errors.g.dart b/pkg/analyzer/lib/src/dart/error/syntactic_errors.g.dart
@@ -7,10 +7,6 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
-// codes here.
-// ignore_for_file: deprecated_member_use_from_same_package
-//
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
diff --git a/pkg/analyzer/lib/src/dart/error/todo_codes.g.dart b/pkg/analyzer/lib/src/dart/error/todo_codes.g.dart
@@ -7,10 +7,6 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
-// codes here.
-// ignore_for_file: deprecated_member_use_from_same_package
-//
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
diff --git a/pkg/analyzer/lib/src/diagnostic/diagnostic_code_values.g.dart b/pkg/analyzer/lib/src/diagnostic/diagnostic_code_values.g.dart
@@ -7,13 +7,8 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// We allow some snake_case and SCREAMING_SNAKE_CASE identifiers in generated
-// code, as they match names declared in the source configuration files.
-// ignore_for_file: constant_identifier_names
-
-// While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
-// codes here.
-// ignore_for_file: deprecated_member_use_from_same_package
+// Generated comments don't quite align with flutter style.
+// ignore_for_file: flutter_style_todos
 
 part of 'diagnostic_code_values.dart';
 
diff --git a/pkg/analyzer/lib/src/error/codes.g.dart b/pkg/analyzer/lib/src/error/codes.g.dart
@@ -7,10 +7,6 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
-// codes here.
-// ignore_for_file: deprecated_member_use_from_same_package
-//
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
diff --git a/pkg/analyzer/lib/src/manifest/manifest_warning_code.g.dart b/pkg/analyzer/lib/src/manifest/manifest_warning_code.g.dart
@@ -7,10 +7,6 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
-// codes here.
-// ignore_for_file: deprecated_member_use_from_same_package
-//
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
diff --git a/pkg/analyzer/lib/src/pubspec/pubspec_warning_code.g.dart b/pkg/analyzer/lib/src/pubspec/pubspec_warning_code.g.dart
@@ -7,10 +7,6 @@
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
 
-// While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
-// codes here.
-// ignore_for_file: deprecated_member_use_from_same_package
-//
 // Generated comments don't quite align with flutter style.
 // ignore_for_file: flutter_style_todos
 
diff --git a/pkg/analyzer/tool/messages/generate.dart b/pkg/analyzer/tool/messages/generate.dart
@@ -75,23 +75,12 @@ class _AnalyzerDiagnosticGenerator {
 //
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
-
-// While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
-// codes here.
 ''');
 
   _AnalyzerDiagnosticGenerator(this.file, this.diagnosticClasses);
 
   void generate() {
-    out.writeln('// ignore_for_file: deprecated_member_use_from_same_package');
-    if (file.shouldIgnorePreferSingleQuotes) {
-      out.writeln('// ignore_for_file: prefer_single_quotes');
-    }
-    out.write('''
-// 
-// Generated comments don't quite align with flutter style.
-// ignore_for_file: flutter_style_todos
-''');
+    file.package.writeIgnoresTo(out);
     out.writeln();
     out.write('''
 part of ${json.encode(file.parentLibrary)};
@@ -112,6 +101,7 @@ part of ${json.encode(file.parentLibrary)};
 
       for (var message
           in diagnosticTables.activeMessagesByPackage[diagnosticClass
+              .file
               .package]!) {
         if (message.analyzerCode.diagnosticClass != diagnosticClass) continue;
 
@@ -154,17 +144,10 @@ class _DiagnosticCodeValuesGenerator {
 //
 // Instead modify 'pkg/analyzer/messages.yaml' and run
 // 'dart run pkg/analyzer/tool/messages/generate.dart' to update.
-
-// We allow some snake_case and SCREAMING_SNAKE_CASE identifiers in generated
-// code, as they match names declared in the source configuration files.
-// ignore_for_file: constant_identifier_names
-
-// While transitioning `HintCodes` to `WarningCodes`, we refer to deprecated
-// codes here.
-// ignore_for_file: deprecated_member_use_from_same_package
 ''');
 
   void generate() {
+    AnalyzerDiagnosticPackage.analyzer.writeIgnoresTo(out);
     out.writeln();
     out.writeln(r'''
 part of 'diagnostic_code_values.dart';
diff --git a/pkg/analyzer_utilities/lib/analyzer_messages.dart b/pkg/analyzer_utilities/lib/analyzer_messages.dart
@@ -107,7 +107,6 @@ or revisited.
     file: transformSetErrorCodeFile,
     name: 'TransformSetErrorCode',
     type: AnalyzerDiagnosticType.compileTimeError,
-    package: AnalyzerDiagnosticPackage.analysisServer,
     comment: '''
 An error code representing a problem in a file containing an encoding of a
 transform set.
@@ -130,6 +129,7 @@ const hintCodesFile = GeneratedDiagnosticFile(
 const lintCodesFile = GeneratedDiagnosticFile(
   path: generatedLintCodesPath,
   parentLibrary: 'package:linter/src/lint_codes.dart',
+  package: AnalyzerDiagnosticPackage.linter,
 );
 
 /// Base diagnostic classes used for lint messages.
@@ -145,7 +145,6 @@ const linterLintCodeInfo = DiagnosticClassInfo(
   file: lintCodesFile,
   name: 'LinterLintCode',
   type: AnalyzerDiagnosticType.lint,
-  package: AnalyzerDiagnosticPackage.linter,
 );
 
 const manifestWarningCodeFile = GeneratedDiagnosticFile(
@@ -181,7 +180,7 @@ const transformSetErrorCodeFile = GeneratedDiagnosticFile(
   parentLibrary:
       'package:analysis_server/src/services/correction/fix/data_driven/'
       'transform_set_error_code.dart',
-  shouldIgnorePreferSingleQuotes: true,
+  package: AnalyzerDiagnosticPackage.analysisServer,
 );
 
 /// Decoded messages from the analyzer's `messages.yaml` file.
@@ -366,7 +365,35 @@ class AliasMessage extends AnalyzerMessage {
 
 /// Enum representing the packages into which analyzer diagnostics can be
 /// generated.
-enum AnalyzerDiagnosticPackage { analyzer, analysisServer, linter }
+enum AnalyzerDiagnosticPackage {
+  analyzer,
+  analysisServer(shouldIgnorePreferSingleQuotes: true),
+  linter;
+
+  /// Whether code generated in this package needs an "ignore" comment to ignore
+  /// the `prefer_single_quotes` lint.
+  final bool shouldIgnorePreferSingleQuotes;
+
+  const AnalyzerDiagnosticPackage({
+    this.shouldIgnorePreferSingleQuotes = false,
+  });
+
+  void writeIgnoresTo(StringBuffer out) {
+    if (shouldIgnorePreferSingleQuotes) {
+      out.write('''
+
+// Code generation is easier using double quotes (since we can use json.convert
+// to quote strings).
+// ignore_for_file: prefer_single_quotes
+''');
+    }
+    out.write('''
+
+// Generated comments don't quite align with flutter style.
+// ignore_for_file: flutter_style_todos
+''');
+  }
+}
 
 /// Enum representing the possible values for the [DiagnosticType] class.
 ///
@@ -497,9 +524,6 @@ class DiagnosticClassInfo {
   /// deprecation notice) after migration to camel case diagnostic codes.
   final Set<String> deprecatedSnakeCaseNames;
 
-  /// The package into which the diagnostic codes will be generated.
-  final AnalyzerDiagnosticPackage package;
-
   /// Documentation comment to generate for the diagnostic class.
   ///
   /// If no documentation comment is needed, this should be the empty string.
@@ -510,7 +534,6 @@ class DiagnosticClassInfo {
     required this.name,
     required this.type,
     this.deprecatedSnakeCaseNames = const {},
-    this.package = AnalyzerDiagnosticPackage.analyzer,
     this.comment = '',
   });
 
diff --git a/pkg/analyzer_utilities/lib/messages.dart b/pkg/analyzer_utilities/lib/messages.dart
@@ -450,7 +450,7 @@ class DiagnosticTables {
             .add(message);
         var diagnosticClass = analyzerCode.diagnosticClass;
         if (!message.isRemoved && message is! AliasMessage) {
-          (activeMessagesByPackage[diagnosticClass.package] ??= []).add(
+          (activeMessagesByPackage[diagnosticClass.file.package] ??= []).add(
             message,
           );
         }
@@ -516,12 +516,13 @@ class GeneratedDiagnosticFile {
   /// The URI of the library that the generated file will be a part of.
   final String parentLibrary;
 
-  final bool shouldIgnorePreferSingleQuotes;
+  /// The package that the generated file will be part of.
+  final AnalyzerDiagnosticPackage package;
 
   const GeneratedDiagnosticFile({
     required this.path,
     required this.parentLibrary,
-    this.shouldIgnorePreferSingleQuotes = false,
+    this.package = AnalyzerDiagnosticPackage.analyzer,
   });
 }
 
