From e98b79529a06309dc912c41e6ab3c7897eefed44 Mon Sep 17 00:00:00 2001
From: Ian Lewis <ianmlewis@gmail.com>
Date: Thu, 18 Jul 2024 03:28:39 +0000
Subject: [PATCH] fix: TODO comments after multi-line comments.

Fixes an issue where the `TODOScanner.Scan` would return `false` if it
encounters a multi-line comment with no TODOs present in it.

Fixes #1520

Signed-off-by: Ian Lewis <ianmlewis@gmail.com>
---
 CHANGELOG.md                 |  8 ++++++++
 internal/todos/todos.go      | 16 +++++++++-------
 internal/todos/todos_test.go | 31 +++++++++++++++++++++++++++++++
 3 files changed, 48 insertions(+), 7 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 405ef358..99d13d2a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+### Fixed
+
+- Fixed a bug where TODOs were not being reported if they were located after a
+  multi-line comment with no TODOs in the same file
+  ([#1520](https://github.com/ianlewis/todos/issues/1520))
+
 ## [0.9.0-rc.2] - 2024-07-17
 
 ### Added in 0.9.0-rc.2
diff --git a/internal/todos/todos.go b/internal/todos/todos.go
index d9b1ddb1..0e438ec9 100644
--- a/internal/todos/todos.go
+++ b/internal/todos/todos.go
@@ -158,13 +158,15 @@ func (t *TODOScanner) Scan() bool {
 		if next.Multiline {
 			matches := t.findMultilineMatches(next)
 			t.next = append(t.next, matches...)
-			return len(t.next) > 0
-		}
-
-		match := t.findLineMatch(next)
-		if match != nil {
-			t.next = append(t.next, match)
-			return true
+			if len(t.next) > 0 {
+				return true
+			}
+		} else {
+			match := t.findLineMatch(next)
+			if match != nil {
+				t.next = append(t.next, match)
+				return true
+			}
 		}
 	}
 	return false
diff --git a/internal/todos/todos_test.go b/internal/todos/todos_test.go
index 99802c58..8be2f542 100644
--- a/internal/todos/todos_test.go
+++ b/internal/todos/todos_test.go
@@ -859,6 +859,37 @@ func TestTODOScanner(t *testing.T) {
 				},
 			},
 		},
+		// Regression test for issue #1520
+		// Ensure that the TODOScanner continues scanning after finding a
+		// multi-line comment with no TODOs in it.
+		"regression_1520.go": {
+			s: &testScanner{
+				comments: []*scanner.Comment{
+					{
+						Text:      "/**\n no match here\n */",
+						Line:      1,
+						Multiline: true,
+					},
+					{
+						Text: "// TODO: match",
+						Line: 5,
+					},
+				},
+			},
+			config: &Config{
+				Types: []string{"TODO"},
+			},
+			expected: []*TODO{
+				{
+					Type:        "TODO",
+					Text:        "// TODO: match",
+					Label:       "",
+					Message:     "match",
+					Line:        5,
+					CommentLine: 5,
+				},
+			},
+		},
 	}
 
 	for name, tc := range testCases {