fix: translating roxygen parse to iteration (#2202)

refactor: translating roxygen parse to iteration

Author: EagleoutIce

src/core/print/slice-diff-ansi.ts

@@ -14,7 +14,7 @@ function mergeJointRangesInSorted(loc: { location: SourceRange; selected: boolea
 			return [
 				...acc.slice(0, -1), {
 					selected: curr.selected || acc[acc.length - 1].selected,
-					location: mergeRanges(acc[acc.length - 1].location, curr.location)
+					location: mergeRanges([acc[acc.length - 1].location, curr.location])
 				}];
 		} else {
 			return [...acc, curr];

src/linter/rules/unused-definition.ts

@@ -60,11 +60,11 @@ function buildQuickFix(variable: RNode<ParentInformation>, dfg: DataflowGraph, a
 	}
 
 	const totalRangeToRemove = mergeRanges(
-		...definedBys.map(d => {
+		[...definedBys.map(d => {
 			const vertex = ast.idMap.get(d);
 			return vertex?.info.fullRange ?? vertex?.location;
 		}),
-		variable.info.fullRange ?? variable.location
+		variable.info.fullRange ?? variable.location]
 	);
 
 	return [{
@@ -85,7 +85,7 @@ function onlyKeepSupersetOfUnused(
 		return elements; // nothing to filter, only one element
 	}
 	return elements.filter(e => {
-		const otherRange = mergeRanges(...(e.quickFix?.map(q => q.range) ?? [e.range]));
+		const otherRange = mergeRanges((e.quickFix?.map(q => q.range) ?? [e.range]));
 		return !ranges.some(r => rangeCompare(r, otherRange) !== 0 && rangeIsSubsetOf(otherRange, r)); // there is no smaller remove
 	});
 }

src/r-bridge/roxygen2/roxygen-parse.ts

@@ -49,7 +49,7 @@ export function parseRoxygenCommentsOfNode(node: RNode<ParentInformation>, idMap
 		attachedTo:  cur?.info.id,
 		requestNode: node.info.id,
 		range:       [
-			...mergeRanges(...comments.map(c => c.location)),
+			...mergeRanges(comments.map(c => c.location)),
 			comments.find(c => c.info.file)?.info.file
 		]
 	};
@@ -75,7 +75,10 @@ export function parseRoxygenComment(commentText: readonly string[]): RoxygenTag[
 		tags:  [],
 		idx:   0
 	};
-	val(state, [KnownRoxygenTags.Text]);
+	let tag = val(state, [KnownRoxygenTags.Text]);
+	while(tag) {
+		tag = parseRoxygenTag(state, tag);
+	}
 	return state.tags;
 }
 
@@ -116,7 +119,7 @@ function addTag(state: RoxygenParseContext, tag: RoxygenTag): void {
 	state.tags.push(tag);
 }
 
-function val(state: RoxygenParseContext, tagName: TagLine, lineToVal: (lines: readonly string[]) => unknown | undefined = l => l.join('\n').trim()): void {
+function val(state: RoxygenParseContext, tagName: TagLine, lineToVal: (lines: readonly string[]) => unknown | undefined = l => l.join('\n').trim()): TagLine | undefined {
 	const [lines, nextTag] = collectUntilNextTag(state);
 
 	if(tagName[1]) {
@@ -141,26 +144,26 @@ function val(state: RoxygenParseContext, tagName: TagLine, lineToVal: (lines: re
 		}
 
 	}
-	parseRoxygenTag(state, nextTag);
+	return nextTag;
 }
 
-const spaceVals = (s: RoxygenParseContext, t: TagLine): void => val(s, t, l => splitAtEscapeSensitive(l.join(' ')));
-const flagVal =  (s: RoxygenParseContext, t: TagLine): void => val(s, t, () => undefined);
+const spaceVals = (s: RoxygenParseContext, t: TagLine): TagLine | undefined => val(s, t, l => splitAtEscapeSensitive(l.join(' ')));
+const flagVal =  (s: RoxygenParseContext, t: TagLine): TagLine | undefined => val(s, t, () => undefined);
 
-const section = (s: RoxygenParseContext, t: TagLine): void => val(s, t, l => {
+const section = (s: RoxygenParseContext, t: TagLine): TagLine | undefined => val(s, t, l => {
 	return { title: l[0].trim(), content: l.slice(1).join('\n').trim() };
 });
 
-export const firstAndRest = (firstName: string, secondName: string) => (s: RoxygenParseContext, t: TagLine): void => val(s, t, l => {
+export const firstAndRest = (firstName: string, secondName: string) => (s: RoxygenParseContext, t: TagLine): TagLine | undefined => val(s, t, l => {
 	const vals = splitAtEscapeSensitive(l.join('\n'));
 	return { [firstName]: vals[0], [secondName]: vals.slice(1).join(' ').trim() };
 });
-const firstAndArrayRest = (firstName: string, secondName: string) => (s: RoxygenParseContext, t: TagLine): void => val(s, t, l => {
+const firstAndArrayRest = (firstName: string, secondName: string) => (s: RoxygenParseContext, t: TagLine): TagLine | undefined => val(s, t, l => {
 	const vals = splitAtEscapeSensitive(l.join('\n'));
 	return { [firstName]: vals[0], [secondName]: vals.slice(1) };
 });
 
-const asNumber = (s: RoxygenParseContext, t: TagLine): void => val(s, t, l => {
+const asNumber = (s: RoxygenParseContext, t: TagLine): TagLine | undefined => val(s, t, l => {
 	const num = Number(l.join(' ').trim());
 	return Number.isNaN(num) ? undefined : num;
 });
@@ -225,12 +228,13 @@ const TagMap = {
 		tag:     t[0],
 		content: l.join(' ')
 	}))
-} as const satisfies Record<KnownRoxygenTags, (state: RoxygenParseContext, tagName: TagLine) => void>;
+} as const satisfies Record<KnownRoxygenTags, (state: RoxygenParseContext, tagName: TagLine) => TagLine | undefined>;
 
-function parseRoxygenTag(state: RoxygenParseContext, tagName: TagLine | undefined): void {
+/** returns the next tag */
+function parseRoxygenTag(state: RoxygenParseContext, tagName: TagLine | undefined): TagLine | undefined {
 	if(tagName === undefined) {
-		return;
+		return undefined;
 	}
 	const parser = TagMap[tagName[0] as KnownRoxygenTags] ?? val;
-	parser(state, tagName);
+	return parser(state, tagName);
 }

src/util/range.ts

@@ -76,7 +76,7 @@ export function invalidRange(): SourceRange {
  * If you are interested in combining overlapping ranges into a minimal set of ranges, see {@link combineRanges}.
  * @throws if no ranges are provided
  */
-export function mergeRanges(...rs: (SourceRange | undefined)[]): SourceRange {
+export function mergeRanges(rs: (SourceRange | undefined)[] = []): SourceRange {
 	const rsSafe: SourceRange[] = rs.filter(isNotUndefined);
 	guard(rsSafe.length > 0, 'Cannot merge no ranges');
 	return rsSafe.reduce(([sl, sc, el, ec], [nsl, nsc, nel, nec]) => [

test/functionality/r-bridge/lang/ast/model.test.ts

@@ -9,7 +9,7 @@ describe('Model specific tests', () => {
 		});
 		const assertMerged = (ranges: SourceRange[], expected: SourceRange, message = ''): void => {
 			test(JSON.stringify(ranges), () => {
-				assert.deepStrictEqual(mergeRanges(...ranges), expected, `${message}`);
+				assert.deepStrictEqual(mergeRanges(ranges), expected, `${message}`);
 			});
 		};
 		describe('one ranges always returns the same', () => {

test/functionality/util/range.test.ts

@@ -95,7 +95,7 @@ describe('Range', () => {
 	describe('mergeRanges', () => {
 		function assertMerged(expected: SourceRange, ...a: SourceRange[]) {
 			assert.deepStrictEqual(
-				mergeRanges(...a),
+				mergeRanges(a),
 				expected,
 				`mergeRanges(${JSON.stringify(a)})`
 			);