Add valid ignore-tags to parsed annotation comments

Author: hippotastic

packages/annotation-comments/src/core/parse.ts

@@ -48,7 +48,8 @@ export function parseAnnotationComments(options: ParseAnnotationCommentsOptions)
 			} else if (ignoreRange > 0) {
 				tagsIgnoredUntilLineIndex = tag.range.end.line + ignoreRange
 			}
-			return
+			// We still want to add this valid ignore-tags comment to the result array
+			// to allow it to be removed by `cleanCode()` later, so we don't return here
 		}
 
 		// If we arrive here, add the tag and comment to the list of annotation comments

packages/annotation-comments/test/parse.test.ts

@@ -248,13 +248,12 @@ countdown(5)
 				`// [!after] This should be parsed again`,
 			]
 			const comments = getComments(lines.join('\n'))
-			expect(comments).toHaveLength(2)
 			expect(comments).toMatchObject([
 				{
 					tag: { name: 'before', targetSearchQuery: undefined },
 					contents: [`This is before any ignores`],
 				},
-				// TODO: Expect the ignore-tags annotation comment to be present as well
+				{ tag: { name: 'ignore-tags' } },
 				{
 					tag: { name: 'after', targetSearchQuery: undefined },
 					contents: [`This should be parsed again`],
@@ -271,13 +270,12 @@ countdown(5)
 				`// [!after] This should be parsed again`,
 			]
 			const comments = getComments(lines.join('\n'))
-			expect(comments).toHaveLength(2)
 			expect(comments).toMatchObject([
 				{
 					tag: { name: 'before', targetSearchQuery: undefined },
 					contents: [`This is before any ignores`],
 				},
-				// TODO: Expect the ignore-tags annotation comment to be present as well
+				{ tag: { name: 'ignore-tags' } },
 				{
 					tag: { name: 'after', targetSearchQuery: undefined },
 					contents: [`This should be parsed again`],
@@ -293,13 +291,12 @@ countdown(5)
 				`// [!note] This should be parsed again`,
 			]
 			const comments = getComments(lines.join('\n'))
-			expect(comments).toHaveLength(2)
 			expect(comments).toMatchObject([
 				{
 					tag: { name: 'before', targetSearchQuery: undefined },
 					contents: [`This is before any ignores`],
 				},
-				// TODO: Expect the ignore-tags annotation comment to be present as well
+				{ tag: { name: 'ignore-tags' } },
 				{
 					tag: { name: 'note', targetSearchQuery: undefined },
 					contents: [`This should be parsed again`],
@@ -318,13 +315,12 @@ countdown(5)
 				`// [!note] This should be parsed again`,
 			]
 			const comments = getComments(lines.join('\n'))
-			expect(comments).toHaveLength(3)
 			expect(comments).toMatchObject([
 				{
 					tag: { name: 'before', targetSearchQuery: undefined },
 					contents: [`This is before any ignores`],
 				},
-				// TODO: Expect the ignore-tags annotation comment to be present as well
+				{ tag: { name: 'ignore-tags' } },
 				{
 					tag: { name: 'ins', targetSearchQuery: undefined },
 					contents: [],
@@ -347,15 +343,14 @@ countdown(5)
 				`testCode() // [!ins]`,
 			]
 			const comments = getComments(lines.join('\n'))
-			expect(comments).toHaveLength(3)
 			expect(comments).toMatchObject([
 				{
 					tag: { name: 'before', targetSearchQuery: undefined },
 					contents: [`This is before any ignores`],
 					commentRange: { start: { line: 0 }, end: { line: 5 } },
 					annotationRange: { start: { line: 1 }, end: { line: 1 } },
 				},
-				// TODO: Expect the ignore-tags annotation comment to be present as well
+				{ tag: { name: 'ignore-tags' } },
 				{
 					tag: { name: 'note', targetSearchQuery: undefined },
 					contents: [`This should be parsed again`],