[DAS] Fixes detecting TODO comments before eof

Fixes: #61568
Change-Id: I96929bdf1a6e38848ad4332828d4e80fd2c70ce0
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/464720
Reviewed-by: Brian Wilkerson <[email protected]>
Reviewed-by: Samuel Rawlins <[email protected]>
Reviewed-by: Paul Berry <[email protected]>
Auto-Submit: Felipe Morschel <[email protected]>

Author: FMorschel

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

@@ -42,7 +42,7 @@ class TodoFinder {
   ///
   /// @param token the head of the list of tokens being searched
   void _gatherTodoComments(Token? token, LineInfo lineInfo) {
-    while (token != null && !token.isEof) {
+    while (token != null && (!token.isEof || token.precedingComments != null)) {
       Token? commentToken = token.precedingComments;
       while (commentToken != null) {
         if (commentToken.type == TokenType.SINGLE_LINE_COMMENT ||
@@ -52,6 +52,9 @@ class TodoFinder {
           commentToken = commentToken.next;
         }
       }
+      if (token.next == token) {
+        break;
+      }
       token = token.next;
     }
   }

pkg/analyzer/test/src/diagnostics/todo_test.dart

@@ -15,6 +15,16 @@ main() {
 
 @reflectiveTest
 class TodoTest extends PubPackageResolutionTest {
+  test_eof() async {
+    await assertErrorsInCode(
+      r'''
+main() {}
+// TODO: Implement something else
+''',
+      [error(diag.todo, 13, 30, text: 'TODO: Implement something else')],
+    );
+  }
+
   test_fixme() async {
     await assertErrorsInCode(
       r'''

pkg/linter/test/rules/flutter_style_todos_test.dart

@@ -2,6 +2,7 @@
 // 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/src/diagnostic/diagnostic.dart' as diag;
 import 'package:test_reflective_loader/test_reflective_loader.dart';
 
 import '../rule_test_support.dart';
@@ -37,66 +38,94 @@ class FlutterStyleTodosTest extends LintRuleTest {
 ''',
       [
         lint(0, 17),
+        error(diag.todo, 3, 14),
         lint(18, 17),
         lint(36, 17),
         lint(54, 27),
+        error(diag.todo, 57, 24),
         lint(82, 18),
+        error(diag.todo, 85, 15),
         lint(101, 28),
         lint(130, 28),
         lint(159, 28),
+        error(diag.todo, 191, 53),
         lint(245, 64),
       ],
     );
   }
 
   test_badUsername_comma() async {
-    await assertDiagnostics(r'// TODO(user1,user2): bla', [lint(0, 25)]);
+    await assertDiagnostics(r'// TODO(user1,user2): bla', [
+      lint(0, 25),
+      error(diag.todo, 3, 22),
+    ]);
   }
 
   test_badUsername_extraSymbols() async {
-    await assertDiagnostics(r'// TODO(#12357): bla', [lint(0, 20)]);
+    await assertDiagnostics(r'// TODO(#12357): bla', [
+      lint(0, 20),
+      error(diag.todo, 3, 17),
+    ]);
   }
 
   test_charactersBeforeTODO() async {
-    await assertNoDiagnostics(r'''
+    await assertDiagnostics(
+      r'''
 // comment TODO(user): bla
 /// final todo = Todo(name: 'test todo', description: 'todo description');
 /// Something interesting. TODO(someone): this is an ugly test case.
-''');
+''',
+      [error(diag.todo, 11, 15), error(diag.todo, 129, 41)],
+    );
   }
 
   test_docComment() async {
-    await assertDiagnostics(r'/// TODO(user): bla', [lint(0, 19)]);
+    await assertDiagnostics(r'/// TODO(user): bla', [
+      lint(0, 19),
+      error(diag.todo, 4, 15),
+    ]);
   }
 
   test_extraColon() async {
-    await assertDiagnostics(r'// TODO:(user): bla', [lint(0, 19)]);
+    await assertDiagnostics(r'// TODO:(user): bla', [
+      lint(0, 19),
+      error(diag.todo, 3, 16),
+    ]);
   }
 
   test_goodPatterns() async {
-    await assertNoDiagnostics(r'''
+    await assertDiagnostics(
+      r'''
 // TODO(somebody): something
 // TODO(somebody): something, https://github.com/flutter/flutter
-''');
+''',
+      [error(diag.todo, 3, 25), error(diag.todo, 32, 61)],
+    );
   }
 
   test_goodPatterns_noLeadingSpace() async {
-    await assertNoDiagnostics(r'''
+    await assertDiagnostics(
+      r'''
 //TODO(somebody): something
 //TODO(somebody): something, https://github.com/flutter/flutter
-''');
+''',
+      [error(diag.todo, 2, 25), error(diag.todo, 30, 61)],
+    );
   }
 
   test_justTodo() async {
-    await assertDiagnostics(r'// TODO', [lint(0, 7)]);
+    await assertDiagnostics(r'// TODO', [lint(0, 7), error(diag.todo, 3, 4)]);
   }
 
   test_justTodo_noLeadingSpace() async {
-    await assertDiagnostics(r'//TODO', [lint(0, 6)]);
+    await assertDiagnostics(r'//TODO', [lint(0, 6), error(diag.todo, 2, 4)]);
   }
 
   test_missingColon() async {
-    await assertDiagnostics(r'// TODO(user) bla', [lint(0, 17)]);
+    await assertDiagnostics(r'// TODO(user) bla', [
+      lint(0, 17),
+      error(diag.todo, 3, 14),
+    ]);
   }
 
   test_missingMessage() async {
@@ -105,35 +134,52 @@ class FlutterStyleTodosTest extends LintRuleTest {
 //TODO(somebody):
 // TODO(somebody):
 ''',
-      [lint(0, 17), lint(18, 18)],
+      [
+        lint(0, 17),
+        error(diag.todo, 2, 15),
+        lint(18, 18),
+        error(diag.todo, 21, 15),
+      ],
     );
   }
 
   test_missingParens() async {
-    await assertDiagnostics(r'// TODO: bla', [lint(0, 12)]);
+    await assertDiagnostics(r'// TODO: bla', [
+      lint(0, 12),
+      error(diag.todo, 3, 9),
+    ]);
   }
 
   test_properFormat_dottedUsername() async {
-    await assertNoDiagnostics(r'// TODO(user.name): bla');
+    await assertDiagnostics(r'// TODO(user.name): bla', [
+      error(diag.todo, 3, 20),
+    ]);
   }
 
   test_properFormat_hyphenatedUsername() async {
-    await assertNoDiagnostics(r'// TODO(user-name): bla');
+    await assertDiagnostics(r'// TODO(user-name): bla', [
+      error(diag.todo, 3, 20),
+    ]);
   }
 
   test_properFormat_simpleUsername() async {
-    await assertNoDiagnostics(r'// TODO(username): bla');
+    await assertDiagnostics(r'// TODO(username): bla', [
+      error(diag.todo, 3, 19),
+    ]);
   }
 
   test_slashStar() async {
-    await assertNoDiagnostics(r'/* TODO bla */');
+    await assertDiagnostics(r'/* TODO bla */', [error(diag.todo, 3, 8)]);
   }
 
   test_slashStarStar() async {
-    await assertNoDiagnostics(r'/** TODO bla **/');
+    await assertDiagnostics(r'/** TODO bla **/', [error(diag.todo, 4, 10)]);
   }
 
   test_spaceBeforeColon() async {
-    await assertDiagnostics(r'// TODO(user) : bla', [lint(0, 19)]);
+    await assertDiagnostics(r'// TODO(user) : bla', [
+      lint(0, 19),
+      error(diag.todo, 3, 16),
+    ]);
   }
 }