Add comment syntax to API, test removeAnnotationContents

Author: hippotastic

packages/annotation-comments/README.md

@@ -75,6 +75,11 @@ type AnnotationComment = {
   contents: string[]
   commentRange: SourceRange
   commentInnerRange: SourceRange
+  commentSyntax: {
+    opening: string
+    closing?: string | undefined
+    continuationLineStart?: RegExp | undefined
+  }
   annotationRange: SourceRange
   contentRanges: SourceRange[]
   targetRanges: SourceRange[]

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

@@ -1,5 +1,5 @@
-import { cloneRange, createSingleLineRange, excludeRangesFromOuterRange, mergeIntersectingOrAdjacentRanges, rangesAreEqual, splitRangeByLines } from '../internal/ranges'
-import { excludeWhitespaceRanges } from '../internal/text-content'
+import { cloneRange, excludeRangesFromOuterRange, mergeIntersectingOrAdjacentRanges, rangesAreEqual, splitRangeByLines } from '../internal/ranges'
+import { excludeWhitespaceRanges, getTextContentInLine } from '../internal/text-content'
 import type { AnnotatedCode, AnnotationComment, SourceLocation, SourceRange } from './types'
 
 export type CleanCodeOptions = AnnotatedCode & {
@@ -49,12 +49,30 @@ export function cleanCode(options: CleanCodeOptions) {
 		// If we're removing an entire annotation, include up to one line of whitespace above it
 		const lineAboveIndex = rangeToBeRemoved.start.line - 1
 		if (removeEntireAnnotation && annotationComment.commentInnerRange.start.line < lineAboveIndex) {
-			const contentInLineAbove = excludeWhitespaceRanges(codeLines, [createSingleLineRange(lineAboveIndex)])
-			if (!contentInLineAbove.length) {
+			const { content } = getTextContentInLine({
+				codeLines,
+				lineIndex: lineAboveIndex,
+				continuationLineStart: annotationComment.commentSyntax.continuationLineStart,
+			})
+			if (!content) {
 				rangeToBeRemoved.start = { line: lineAboveIndex }
 			}
 		}
 
+		// If we're only removing the tag, also remove whitespace between the tag and content
+		if (!removeEntireAnnotation && hasContents) {
+			const firstContentStart = annotationComment.contentRanges[0].start
+			if (!annotationComment.commentSyntax.closing && firstContentStart.line > rangeToBeRemoved.start.line) {
+				// If the comment uses a single-line syntax and the first content starts on a line
+				// below the tag, remove the entire tag line including the comment syntax
+				rangeToBeRemoved.start = { line: rangeToBeRemoved.start.line }
+			} else {
+				// Otherwise (multi-line syntax or content starting at the tag line),
+				// just extend the range to the start of the first content
+				rangeToBeRemoved.end = { line: firstContentStart.line, column: firstContentStart.column ?? 0 }
+			}
+		}
+
 		rangesToBeRemoved.push(rangeToBeRemoved)
 	})
 

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

@@ -14,6 +14,28 @@ export type AnnotationComment = {
 	 * excluding the comment's opening and closing syntax.
 	 */
 	commentInnerRange: SourceRange
+	/**
+	 * The syntax used by the parent comment that contains the annotation.
+	 */
+	commentSyntax: {
+		/**
+		 * The opening syntax (e.g. `//` or `/*` for JS-style comments).
+		 */
+		opening: string
+		/**
+		 * The closing syntax (e.g. `-->` for HTML-style comments).
+		 *
+		 * This is `undefined` for single-line comment syntaxes.
+		 */
+		closing?: string | undefined
+		/**
+		 * The syntax used to start a new line inside the parent comment.
+		 * Used by JSDoc-style comments (e.g. `*`).
+		 *
+		 * This is `undefined` for single-line comment syntaxes.
+		 */
+		continuationLineStart?: RegExp | undefined
+	}
 	/**
 	 * The outer range of the annotation, covering both the annotation tag and
 	 * any optional content.

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

@@ -344,6 +344,9 @@ function getCommentFromMatchingSyntaxPair(options: {
 			contents,
 			commentRange,
 			commentInnerRange,
+			commentSyntax: {
+				...syntax,
+			},
 			annotationRange,
 			contentRanges,
 			targetRanges: [],

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

@@ -137,6 +137,9 @@ export function parseSingleLineParentComment(options: ParseParentCommentOptions)
 			contents,
 			commentRange,
 			commentInnerRange,
+			commentSyntax: {
+				opening: singleLineCommentSyntax.syntax,
+			},
 			annotationRange,
 			contentRanges,
 			targetRanges: [],