feat(language-core): infer prop JSDoc from defineModel's leading co…

…mments
vuejs · Feb 25, 2025 · 0a2f0c6 · 0a2f0c6
1 parent 810123c
commit 0a2f0c6
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 1 deletion.
diff --git a/packages/language-core/lib/codegen/script/scriptSetup.ts b/packages/language-core/lib/codegen/script/scriptSetup.ts
@@ -103,6 +103,15 @@ function* generateSetupFunction(
 	ctx.scriptSetupGeneratedOffset = options.getGeneratedLength() - scriptSetupRanges.importSectionEndOffset;
 
 	let setupCodeModifies: [Code[], number, number][] = [];
+	for (const { comments } of scriptSetupRanges.defineProp) {
+		if (comments) {
+			setupCodeModifies.push([
+				[``],
+				comments.start,
+				comments.end,
+			]);
+		}
+	}
 	if (scriptSetupRanges.defineProps) {
 		const { name, statement, callExp, typeArg } = scriptSetupRanges.defineProps;
 		setupCodeModifies.push(...generateDefineWithType(
@@ -485,6 +494,10 @@ function* generateComponentProps(
 		for (const defineProp of scriptSetupRanges.defineProp) {
 			const [propName, localName] = getPropAndLocalName(scriptSetup, defineProp);
 
+			if (defineProp.comments) {
+				yield generateSfcBlockSection(scriptSetup, defineProp.comments.start, defineProp.comments.end, codeFeatures.all);
+				yield newLine;
+			}
 			if (defineProp.isModel && !defineProp.name) {
 				yield propName!;
 			}

diff --git a/packages/language-core/lib/codegen/template/elementProps.ts b/packages/language-core/lib/codegen/template/elementProps.ts
@@ -135,7 +135,7 @@ export function* generateElementProps(
 						: wrapWith(
 							prop.loc.start.offset,
 							prop.loc.start.offset + 'v-model'.length,
-							ctx.codeFeatures.verification,
+							ctx.codeFeatures.withoutHighlightAndCompletion,
 							propName
 						)
 				),

diff --git a/packages/language-core/lib/parsers/scriptSetupRanges.ts b/packages/language-core/lib/parsers/scriptSetupRanges.ts
@@ -20,6 +20,7 @@ type DefineProp = {
 	defaultValue?: TextRange;
 	required?: boolean;
 	isModel?: boolean;
+	comments?: TextRange;
 	// used by component-meta
 	argNode?: ts.Expression;
 };
@@ -206,6 +207,7 @@ export function parseScriptSetupRanges(
 					defaultValue,
 					required,
 					isModel: true,
+					comments: getCommentsRange(ts, node, parents, ast),
 					argNode: options,
 				});
 			}
@@ -283,6 +285,7 @@ export function parseScriptSetupRanges(
 					runtimeType,
 					defaultValue,
 					required,
+					comments: getCommentsRange(ts, node, parents, ast),
 					argNode: options,
 				});
 			}
@@ -589,3 +592,24 @@ function getStatementRange(
 	}
 	return statementRange;
 }
+
+function getCommentsRange(
+	ts: typeof import('typescript'),
+	node: ts.Node,
+	parents: ts.Node[],
+	ast: ts.SourceFile
+) {
+	for (let i = parents.length - 1; i >= 0; i--) {
+		if (ts.isStatement(node)) {
+			break;
+		}
+		node = parents[i];
+	}
+	const comments = ts.getLeadingCommentRanges(ast.text, node.pos);
+	if (comments?.length) {
+		return {
+			start: comments[0].pos,
+			end: comments.at(-1)!.end,
+		};
+	}
+}