quick fix for flutter_style_todos

Handles:

* missing space before `TODO`
* missing colon
* lower case `todo`



Change-Id: Ib0e00e992d42c4d29fee87679c45dae10448653d
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/335024
Commit-Queue: Phil Quitslund <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>

Author: pq

pkg/analysis_server/lib/src/services/correction/dart/convert_to_flutter_style_todo.dart

@@ -0,0 +1,83 @@
+// Copyright (c) 2023, 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.
+
+import 'package:_fe_analyzer_shared/src/scanner/token.dart';
+import 'package:analysis_server/src/services/correction/dart/abstract_producer.dart';
+import 'package:analysis_server/src/services/correction/fix.dart';
+import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
+import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
+import 'package:analyzer_plugin/utilities/range_factory.dart';
+import 'package:linter/src/rules/flutter_style_todos.dart';
+
+class ConvertToFlutterStyleTodo extends ResolvedCorrectionProducer {
+  @override
+  bool get canBeAppliedInBulk => true;
+
+  @override
+  bool get canBeAppliedToFile => true;
+
+  @override
+  FixKind get fixKind => DartFixKind.CONVERT_TO_FLUTTER_STYLE_TODO;
+
+  @override
+  FixKind get multiFixKind => DartFixKind.CONVERT_TO_FLUTTER_STYLE_TODO_MULTI;
+
+  @override
+  Future<void> compute(ChangeBuilder builder) async {
+    var diagnosticOffset = diagnostic?.problemMessage.offset;
+    if (diagnosticOffset == null) return;
+
+    // Find the token that follows the reported diagnostic.
+    var token = node.beginToken;
+    do {
+      if (token.offset > diagnosticOffset) break;
+
+      token = token.next!;
+    } while (token != node.endToken);
+
+    // Identify the right comment.
+    Token? comment = token.precedingComments;
+    while (comment != null) {
+      if (comment.offset >= diagnosticOffset) break;
+      comment = comment.next;
+    }
+    if (comment == null) return;
+
+    var content = comment.lexeme;
+
+    // Try adding a missing leading space before `TODO`.
+    if (!content.startsWith('// ')) {
+      content = content.replaceFirst('//', '// ');
+    }
+
+    // Try removing an unwanted space after `TODO`.
+    if (content.length > 7 && content[7] == ' ') {
+      content = content.replaceRange(7, 8, '');
+    }
+
+    // Try adding a colon.
+    var index = content.indexOf(')') + 1;
+    if (content.length > index && !content.startsWith(':', index)) {
+      content = content.replaceFirst(')', '):');
+    }
+
+    // Try fixing the TODO case.
+    if (content.startsWith('// todo')) {
+      content = content.replaceRange(3, 7, 'TODO');
+    }
+
+    // TODO(pq): consider adding missing user info.
+    // Possibly inserting '(${Platform.environment['USER'] ?? Platform.environment['USERNAME']}')
+    // (assuming the environment variable is set).
+
+    // If the generated content doesn't match flutter style, don't apply it.
+    if (!content.startsWith(FlutterStyleTodos.todoExpectedRegExp)) return;
+
+    await builder.addDartFileEdit(file, (builder) {
+      builder.addReplacement(range.token(comment as Token), (builder) {
+        builder.write(content);
+      });
+    });
+  }
+}

pkg/analysis_server/lib/src/services/correction/error_fix_status.yaml

@@ -2083,10 +2083,7 @@ LintCode.file_names:
   notes: |-
     The fix is to rename the file, but that's a refactoring.
 LintCode.flutter_style_todos:
-  status: noFix
-  notes: |-
-    The fix would be to convert the existing TODO to the appropriate style, but
-    that can't reliably be done.
+  status: hasFix
 LintCode.hash_and_equals:
   status: hasFix
 LintCode.implementation_imports:

pkg/analysis_server/lib/src/services/correction/fix.dart

@@ -483,6 +483,16 @@ class DartFixKind {
     DartFixKindPriority.IN_FILE,
     'Convert to double quoted strings everywhere in file',
   );
