[analyzer] Code generate TodoCode constants.

Moving these diagnostic constants to code generation will make it
easier to make further improvements to the analyzer diagnostic
representation, because I'll be able to make a single adjustment to
the code generator and then re-generate all the diagnostics.

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

Author: stereotype441

pkg/analyzer/lib/src/dart/error/todo_codes.dart

@@ -2,11 +2,11 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:analyzer/error/error.dart';
+// ignore: deprecated_member_use_from_same_package
+import 'package:analyzer/src/dart/error/todo_codes.g.dart';
 
-// It is hard to visually separate each code's _doc comment_ from its published
-// _documentation comment_ when each is written as an end-of-line comment.
-// ignore_for_file: slash_for_doc_comments
+// ignore: deprecated_member_use_from_same_package
+export 'package:analyzer/src/dart/error/todo_codes.g.dart' show TodoCode;
 
 /// Static helper methods and properties for working with [TodoCode]s.
 class Todo {
@@ -53,41 +53,3 @@ class Todo {
   /// Returns the TodoCode for [kind], falling back to [TodoCode.todo].
   static TodoCode forKind(String kind) => _codes[kind] ?? TodoCode.todo;
 }
-
-/**
- * The error code indicating a marker in code for work that needs to be finished
- * or revisited.
- */
-class TodoCode extends DiagnosticCode {
-  /**
-   * A standard TODO comment marked as TODO.
-   */
-  static const TodoCode todo = TodoCode('TODO');
-
-  /**
-   * A TODO comment marked as FIXME.
-   */
-  static const TodoCode fixme = TodoCode('FIXME');
-
-  /**
-   * A TODO comment marked as HACK.
-   */
-  static const TodoCode hack = TodoCode('HACK');
-
-  /**
-   * A TODO comment marked as UNDONE.
-   */
-  static const TodoCode undone = TodoCode('UNDONE');
-
-  /**
-   * Initialize a newly created error code to have the given [name].
-   */
-  const TodoCode(String name)
-    : super(problemMessage: "{0}", name: name, uniqueName: 'TodoCode.$name');
-
-  @override
-  DiagnosticSeverity get severity => DiagnosticSeverity.INFO;
-
-  @override
-  DiagnosticType get type => DiagnosticType.TODO;
-}

pkg/analyzer/lib/src/dart/error/todo_codes.g.dart

@@ -0,0 +1,75 @@
+// Copyright (c) 2021, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+// THIS FILE IS GENERATED. DO NOT EDIT.
+//
+// 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
+
+/// @docImport 'package:analyzer/src/dart/error/syntactic_errors.g.dart';
+/// @docImport 'package:analyzer/src/error/inference_error.dart';
+@Deprecated(
+  // This library is deprecated to prevent it from being accidentally imported
+  // It should only be imported by the corresponding non-code-generated library
+  // (which suppresses the deprecation warning using an "ignore" comment).
+  'Use package:analyzer/src/dart/error/todo_codes.dart instead',
+)
+library;
+
+import "package:_fe_analyzer_shared/src/base/errors.dart";
+
+/// The error code indicating a marker in code for work that needs to be finished
+/// or revisited.
+class TodoCode extends DiagnosticCode {
+  /// A TODO comment marked as FIXME.
+  ///
+  /// Parameters:
+  /// String message: the user-supplied problem message
+  static const TodoCode fixme = TodoCode('FIXME', "{0}");
+
+  /// A TODO comment marked as HACK.
+  ///
+  /// Parameters:
+  /// String message: the user-supplied problem message
+  static const TodoCode hack = TodoCode('HACK', "{0}");
+
+  /// A standard TODO comment marked as TODO.
+  ///
+  /// Parameters:
+  /// String message: the user-supplied problem message
+  static const TodoCode todo = TodoCode('TODO', "{0}");
+
+  /// A TODO comment marked as UNDONE.
+  ///
+  /// Parameters:
+  /// String message: the user-supplied problem message
+  static const TodoCode undone = TodoCode('UNDONE', "{0}");
+
+  /// Initialize a newly created error code to have the given [name].
+  const TodoCode(
+    String name,
+    String problemMessage, {
+    super.correctionMessage,
+    super.hasPublishedDocs = false,
+    super.isUnresolvedIdentifier = false,
+    String? uniqueName,
+  }) : super(
+         name: name,
+         problemMessage: problemMessage,
+         uniqueName: 'TodoCode.${uniqueName ?? name}',
+       );
+
+  @override
+  DiagnosticSeverity get severity => DiagnosticSeverity.INFO;
+
+  @override
+  DiagnosticType get type => DiagnosticType.TODO;
+}

pkg/analyzer/messages.yaml

@@ -23220,6 +23220,35 @@ StaticWarningCode:
         if (x case var a when a > 0) {}
       }
       ```
+TodoCode:
+  FIXME:
+    parameters:
+      String message: the user-supplied problem message
+    problemMessage: "#message"
+    hasPublishedDocs: false
+    comment: |-
+      A TODO comment marked as FIXME.
+  HACK:
+    parameters:
+      String message: the user-supplied problem message
+    problemMessage: "#message"
+    hasPublishedDocs: false
+    comment: |-
+      A TODO comment marked as HACK.
+  TODO:
+    parameters:
+      String message: the user-supplied problem message
+    problemMessage: "#message"
+    hasPublishedDocs: false
+    comment: |-
+      A standard TODO comment marked as TODO.
+  UNDONE:
+    parameters:
+      String message: the user-supplied problem message
+    problemMessage: "#message"
+    hasPublishedDocs: false
+    comment: |-
+      A TODO comment marked as UNDONE.
 TransformSetErrorCode:
   conflicting_key:
     parameters:

pkg/analyzer/tool/messages/error_code_info.dart

@@ -87,6 +87,16 @@ const List<ErrorClassInfo> errorClasses = [
     type: 'STATIC_WARNING',
     severity: 'WARNING',
   ),
+  ErrorClassInfo(
+    file: todoCodesFile,
+    name: 'TodoCode',
+    type: 'TODO',
+    severity: 'INFO',
+    comment: '''
+The error code indicating a marker in code for work that needs to be finished
+or revisited.
+''',
+  ),
   ErrorClassInfo(
     file: transformSetErrorCodeFile,
     name: 'TransformSetErrorCode',
@@ -138,6 +148,11 @@ const syntacticErrorsFile = GeneratedErrorCodeFile(
   preferredImportUri: 'package:analyzer/src/dart/error/syntactic_errors.dart',
 );
 
+const todoCodesFile = GeneratedErrorCodeFile(
+  path: 'analyzer/lib/src/dart/error/todo_codes.g.dart',
+  preferredImportUri: 'package:analyzer/src/dart/error/todo_codes.dart',
+);
+
 const transformSetErrorCodeFile = GeneratedErrorCodeFile(
   path:
       'analysis_server/lib/src/services/correction/fix/data_driven/'

pkg/analyzer/tool/messages/generate.dart

@@ -259,14 +259,6 @@ class _DiagnosticCodeValuesGenerator {
   _DiagnosticCodeValuesGenerator(this.generatedCodes);
 
   void generate() {
-    // The scanner error codes are not yet being generated, so we need to add
-    // them to the list explicitly.
-    generatedCodes.addAll([
-      ('TodoCode', 'TODO'),
-      ('TodoCode', 'FIXME'),
-      ('TodoCode', 'HACK'),
-      ('TodoCode', 'UNDONE'),
-    ]);
     generatedCodes.sortBy((x) => '${x.$1}.${x.$2}');
 
     out.writeln();