Add ignore-tags logic, tests

Author: hippotastic

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

@@ -14,19 +14,44 @@ export function parseAnnotationComments(options: ParseAnnotationCommentsOptions)
 	// Find annotation tags in the code
 	const annotationTags = parseAnnotationTags({ codeLines })
 
+	const ignoreCountPerTagName = new Map<string, number>()
+	let tagsIgnoredUntilLineIndex = -1
+
 	let previousCommentRanges: SourceRange[] = []
 	annotationTags.forEach((tag) => {
 		// Ignore the current tag if it is located inside the content ranges
 		// of the previously processed annotation comment
 		if (previousCommentRanges.some((range) => secondRangeIsInFirst(range, tag.range))) return
 
-		// TODO: Handle `[!ignore-tags]` logic
-
 		// Attempt to find a comment that the current annotation tag is located in
 		const comment = parseParentComment({ codeLines, tag })
 		if (!comment) return
 
-		// If a comment was found, add the tag and comment to the list of annotation comments
+		// Handle ignored tags based on lines
+		if (tagsIgnoredUntilLineIndex >= tag.range.start.line) return
+		// Handle ignored tags based on tag names
+		const ignoreCount = ignoreCountPerTagName.get(tag.name) ?? 0
+		if (ignoreCount > 0) {
+			ignoreCountPerTagName.set(tag.name, ignoreCount - 1)
+			return
+		}
+		// Allow creating new ignores
+		if (tag.name === 'ignore-tags') {
+			// By definition, `ignore-tags` must be on its own line
+			if (comment.commentRange.start.column || comment.commentRange.end.column) return
+			const ignoreRange = tag.relativeTargetRange ?? 1
+			if (typeof tag.targetSearchQuery === 'string') {
+				const targetTagNames = tag.targetSearchQuery.split(',').map((name) => name.trim())
+				targetTagNames.forEach((name) => {
+					ignoreCountPerTagName.set(name, ignoreRange)
+				})
+			} else if (ignoreRange > 0) {
+				tagsIgnoredUntilLineIndex = tag.range.end.line + ignoreRange
+			}
+			return
+		}
+
+		// If we arrive here, add the tag and comment to the list of annotation comments
 		annotationComments.push(comment)
 		previousCommentRanges = comment.contentRanges
 	})

packages/annotation-comments/src/parsers/comment-types/single-line.ts

@@ -83,10 +83,16 @@ export function parseSingleLineParentComment(options: ParseParentCommentOptions)
 			comment.contents.push(tagLineContent.content)
 			comment.contentRanges.push(tagLineContent.contentRange)
 		}
-		// If there was only whitespace before the beginning of the comment,
-		// and no chaining was detected, try to expand the comment end location
+		// For supported annotation comments, allow expanding the comment end location
 		// and annotation content to subsequent comment lines
-		if (tagLine.slice(0, singleLineCommentSyntax.startColumn).trim() === '' && !chainedSingleLineCommentSyntax) {
+		const allowMultiLineExpansion =
+			// To allow expansion, the initial comment must start on its own line
+			tagLine.slice(0, singleLineCommentSyntax.startColumn).trim() === '' &&
+			// Chaining is not allowed
+			!chainedSingleLineCommentSyntax &&
+			// It doesn't make sense to expand annotation comments that don't support content
+			tag.name !== 'ignore-tags'
+		if (allowMultiLineExpansion) {
 			for (let lineIndex = tagLineIndex + 1; lineIndex < codeLines.length; lineIndex++) {
 				const line = codeLines[lineIndex]
 				const commentStart = line.search(/\S/)

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

@@ -232,7 +232,128 @@ countdown(5)
 		] as PartialAnnotationComment[])
 	})
 
-	// TODO: We also need to implement and test the `[!ignore-tags]` logic
+	describe('Supports ignoring unwanted annotations', () => {
+		test('[!ignore-tags] ignores all annotations on the next line', () => {
+			const lines = [
+				`// [!before] This is before any ignores`,
+				`console.log('Some code')`,
+				`// [!ignore-tags]`,
+				`testCode() // [!ignored] This should not be parsed`,
+				`// [!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`],
+				},
+				{
+					tag: { name: 'after', targetSearchQuery: undefined },
+					contents: [`This should be parsed again`],
+				},
+			] as PartialAnnotationComment[])
+		})
+		test('[!ignore-tags:2] ignores the next two lines', () => {
+			const lines = [
+				`// [!before] This is before any ignores`,
+				`console.log('Some code')`,
+				`// [!ignore-tags:2]`,
+				`testCode() // [!ignored] This should not be parsed`,
+				`// [!ignored] Still ignored`,
+				`// [!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`],
+				},
+				{
+					tag: { name: 'after', targetSearchQuery: undefined },
+					contents: [`This should be parsed again`],
+				},
+			] as PartialAnnotationComment[])
+		})
+		test('[!ignore-tags:note] ignores the next occurrence of "note"', () => {
+			const lines = [
+				`// [!before] This is before any ignores`,
+				`// [!ignore-tags:note]`,
+				`console.log('Some code')`,
+				`testCode() // [!note] This should not be parsed`,
+				`// [!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`],
+				},
+				{
+					tag: { name: 'note', targetSearchQuery: undefined },
+					contents: [`This should be parsed again`],
+				},
+			] as PartialAnnotationComment[])
+		})
+		test('[!ignore-tags:note,ins:3] ignores the next 3 occurrences of "note" and "ins"', () => {
+			const lines = [
+				`// [!before] This is before any ignores`,
+				`// [!ignore-tags:note,ins:3]`,
+				`console.log('Some code') // [!ins]`,
+				`testCode() // [!note] This should not be parsed`,
+				`// [!ins] // [!note] Still ignored`,
+				`// [!ins] // [!note] Still ignored`,
+				`console.log('Test') // [!ins]`,
+				`// [!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`],
+				},
+				{
+					tag: { name: 'ins', targetSearchQuery: undefined },
+					contents: [],
+				},
+				{
+					tag: { name: 'note', targetSearchQuery: undefined },
+					contents: [`This should be parsed again`],
+				},
+			] as PartialAnnotationComment[])
+		})
+		test('Ignores work in multi-line comments', () => {
+			const lines = [
+				`/*`,
+				`  [!before] This is before any ignores`,
+				`  [!ignore-tags]`,
+				`  [!note] This should not be parsed`,
+				`  [!note] This should be parsed again`,
+				`*/`,
+				`console.log('Some code')`,
+				`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`],
+				},
+				{
+					tag: { name: 'note', targetSearchQuery: undefined },
+					contents: [`This should be parsed again`],
+				},
+				{
+					tag: { name: 'ins', targetSearchQuery: undefined },
+					contents: [],
+				},
+			] as PartialAnnotationComment[])
+		})
+	})
 
 	function getComments(code: string) {
 		const codeLines = splitCodeLines(code)