Validate "no content before tag" rule

Author: hippotastic

packages/annotation-comments/README.md

@@ -388,7 +388,7 @@ The function follows these steps to process the code:
 
 - The function goes through the given code line by line, looking for strings that match the annotation comment syntax. If a match is found, it will:
   - Extract the annotation name, optional target search query, and optional relative target range from the annotation tag
-  - Ensure that the current annotation tag has not been ignored by an ´ignore-tags` directive. If it has, it will skip the tag and continue searching
+  - Ensure that the current annotation tag has not been ignored by an `ignore-tags` directive. If it has, it will skip the tag and continue searching
   - If given, call the `validateAnnotationName` handler function to check if the annotation name is valid. If this function returns `false`, skip the tag and continue searching
   - **Handle the current annotation tag if it's inside a single-line comment:** Try to find the beginning sequence of a single-line comment directly before the annotation tag, with no non-whitespace character before and after the beginning sequence. If found, it will:
     - Mark the location of the beginning sequence as beginning of the comment

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

@@ -176,18 +176,37 @@ function findCommentSyntaxMatches(options: {
 	// Validate all syntax requirements for the given line
 	commentSyntaxMatches.forEach((match, index) => {
 		const syntax = multiLineCommentSyntaxes[index]
+		// If the current syntax has a continuation line start requirement,
+		// validate it on non-opening and non-closing lines
 		if (
-			// Check matches that are still valid and that have a continuation line requirement
 			!match.invalid &&
 			syntax.continuationLineStart &&
 			// Only check the requirement on non-opening and non-closing lines
 			lineIndex !== match.openingRange?.start.line &&
 			lineIndex !== match.closingRange?.start.line &&
-			// If the line doesn't match the continuation syntax, mark the match as invalid
+			// If the line doesn't match the continuation syntax, mark the syntax match as invalid
 			!line.match(syntax.continuationLineStart)
 		) {
 			match.invalid = true
 		}
+		// If we're looking for an opening sequence and we're on the tag line,
+		// validate that there is no content (except whitespace) before the tag
+		if (
+			!match.invalid &&
+			type === 'opening' &&
+			// Only check the tag line (which is the one with `endColumn` defined)
+			endColumn !== undefined
+		) {
+			// Get content between the opening sequence (if found on this line) and the tag
+			const openingEndColumn = match.openingRangeWithWhitespace?.end.line === lineIndex ? match.openingRangeWithWhitespace?.end.column : undefined
+			let contentBeforeTag = line.slice(openingEndColumn, endColumn)
+			// Strip the continuation line start syntax if it's present
+			if (!openingEndColumn && syntax.continuationLineStart) {
+				contentBeforeTag = contentBeforeTag.replace(syntax.continuationLineStart, '')
+			}
+			// If there is non-whitespace content before the tag, mark the syntax match as invalid
+			if (contentBeforeTag.trim()) match.invalid = true
+		}
 	})
 
 	return foundNewMatches

packages/annotation-comments/test/parent-comment.test.ts

@@ -20,7 +20,26 @@ describe('parseParentComment()', () => {
 				expect(getParentComment(`someCode() //[!note] Invalid syntax`)).toEqual(undefined)
 			})
 			test('Content between comment opening and annotation tag', () => {
-				expect(getParentComment(`someCode() // Hi [!note] This won't work`)).toEqual(undefined)
+				expect(getParentComment(`someCode() // Hi [!note] This will not work`)).toEqual(undefined)
+			})
+		})
+		describe('Multi-line comment syntax', () => {
+			test('Content between the opening syntax and the annotation tag', () => {
+				expect(getParentComment(`/* Hi [!note] This will not work */`)).toEqual(undefined)
+				expect(getParentComment(`someCode() /* Hi [!note] This will not work */`)).toEqual(undefined)
+			})
+			test('Content between the beginning of the line and the annotation tag', () => {
+				expect(
+					getParentComment(
+						[
+							'someCode()',
+							'/*',
+							// Content before the annotation tag
+							'Hi [!note] This will not work',
+							'*/',
+						].join('\n')
+					)
+				).toEqual(undefined)
 			})
 		})
 	})

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

@@ -8,4 +8,5 @@ describe('parseAnnotationComments()', () => {
 	test('Todo', () => {
 		expect(true).toBe(true)
 	})
+	// TODO: We also need to implement and test the `[!ignore-tags]` logic
 })