+  static const CONVERT_TO_FLUTTER_STYLE_TODO = FixKind(
+    'dart.fix.convert.toFlutterStyleTodo',
+    DartFixKindPriority.DEFAULT,
+    'Convert to flutter style todo',
+  );
+  static const CONVERT_TO_FLUTTER_STYLE_TODO_MULTI = FixKind(
+    'dart.fix.convert.toFlutterStyleTodo.multi',
+    DartFixKindPriority.IN_FILE,
+    'Convert to flutter style todos everywhere in file',
+  );
   static const CONVERT_TO_FOR_ELEMENT = FixKind(
     'dart.fix.convert.toForElement',
     DartFixKindPriority.DEFAULT,

pkg/analysis_server/lib/src/services/correction/fix_internal.dart

@@ -63,6 +63,7 @@ import 'package:analysis_server/src/services/correction/dart/convert_to_cascade.
 import 'package:analysis_server/src/services/correction/dart/convert_to_constant_pattern.dart';
 import 'package:analysis_server/src/services/correction/dart/convert_to_contains.dart';
 import 'package:analysis_server/src/services/correction/dart/convert_to_expression_function_body.dart';
+import 'package:analysis_server/src/services/correction/dart/convert_to_flutter_style_todo.dart';
 import 'package:analysis_server/src/services/correction/dart/convert_to_function_declaration.dart';
 import 'package:analysis_server/src/services/correction/dart/convert_to_generic_function_syntax.dart';
 import 'package:analysis_server/src/services/correction/dart/convert_to_if_null.dart';
@@ -566,6 +567,9 @@ class FixProcessor extends BaseProcessor {
     LintNames.exhaustive_cases: [
       AddMissingEnumLikeCaseClauses.new,
     ],
+    LintNames.flutter_style_todos: [
+      ConvertToFlutterStyleTodo.new,
+    ],
     LintNames.hash_and_equals: [
       CreateMethod.equalsOrHashCode,
     ],

pkg/analysis_server/lib/src/services/linter/lint_names.dart

@@ -77,6 +77,7 @@ class LintNames {
   static const String empty_statements = 'empty_statements';
   static const String eol_at_end_of_file = 'eol_at_end_of_file';
   static const String exhaustive_cases = 'exhaustive_cases';
+  static const String flutter_style_todos = 'flutter_style_todos';
   static const String hash_and_equals = 'hash_and_equals';
   static const String implicit_call_tearoffs = 'implicit_call_tearoffs';
   static const String implicit_reopen = 'implicit_reopen';

pkg/analysis_server/test/src/services/correction/fix/convert_to_flutter_style_todo_test.dart

@@ -0,0 +1,119 @@
+// Copyright (c) 2023, 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.
+
+import 'package:analysis_server/src/services/correction/fix.dart';
+import 'package:analysis_server/src/services/linter/lint_names.dart';
+import 'package:analyzer/src/dart/error/todo_codes.dart';
+import 'package:analyzer_plugin/utilities/fixes/fixes.dart';
+import 'package:test_reflective_loader/test_reflective_loader.dart';
+
+import 'fix_processor.dart';
+
+void main() {
+  defineReflectiveSuite(() {
+    defineReflectiveTests(ConvertToFlutterStyleTodoBulkTest);
+    defineReflectiveTests(ConvertToFlutterStyleTodoTest);
+  });
+}
+
+@reflectiveTest
+class ConvertToFlutterStyleTodoBulkTest extends BulkFixProcessorTest {
+  @override
+  String get lintCode => LintNames.flutter_style_todos;
+
+  Future<void> test_singleFile() async {
+    await resolveTestCode('''
+// TODO(user) msg.
+void f() {
+  // todo(user) msg.
+}
+//TODO(user): msg.
+void g() { }
+''');
+    await assertHasFix('''
+// TODO(user): msg.
+void f() {
+  // TODO(user): msg.
+}
+// TODO(user): msg.
+void g() { }
+''');
+  }
+}
+
+@reflectiveTest
+class ConvertToFlutterStyleTodoTest extends FixProcessorLintTest {
+  @override
+  FixKind get kind => DartFixKind.CONVERT_TO_FLUTTER_STYLE_TODO;
+
+  @override
+  String get lintCode => LintNames.flutter_style_todos;
+
+  Future<void> test_lowerCase() async {
+    await resolveTestCode('''
+// todo(user): msg.
+void f() { }
+''');
+    await assertHasFix('''
+// TODO(user): msg.
+void f() { }
+''');
+  }
+
+  Future<void> test_missingColon() async {
+    await resolveTestCode('''
+// TODO(user) msg.
+void f() { }
+''');
+    await assertHasFix('''
+// TODO(user): msg.
+void f() { }
+''', errorFilter: (e) => e.errorCode != TodoCode.TODO);
+  }
+
+  Future<void> test_missingColon_surroundingComments() async {
+    await resolveTestCode('''
+// Leading comment.
+// TODO(user) msg.
+// Trailing comment.
+void f() { }
+''');
+    await assertHasFix('''
+// Leading comment.
+// TODO(user): msg.
+// Trailing comment.
+void f() { }
+''', errorFilter: (e) => e.errorCode != TodoCode.TODO);
+  }
+
+  Future<void> test_missingColonAndMessage() async {
+    await resolveTestCode('''
+// TODO(user)
+void f() {}
+''');
+    await assertNoFix(errorFilter: (e) => e.errorCode != TodoCode.TODO);
+  }
+
+  Future<void> test_missingLeadingSpace() async {
+    await resolveTestCode('''
+//TODO(user): msg.
+void f() {}
+''');
+    await assertHasFix('''
+// TODO(user): msg.
+void f() {}
+''', errorFilter: (e) => e.errorCode != TodoCode.TODO);
+  }
+
+  Future<void> test_unwantedSpaceBeforeUser() async {
+    await resolveTestCode('''
+// TODO (user): msg.
+void f() {}
+''');
+    await assertHasFix('''
+// TODO(user): msg.
+void f() {}
+''', errorFilter: (e) => e.errorCode != TodoCode.TODO);
+  }
+}

pkg/analysis_server/test/src/services/correction/fix/test_all.dart

@@ -73,6 +73,8 @@ import 'convert_to_constant_pattern_test.dart' as convert_to_constant_pattern;
 import 'convert_to_contains_test.dart' as convert_to_contains;
 import 'convert_to_double_quoted_string_test.dart'
     as convert_to_double_quoted_string;
+import 'convert_to_flutter_style_todo_test.dart'
+    as convert_to_flutter_style_todo;
 import 'convert_to_for_element_test.dart' as convert_to_for_element;
 import 'convert_to_function_declaration_test.dart'
     as convert_to_function_declaration;
@@ -340,6 +342,7 @@ void main() {
     convert_to_constant_pattern.main();
     convert_to_contains.main();
     convert_to_double_quoted_string.main();
+    convert_to_flutter_style_todo.main();
     convert_to_for_element.main();
     convert_to_function_declaration.main();
     convert_to_generic_function_syntax.main();

pkg/linter/lib/src/rules/flutter_style_todos.dart

@@ -31,6 +31,10 @@ class FlutterStyleTodos extends LintRule {
       'flutter_style_todos', "To-do comment doesn't follow the Flutter style.",
       correctionMessage: 'Try following the Flutter style for to-do comments.');
 
+  /// A regular expression that matches a correctly formatted TODO.
+  static final RegExp todoExpectedRegExp =
+      RegExp(r'// TODO\([a-zA-Z0-9][-a-zA-Z0-9]*\): ');
+
   FlutterStyleTodos()
       : super(
             name: 'flutter_style_todos',
@@ -52,9 +56,6 @@ class FlutterStyleTodos extends LintRule {
 class _Visitor extends SimpleAstVisitor<void> {
   static final _todoRegExp = RegExp(r'//+(.* )?TODO\b', caseSensitive: false);
 
-  static final _todoExpectedRegExp =
-      RegExp(r'// TODO\([a-zA-Z0-9][-a-zA-Z0-9]*\): ');
-
   final LintRule rule;
 
   _Visitor(this.rule);
@@ -80,7 +81,7 @@ class _Visitor extends SimpleAstVisitor<void> {
   void _checkComment(Token node) {
     var content = node.lexeme;
     if (content.startsWith(_todoRegExp) &&
-        !content.startsWith(_todoExpectedRegExp)) {
+        !content.startsWith(FlutterStyleTodos.todoExpectedRegExp)) {
       rule.reportLintForToken(node);
     }
   }