compmark-vue 0.1.3 → 0.2.0

package/dist/cli.mjs

@@ -3,6 +3,25 @@ import { existsSync, readFileSync, writeFileSync } from "node:fs";
 import { join, resolve } from "node:path";
 import { compileScript, parse } from "@vue/compiler-sfc";
 //#region src/parser.ts
+function parseJSDocTags(comments) {
+	const result = { description: "" };
+	const descLines = [];
+	for (let i = comments.length - 1; i >= 0; i--) {
+		const c = comments[i];
+		if (c.type !== "CommentBlock") continue;
+		const lines = c.value.split("\n").map((l) => l.replace(/^\s*\*\s?/, "").trim()).filter((l) => l && !l.startsWith("/"));
+		for (const line of lines) if (line.startsWith("@deprecated")) result.deprecated = line.replace(/^@deprecated\s*/, "").trim() || true;
+		else if (line.startsWith("@since")) result.since = line.replace(/^@since\s*/, "").trim();
+		else if (line.startsWith("@example")) result.example = line.replace(/^@example\s*/, "").trim();
+		else if (line.startsWith("@see")) result.see = line.replace(/^@see\s*/, "").trim();
+		else if (line.startsWith("@default")) result.defaultOverride = line.replace(/^@default\s*/, "").trim();
+		else if (line.startsWith("@internal")) result.internal = true;
+		else if (!line.startsWith("@")) descLines.push(line);
+		break;
+	}
+	result.description = descLines.join(" ");
+	return result;
+}
 function parseSFC(source, filename) {
 	const doc = {
 		name: filename.replace(/\.vue$/, "").split("/").pop() ?? "Unknown",
@@ -12,17 +31,60 @@ function parseSFC(source, filename) {
 	const { descriptor } = parse(source, { filename });
 	if (!descriptor.scriptSetup && !descriptor.script) return doc;
 	const compiled = compileScript(descriptor, { id: filename });
-	const ast = compiled.scriptSetupAst;
-	if (!ast) return doc;
-	const scriptSource = descriptor.scriptSetup?.content ?? compiled.content;
-	for (const stmt of ast) {
-		const calls = extractDefineCalls(stmt);
-		for (const { callee, args, leadingComments, typeParams, defaultsArg } of calls) if (callee === "defineProps" && args[0]?.type === "ObjectExpression") doc.props = extractProps(args[0], scriptSource);
-		else if (callee === "defineProps" && typeParams?.params[0]?.type === "TSTypeLiteral") doc.props = extractTypeProps(typeParams.params[0], defaultsArg, scriptSource);
-		else if (callee === "defineEmits" && args[0]?.type === "ArrayExpression") doc.emits = extractEmits(args[0], leadingComments);
+	const componentJSDoc = extractComponentJSDoc(compiled.scriptSetupAst ?? compiled.scriptAst ?? []);
+	doc.description = componentJSDoc.description;
+	doc.internal = componentJSDoc.internal;
+	const setupAst = compiled.scriptSetupAst;
+	if (setupAst) {
+		const scriptSource = descriptor.scriptSetup?.content ?? compiled.content;
+		for (const stmt of setupAst) {
+			const calls = extractDefineCalls(stmt);
+			for (const { callee, args, leadingComments, typeParams, defaultsArg } of calls) if (callee === "defineProps" && args[0]?.type === "ObjectExpression") doc.props = extractProps(args[0], scriptSource);
+			else if (callee === "defineProps" && typeParams?.params[0]?.type === "TSTypeLiteral") doc.props = extractTypeProps(typeParams.params[0], defaultsArg, scriptSource);
+			else if (callee === "defineEmits" && args[0]?.type === "ArrayExpression") doc.emits = extractEmits(args[0], leadingComments);
+			else if (callee === "defineEmits" && typeParams?.params[0]?.type === "TSTypeLiteral") doc.emits = extractTypeEmits(typeParams.params[0]);
+			else if (callee === "defineSlots" && typeParams?.params[0]?.type === "TSTypeLiteral") doc.slots = extractTypeSlots(typeParams.params[0]);
+			else if (callee === "defineExpose" && args[0]?.type === "ObjectExpression") doc.exposes = extractExposes(args[0], scriptSource);
+		}
+		doc.composables = extractComposables(setupAst);
+	}
+	const scriptAst = compiled.scriptAst;
+	if (scriptAst && doc.props.length === 0 && doc.emits.length === 0) {
+		const optionsDoc = extractOptionsAPI(scriptAst, compiled.content);
+		doc.props = optionsDoc.props;
+		doc.emits = optionsDoc.emits;
+	}
+	if (descriptor.template?.ast) {
+		const templateSlots = extractTemplateSlots(descriptor.template.ast);
+		doc.slots = mergeSlots(doc.slots ?? [], templateSlots);
 	}
 	return doc;
 }
+function extractComponentJSDoc(ast) {
+	if (ast.length === 0) return {
+		description: "",
+		internal: false
+	};
+	const comments = ast[0].leadingComments ?? [];
+	if (comments.length === 0) return {
+		description: "",
+		internal: false
+	};
+	const firstComment = comments[0];
+	if (firstComment.type !== "CommentBlock") return {
+		description: "",
+		internal: false
+	};
+	const result = parseJSDocTags([firstComment]);
+	if (result.internal) return {
+		description: result.description,
+		internal: true
+	};
+	return {
+		description: "",
+		internal: false
+	};
+}
 function processCallExpression(callExpr, leadingComments) {
 	if (callExpr.callee.type === "Identifier" && callExpr.callee.name === "withDefaults" && callExpr.arguments[0]?.type === "CallExpression" && callExpr.arguments[0].callee.type === "Identifier" && callExpr.arguments[0].callee.name === "defineProps") {
 		const innerCall = callExpr.arguments[0];
@@ -58,13 +120,17 @@ function extractTypeProps(typeLiteral, defaultsArg, source) {
 		const name = member.key.type === "Identifier" ? member.key.name : member.key.type === "StringLiteral" ? member.key.value : "";
 		if (!name) continue;
 		const type = member.typeAnnotation?.typeAnnotation ? resolveTypeString(member.typeAnnotation.typeAnnotation) : "unknown";
-		const description = extractJSDoc(member.leadingComments ?? []);
+		const jsdoc = parseJSDocTags(member.leadingComments ?? []);
 		props.push({
 			name,
 			type,
 			required: !member.optional,
 			default: defaults.get(name),
-			description
+			description: jsdoc.description,
+			...jsdoc.deprecated !== void 0 && { deprecated: jsdoc.deprecated },
+			...jsdoc.since && { since: jsdoc.since },
+			...jsdoc.example && { example: jsdoc.example },
+			...jsdoc.see && { see: jsdoc.see }
 		});
 	}
 	return props;
@@ -76,6 +142,9 @@ function resolveTypeString(node) {
 		case "TSBooleanKeyword": return "boolean";
 		case "TSObjectKeyword": return "object";
 		case "TSAnyKeyword": return "any";
+		case "TSVoidKeyword": return "void";
+		case "TSNullKeyword": return "null";
+		case "TSUndefinedKeyword": return "undefined";
 		case "TSUnionType": return node.types.map((t) => resolveTypeString(t)).join(" | ");
 		case "TSIntersectionType": return node.types.map((t) => resolveTypeString(t)).join(" & ");
 		case "TSLiteralType":
@@ -90,6 +159,9 @@ function resolveTypeString(node) {
 			return name;
 		}
 		case "TSFunctionType": return "Function";
+		case "TSTupleType": return `[${node.elementTypes.map((t) => resolveTypeString(t)).join(", ")}]`;
+		case "TSNamedTupleMember": return resolveTypeString(node.elementType);
+		case "TSParenthesizedType": return resolveTypeString(node.typeAnnotation);
 		default: return "unknown";
 	}
 }
@@ -110,13 +182,20 @@ function extractProps(obj, source) {
 		const p = prop;
 		const name = p.key.type === "Identifier" ? p.key.name : p.key.type === "StringLiteral" ? p.key.value : "";
 		if (!name) continue;
-		const description = extractJSDoc(p.leadingComments ?? []);
+		const jsdoc = parseJSDocTags(p.leadingComments ?? []);
+		const tagFields = {
+			...jsdoc.deprecated !== void 0 && { deprecated: jsdoc.deprecated },
+			...jsdoc.since && { since: jsdoc.since },
+			...jsdoc.example && { example: jsdoc.example },
+			...jsdoc.see && { see: jsdoc.see }
+		};
 		if (p.value.type === "Identifier") props.push({
 			name,
 			type: p.value.name,
 			required: false,
 			default: void 0,
-			description
+			description: jsdoc.description,
+			...tagFields
 		});
 		else if (p.value.type === "ArrayExpression") {
 			const types = p.value.elements.filter((el) => el?.type === "Identifier").map((el) => el.name);
@@ -125,7 +204,8 @@ function extractProps(obj, source) {
 				type: types.join(" | "),
 				required: false,
 				default: void 0,
-				description
+				description: jsdoc.description,
+				...tagFields
 			});
 		} else if (p.value.type === "ObjectExpression") {
 			let type = "unknown";
@@ -145,7 +225,8 @@ function extractProps(obj, source) {
 				type,
 				required,
 				default: defaultVal,
-				description
+				description: jsdoc.description,
+				...tagFields
 			});
 		}
 	}
@@ -172,14 +253,188 @@ function parseEmitJSDoc(comments) {
 	}
 	return map;
 }
-function extractJSDoc(comments) {
-	for (let i = comments.length - 1; i >= 0; i--) {
-		const c = comments[i];
-		if (c.type !== "CommentBlock") continue;
-		const lines = c.value.split("\n").map((l) => l.replace(/^\s*\*\s?/, "").trim()).filter((l) => l && !l.startsWith("@") && !l.startsWith("/"));
-		if (lines.length > 0) return lines.join(" ");
+function extractTypeEmits(typeLiteral) {
+	const emits = [];
+	for (const member of typeLiteral.members) if (member.type === "TSPropertySignature") {
+		const name = member.key.type === "Identifier" ? member.key.name : member.key.type === "StringLiteral" ? member.key.value : "";
+		if (!name) continue;
+		const jsdoc = parseJSDocTags(member.leadingComments ?? []);
+		let payload;
+		const typeAnnotation = member.typeAnnotation?.typeAnnotation;
+		if (typeAnnotation?.type === "TSTupleType") payload = typeAnnotation.elementTypes.map((el) => {
+			if (el.type === "TSNamedTupleMember") return `${el.label?.name ?? "arg"}: ${resolveTypeString(el.elementType)}`;
+			return resolveTypeString(el);
+		}).join(", ");
+		emits.push({
+			name,
+			description: jsdoc.description,
+			...payload && { payload }
+		});
+	} else if (member.type === "TSCallSignatureDeclaration") {
+		const params = member.parameters ?? [];
+		if (params.length === 0) continue;
+		const firstParam = params[0];
+		if (firstParam?.typeAnnotation?.typeAnnotation?.type !== "TSLiteralType" || firstParam.typeAnnotation.typeAnnotation.literal.type !== "StringLiteral") continue;
+		const name = firstParam.typeAnnotation.typeAnnotation.literal.value;
+		const jsdoc = parseJSDocTags(member.leadingComments ?? []);
+		const payloadParams = params.slice(1);
+		let payload;
+		if (payloadParams.length > 0) payload = payloadParams.map((p) => {
+			return `${p.type === "Identifier" ? p.name : "arg"}: ${p.typeAnnotation?.typeAnnotation ? resolveTypeString(p.typeAnnotation.typeAnnotation) : "unknown"}`;
+		}).join(", ");
+		emits.push({
+			name,
+			description: jsdoc.description,
+			...payload && { payload }
+		});
+	}
+	return emits;
+}
+function extractTypeSlots(typeLiteral) {
+	const slots = [];
+	for (const member of typeLiteral.members) {
+		const name = member.key?.type === "Identifier" ? member.key.name : member.key?.type === "StringLiteral" ? member.key.value : "";
+		if (!name) continue;
+		const jsdoc = parseJSDocTags(member.leadingComments ?? []);
+		const bindings = [];
+		if (member.type === "TSMethodSignature" && member.parameters?.length > 0) {
+			const propsType = member.parameters[0]?.typeAnnotation?.typeAnnotation;
+			if (propsType?.type === "TSTypeLiteral") {
+				for (const prop of propsType.members) if (prop.type === "TSPropertySignature") {
+					const propName = prop.key.type === "Identifier" ? prop.key.name : prop.key.type === "StringLiteral" ? prop.key.value : "";
+					const propType = prop.typeAnnotation?.typeAnnotation ? resolveTypeString(prop.typeAnnotation.typeAnnotation) : "unknown";
+					if (propName) bindings.push(`${propName}: ${propType}`);
+				}
+			}
+		}
+		slots.push({
+			name,
+			description: jsdoc.description,
+			bindings
+		});
+	}
+	return slots;
+}
+function extractExposes(obj, _source) {
+	const exposes = [];
+	for (const prop of obj.properties) {
+		if (prop.type !== "ObjectProperty" && prop.type !== "ObjectMethod") continue;
+		const key = prop.key;
+		const name = key.type === "Identifier" ? key.name : key.type === "StringLiteral" ? key.value : "";
+		if (!name) continue;
+		const jsdoc = parseJSDocTags(prop.leadingComments ?? []);
+		exposes.push({
+			name,
+			type: "unknown",
+			description: jsdoc.description
+		});
+	}
+	return exposes;
+}
+function extractComposables(ast) {
+	const seen = /* @__PURE__ */ new Set();
+	const composables = [];
+	for (const stmt of ast) {
+		const callNames = extractComposableCallNames(stmt);
+		for (const name of callNames) if (!seen.has(name)) {
+			seen.add(name);
+			composables.push({ name });
+		}
 	}
-	return "";
+	return composables;
+}
+function extractComposableCallNames(stmt) {
+	const names = [];
+	if (stmt.type === "ExpressionStatement" && stmt.expression.type === "CallExpression" && stmt.expression.callee.type === "Identifier" && /^use[A-Z]/.test(stmt.expression.callee.name)) names.push(stmt.expression.callee.name);
+	if (stmt.type === "VariableDeclaration") {
+		for (const decl of stmt.declarations) if (decl.init?.type === "CallExpression" && decl.init.callee.type === "Identifier" && /^use[A-Z]/.test(decl.init.callee.name)) names.push(decl.init.callee.name);
+	}
+	return names;
+}
+function extractTemplateSlots(templateAst) {
+	const slots = [];
+	walkTemplate(templateAst.children ?? [], slots);
+	return slots;
+}
+function walkTemplate(children, slots) {
+	for (const node of children) {
+		if (node.type === 1 && node.tag === "slot") {
+			let name = "default";
+			const bindings = [];
+			for (const prop of node.props ?? []) {
+				if (prop.type === 6 && prop.name === "name" && prop.value?.content) name = prop.value.content;
+				if (prop.type === 7 && prop.name === "bind" && prop.arg?.content) bindings.push(prop.arg.content);
+			}
+			slots.push({
+				name,
+				description: "",
+				bindings
+			});
+		}
+		if (node.children) walkTemplate(node.children, slots);
+		if (node.branches) {
+			for (const branch of node.branches) if (branch.children) walkTemplate(branch.children, slots);
+		}
+	}
+}
+function mergeSlots(typedSlots, templateSlots) {
+	const merged = [...typedSlots];
+	const typedNames = new Set(typedSlots.map((s) => s.name));
+	for (const ts of templateSlots) if (!typedNames.has(ts.name)) merged.push(ts);
+	return merged;
+}
+function extractOptionsAPI(ast, source) {
+	let props = [];
+	let emits = [];
+	for (const stmt of ast) {
+		if (stmt.type !== "ExportDefaultDeclaration") continue;
+		const decl = stmt.declaration;
+		if (decl.type !== "ObjectExpression") continue;
+		for (const prop of decl.properties) {
+			if (prop.type !== "ObjectProperty") continue;
+			const key = prop.key;
+			const name = key.type === "Identifier" ? key.name : "";
+			if (name === "props") {
+				if (prop.value.type === "ObjectExpression") props = extractProps(prop.value, source);
+				else if (prop.value.type === "ArrayExpression") props = extractArrayProps(prop.value);
+			} else if (name === "emits") {
+				if (prop.value.type === "ArrayExpression") {
+					const comments = stmt.leadingComments ?? [];
+					emits = extractEmits(prop.value, comments);
+				} else if (prop.value.type === "ObjectExpression") emits = extractObjectEmits(prop.value);
+			}
+		}
+		break;
+	}
+	return {
+		props,
+		emits
+	};
+}
+function extractArrayProps(arr) {
+	const props = [];
+	for (const el of arr.elements) if (el?.type === "StringLiteral") props.push({
+		name: el.value,
+		type: "unknown",
+		required: false,
+		default: void 0,
+		description: ""
+	});
+	return props;
+}
+function extractObjectEmits(obj) {
+	const emits = [];
+	for (const prop of obj.properties) {
+		if (prop.type !== "ObjectProperty") continue;
+		const name = prop.key.type === "Identifier" ? prop.key.name : prop.key.type === "StringLiteral" ? prop.key.value : "";
+		if (!name) continue;
+		const jsdoc = parseJSDocTags(prop.leadingComments ?? []);
+		emits.push({
+			name,
+			description: jsdoc.description
+		});
+	}
+	return emits;
 }
 function stringifyDefault(node, source) {
 	switch (node.type) {
@@ -198,22 +453,46 @@ function stringifyDefault(node, source) {
 //#region src/markdown.ts
 function generateMarkdown(doc) {
 	const sections = [`# ${doc.name}`];
-	if (doc.props.length === 0 && doc.emits.length === 0) {
-		sections.push("", "No documentable props or emits found.");
+	if (doc.description) sections.push("", doc.description);
+	const hasProps = doc.props.length > 0;
+	const hasEmits = doc.emits.length > 0;
+	const hasSlots = (doc.slots?.length ?? 0) > 0;
+	const hasExposes = (doc.exposes?.length ?? 0) > 0;
+	const hasComposables = (doc.composables?.length ?? 0) > 0;
+	if (!hasProps && !hasEmits && !hasSlots && !hasExposes && !hasComposables) {
+		sections.push("", "No documentable API found.");
 		return sections.join("\n") + "\n";
 	}
-	if (doc.props.length > 0) {
+	if (hasProps) {
 		sections.push("", "## Props", "");
 		sections.push("| Name | Type | Required | Default | Description |");
 		sections.push("| --- | --- | --- | --- | --- |");
+		const examples = [];
 		for (const p of doc.props) {
 			const def = p.default !== void 0 ? `\`${p.default}\`` : "-";
-			const desc = p.description || "-";
+			let desc = p.description || "-";
+			if (p.deprecated) desc += typeof p.deprecated === "string" && p.deprecated ? ` **Deprecated**: ${p.deprecated}` : " **Deprecated**";
+			if (p.since) desc += ` *(since ${p.since})*`;
+			if (p.see) desc += ` See: ${p.see}`;
 			const req = p.required ? "Yes" : "No";
 			sections.push(`| ${p.name} | ${p.type} | ${req} | ${def} | ${desc} |`);
+			if (p.example) examples.push({
+				name: p.name,
+				example: p.example
+			});
 		}
+		for (const { name, example } of examples) sections.push("", `**\`${name}\` example:**`, "", "```", example, "```");
 	}
-	if (doc.emits.length > 0) {
+	if (hasEmits) if (doc.emits.some((e) => e.payload)) {
+		sections.push("", "## Emits", "");
+		sections.push("| Name | Payload | Description |");
+		sections.push("| --- | --- | --- |");
+		for (const e of doc.emits) {
+			const desc = e.description || "-";
+			const payload = e.payload || "-";
+			sections.push(`| ${e.name} | ${payload} | ${desc} |`);
+		}
+	} else {
 		sections.push("", "## Emits", "");
 		sections.push("| Name | Description |");
 		sections.push("| --- | --- |");
@@ -222,6 +501,29 @@ function generateMarkdown(doc) {
 			sections.push(`| ${e.name} | ${desc} |`);
 		}
 	}
+	if (hasSlots) {
+		sections.push("", "## Slots", "");
+		sections.push("| Name | Bindings | Description |");
+		sections.push("| --- | --- | --- |");
+		for (const s of doc.slots) {
+			const desc = s.description || "-";
+			const bindings = s.bindings.length > 0 ? s.bindings.join(", ") : "-";
+			sections.push(`| ${s.name} | ${bindings} | ${desc} |`);
+		}
+	}
+	if (hasExposes) {
+		sections.push("", "## Exposed", "");
+		sections.push("| Name | Type | Description |");
+		sections.push("| --- | --- | --- |");
+		for (const e of doc.exposes) {
+			const desc = e.description || "-";
+			sections.push(`| ${e.name} | ${e.type} | ${desc} |`);
+		}
+	}
+	if (hasComposables) {
+		sections.push("", "## Composables Used", "");
+		for (const c of doc.composables) sections.push(`- \`${c.name}\``);
+	}
 	return sections.join("\n") + "\n";
 }
 //#endregion
@@ -234,7 +536,7 @@ function parseComponent(filePath) {
 //#region src/cli.ts
 const filePath = process.argv[2];
 if (!filePath) {
-	console.error("Usage: compmark-vue <path-to-component.vue>");
+	console.error("Usage: compmark <path-to-component.vue>");
 	process.exit(1);
 }
 if (!filePath.endsWith(".vue")) {
@@ -248,6 +550,11 @@ if (!existsSync(abs)) {
 }
 try {
 	const doc = parseComponent(abs);
+	if (doc.internal) {
+		const name = abs.split("/").pop() ?? filePath;
+		console.log(`Skipped ${name} (marked @internal)`);
+		process.exit(0);
+	}
 	const md = generateMarkdown(doc);
 	const outFile = `${doc.name}.md`;
 	writeFileSync(join(process.cwd(), outFile), md, "utf-8");

package/dist/index.d.mts

@@ -5,15 +5,38 @@ interface PropDoc {
   required: boolean;
   default: string | undefined;
   description: string;
+  deprecated?: string | boolean;
+  since?: string;
+  example?: string;
+  see?: string;
 }
 interface EmitDoc {
   name: string;
   description: string;
+  payload?: string;
+}
+interface SlotDoc {
+  name: string;
+  description: string;
+  bindings: string[];
+}
+interface ExposeDoc {
+  name: string;
+  type: string;
+  description: string;
+}
+interface ComposableDoc {
+  name: string;
 }
 interface ComponentDoc {
   name: string;
+  description?: string;
+  internal?: boolean;
   props: PropDoc[];
   emits: EmitDoc[];
+  slots?: SlotDoc[];
+  exposes?: ExposeDoc[];
+  composables?: ComposableDoc[];
 }
 //#endregion
 //#region src/parser.d.ts
@@ -25,4 +48,4 @@ declare function generateMarkdown(doc: ComponentDoc): string;
 //#region src/index.d.ts
 declare function parseComponent(filePath: string): ComponentDoc;
 //#endregion
-export { type ComponentDoc, type EmitDoc, type PropDoc, generateMarkdown, parseComponent, parseSFC };
+export { type ComponentDoc, type ComposableDoc, type EmitDoc, type ExposeDoc, type PropDoc, type SlotDoc, generateMarkdown, parseComponent, parseSFC };

package/dist/index.mjs

@@ -2,6 +2,25 @@ import { readFileSync } from "node:fs";
 import { resolve } from "node:path";
 import { compileScript, parse } from "@vue/compiler-sfc";
 //#region src/parser.ts
+function parseJSDocTags(comments) {
+	const result = { description: "" };
+	const descLines = [];
+	for (let i = comments.length - 1; i >= 0; i--) {
+		const c = comments[i];
+		if (c.type !== "CommentBlock") continue;
+		const lines = c.value.split("\n").map((l) => l.replace(/^\s*\*\s?/, "").trim()).filter((l) => l && !l.startsWith("/"));
+		for (const line of lines) if (line.startsWith("@deprecated")) result.deprecated = line.replace(/^@deprecated\s*/, "").trim() || true;
+		else if (line.startsWith("@since")) result.since = line.replace(/^@since\s*/, "").trim();
+		else if (line.startsWith("@example")) result.example = line.replace(/^@example\s*/, "").trim();
+		else if (line.startsWith("@see")) result.see = line.replace(/^@see\s*/, "").trim();
+		else if (line.startsWith("@default")) result.defaultOverride = line.replace(/^@default\s*/, "").trim();
+		else if (line.startsWith("@internal")) result.internal = true;
+		else if (!line.startsWith("@")) descLines.push(line);
+		break;
+	}
+	result.description = descLines.join(" ");
+	return result;
+}
 function parseSFC(source, filename) {
 	const doc = {
 		name: filename.replace(/\.vue$/, "").split("/").pop() ?? "Unknown",
@@ -11,17 +30,60 @@ function parseSFC(source, filename) {
 	const { descriptor } = parse(source, { filename });
 	if (!descriptor.scriptSetup && !descriptor.script) return doc;
 	const compiled = compileScript(descriptor, { id: filename });
-	const ast = compiled.scriptSetupAst;
-	if (!ast) return doc;
-	const scriptSource = descriptor.scriptSetup?.content ?? compiled.content;
-	for (const stmt of ast) {
-		const calls = extractDefineCalls(stmt);
-		for (const { callee, args, leadingComments, typeParams, defaultsArg } of calls) if (callee === "defineProps" && args[0]?.type === "ObjectExpression") doc.props = extractProps(args[0], scriptSource);
-		else if (callee === "defineProps" && typeParams?.params[0]?.type === "TSTypeLiteral") doc.props = extractTypeProps(typeParams.params[0], defaultsArg, scriptSource);
-		else if (callee === "defineEmits" && args[0]?.type === "ArrayExpression") doc.emits = extractEmits(args[0], leadingComments);
+	const componentJSDoc = extractComponentJSDoc(compiled.scriptSetupAst ?? compiled.scriptAst ?? []);
+	doc.description = componentJSDoc.description;
+	doc.internal = componentJSDoc.internal;
+	const setupAst = compiled.scriptSetupAst;
+	if (setupAst) {
+		const scriptSource = descriptor.scriptSetup?.content ?? compiled.content;
+		for (const stmt of setupAst) {
+			const calls = extractDefineCalls(stmt);
+			for (const { callee, args, leadingComments, typeParams, defaultsArg } of calls) if (callee === "defineProps" && args[0]?.type === "ObjectExpression") doc.props = extractProps(args[0], scriptSource);
+			else if (callee === "defineProps" && typeParams?.params[0]?.type === "TSTypeLiteral") doc.props = extractTypeProps(typeParams.params[0], defaultsArg, scriptSource);
+			else if (callee === "defineEmits" && args[0]?.type === "ArrayExpression") doc.emits = extractEmits(args[0], leadingComments);
+			else if (callee === "defineEmits" && typeParams?.params[0]?.type === "TSTypeLiteral") doc.emits = extractTypeEmits(typeParams.params[0]);
+			else if (callee === "defineSlots" && typeParams?.params[0]?.type === "TSTypeLiteral") doc.slots = extractTypeSlots(typeParams.params[0]);
+			else if (callee === "defineExpose" && args[0]?.type === "ObjectExpression") doc.exposes = extractExposes(args[0], scriptSource);
+		}
+		doc.composables = extractComposables(setupAst);
+	}
+	const scriptAst = compiled.scriptAst;
+	if (scriptAst && doc.props.length === 0 && doc.emits.length === 0) {
+		const optionsDoc = extractOptionsAPI(scriptAst, compiled.content);
+		doc.props = optionsDoc.props;
+		doc.emits = optionsDoc.emits;
+	}
+	if (descriptor.template?.ast) {
+		const templateSlots = extractTemplateSlots(descriptor.template.ast);
+		doc.slots = mergeSlots(doc.slots ?? [], templateSlots);
 	}
 	return doc;
 }
+function extractComponentJSDoc(ast) {
+	if (ast.length === 0) return {
+		description: "",
+		internal: false
+	};
+	const comments = ast[0].leadingComments ?? [];
+	if (comments.length === 0) return {
+		description: "",
+		internal: false
+	};
+	const firstComment = comments[0];
+	if (firstComment.type !== "CommentBlock") return {
+		description: "",
+		internal: false
+	};
+	const result = parseJSDocTags([firstComment]);
+	if (result.internal) return {
+		description: result.description,
+		internal: true
+	};
+	return {
+		description: "",
+		internal: false
+	};
+}
 function processCallExpression(callExpr, leadingComments) {
 	if (callExpr.callee.type === "Identifier" && callExpr.callee.name === "withDefaults" && callExpr.arguments[0]?.type === "CallExpression" && callExpr.arguments[0].callee.type === "Identifier" && callExpr.arguments[0].callee.name === "defineProps") {
 		const innerCall = callExpr.arguments[0];
@@ -57,13 +119,17 @@ function extractTypeProps(typeLiteral, defaultsArg, source) {
 		const name = member.key.type === "Identifier" ? member.key.name : member.key.type === "StringLiteral" ? member.key.value : "";
 		if (!name) continue;
 		const type = member.typeAnnotation?.typeAnnotation ? resolveTypeString(member.typeAnnotation.typeAnnotation) : "unknown";
-		const description = extractJSDoc(member.leadingComments ?? []);
+		const jsdoc = parseJSDocTags(member.leadingComments ?? []);
 		props.push({
 			name,
 			type,
 			required: !member.optional,
 			default: defaults.get(name),
-			description
+			description: jsdoc.description,
+			...jsdoc.deprecated !== void 0 && { deprecated: jsdoc.deprecated },
+			...jsdoc.since && { since: jsdoc.since },
+			...jsdoc.example && { example: jsdoc.example },
+			...jsdoc.see && { see: jsdoc.see }
 		});
 	}
 	return props;
@@ -75,6 +141,9 @@ function resolveTypeString(node) {
 		case "TSBooleanKeyword": return "boolean";
 		case "TSObjectKeyword": return "object";
 		case "TSAnyKeyword": return "any";
+		case "TSVoidKeyword": return "void";
+		case "TSNullKeyword": return "null";
+		case "TSUndefinedKeyword": return "undefined";
 		case "TSUnionType": return node.types.map((t) => resolveTypeString(t)).join(" | ");
 		case "TSIntersectionType": return node.types.map((t) => resolveTypeString(t)).join(" & ");
 		case "TSLiteralType":
@@ -89,6 +158,9 @@ function resolveTypeString(node) {
 			return name;
 		}
 		case "TSFunctionType": return "Function";
+		case "TSTupleType": return `[${node.elementTypes.map((t) => resolveTypeString(t)).join(", ")}]`;
+		case "TSNamedTupleMember": return resolveTypeString(node.elementType);
+		case "TSParenthesizedType": return resolveTypeString(node.typeAnnotation);
 		default: return "unknown";
 	}
 }
@@ -109,13 +181,20 @@ function extractProps(obj, source) {
 		const p = prop;
 		const name = p.key.type === "Identifier" ? p.key.name : p.key.type === "StringLiteral" ? p.key.value : "";
 		if (!name) continue;
-		const description = extractJSDoc(p.leadingComments ?? []);
+		const jsdoc = parseJSDocTags(p.leadingComments ?? []);
+		const tagFields = {
+			...jsdoc.deprecated !== void 0 && { deprecated: jsdoc.deprecated },
+			...jsdoc.since && { since: jsdoc.since },
+			...jsdoc.example && { example: jsdoc.example },
+			...jsdoc.see && { see: jsdoc.see }
+		};
 		if (p.value.type === "Identifier") props.push({
 			name,
 			type: p.value.name,
 			required: false,
 			default: void 0,
-			description
+			description: jsdoc.description,
+			...tagFields
 		});
 		else if (p.value.type === "ArrayExpression") {
 			const types = p.value.elements.filter((el) => el?.type === "Identifier").map((el) => el.name);
@@ -124,7 +203,8 @@ function extractProps(obj, source) {
 				type: types.join(" | "),
 				required: false,
 				default: void 0,
-				description
+				description: jsdoc.description,
+				...tagFields
 			});
 		} else if (p.value.type === "ObjectExpression") {
 			let type = "unknown";
@@ -144,7 +224,8 @@ function extractProps(obj, source) {
 				type,
 				required,
 				default: defaultVal,
-				description
+				description: jsdoc.description,
+				...tagFields
 			});
 		}
 	}
@@ -171,14 +252,188 @@ function parseEmitJSDoc(comments) {
 	}
 	return map;
 }
-function extractJSDoc(comments) {
-	for (let i = comments.length - 1; i >= 0; i--) {
-		const c = comments[i];
-		if (c.type !== "CommentBlock") continue;
-		const lines = c.value.split("\n").map((l) => l.replace(/^\s*\*\s?/, "").trim()).filter((l) => l && !l.startsWith("@") && !l.startsWith("/"));
-		if (lines.length > 0) return lines.join(" ");
+function extractTypeEmits(typeLiteral) {
+	const emits = [];
+	for (const member of typeLiteral.members) if (member.type === "TSPropertySignature") {
+		const name = member.key.type === "Identifier" ? member.key.name : member.key.type === "StringLiteral" ? member.key.value : "";
+		if (!name) continue;
+		const jsdoc = parseJSDocTags(member.leadingComments ?? []);
+		let payload;
+		const typeAnnotation = member.typeAnnotation?.typeAnnotation;
+		if (typeAnnotation?.type === "TSTupleType") payload = typeAnnotation.elementTypes.map((el) => {
+			if (el.type === "TSNamedTupleMember") return `${el.label?.name ?? "arg"}: ${resolveTypeString(el.elementType)}`;
+			return resolveTypeString(el);
+		}).join(", ");
+		emits.push({
+			name,
+			description: jsdoc.description,
+			...payload && { payload }
+		});
+	} else if (member.type === "TSCallSignatureDeclaration") {
+		const params = member.parameters ?? [];
+		if (params.length === 0) continue;
+		const firstParam = params[0];
+		if (firstParam?.typeAnnotation?.typeAnnotation?.type !== "TSLiteralType" || firstParam.typeAnnotation.typeAnnotation.literal.type !== "StringLiteral") continue;
+		const name = firstParam.typeAnnotation.typeAnnotation.literal.value;
+		const jsdoc = parseJSDocTags(member.leadingComments ?? []);
+		const payloadParams = params.slice(1);
+		let payload;
+		if (payloadParams.length > 0) payload = payloadParams.map((p) => {
+			return `${p.type === "Identifier" ? p.name : "arg"}: ${p.typeAnnotation?.typeAnnotation ? resolveTypeString(p.typeAnnotation.typeAnnotation) : "unknown"}`;
+		}).join(", ");
+		emits.push({
+			name,
+			description: jsdoc.description,
+			...payload && { payload }
+		});
+	}
+	return emits;
+}
+function extractTypeSlots(typeLiteral) {
+	const slots = [];
+	for (const member of typeLiteral.members) {
+		const name = member.key?.type === "Identifier" ? member.key.name : member.key?.type === "StringLiteral" ? member.key.value : "";
+		if (!name) continue;
+		const jsdoc = parseJSDocTags(member.leadingComments ?? []);
+		const bindings = [];
+		if (member.type === "TSMethodSignature" && member.parameters?.length > 0) {
+			const propsType = member.parameters[0]?.typeAnnotation?.typeAnnotation;
+			if (propsType?.type === "TSTypeLiteral") {
+				for (const prop of propsType.members) if (prop.type === "TSPropertySignature") {
+					const propName = prop.key.type === "Identifier" ? prop.key.name : prop.key.type === "StringLiteral" ? prop.key.value : "";
+					const propType = prop.typeAnnotation?.typeAnnotation ? resolveTypeString(prop.typeAnnotation.typeAnnotation) : "unknown";
+					if (propName) bindings.push(`${propName}: ${propType}`);
+				}
+			}
+		}
+		slots.push({
+			name,
+			description: jsdoc.description,
+			bindings
+		});
+	}
+	return slots;
+}
+function extractExposes(obj, _source) {
+	const exposes = [];
+	for (const prop of obj.properties) {
+		if (prop.type !== "ObjectProperty" && prop.type !== "ObjectMethod") continue;
+		const key = prop.key;
+		const name = key.type === "Identifier" ? key.name : key.type === "StringLiteral" ? key.value : "";
+		if (!name) continue;
+		const jsdoc = parseJSDocTags(prop.leadingComments ?? []);
+		exposes.push({
+			name,
+			type: "unknown",
+			description: jsdoc.description
+		});
+	}
+	return exposes;
+}
+function extractComposables(ast) {
+	const seen = /* @__PURE__ */ new Set();
+	const composables = [];
+	for (const stmt of ast) {
+		const callNames = extractComposableCallNames(stmt);
+		for (const name of callNames) if (!seen.has(name)) {
+			seen.add(name);
+			composables.push({ name });
+		}
 	}
-	return "";
+	return composables;
+}
+function extractComposableCallNames(stmt) {
+	const names = [];
+	if (stmt.type === "ExpressionStatement" && stmt.expression.type === "CallExpression" && stmt.expression.callee.type === "Identifier" && /^use[A-Z]/.test(stmt.expression.callee.name)) names.push(stmt.expression.callee.name);
+	if (stmt.type === "VariableDeclaration") {
+		for (const decl of stmt.declarations) if (decl.init?.type === "CallExpression" && decl.init.callee.type === "Identifier" && /^use[A-Z]/.test(decl.init.callee.name)) names.push(decl.init.callee.name);
+	}
+	return names;
+}
+function extractTemplateSlots(templateAst) {
+	const slots = [];
+	walkTemplate(templateAst.children ?? [], slots);
+	return slots;
+}
+function walkTemplate(children, slots) {
+	for (const node of children) {
+		if (node.type === 1 && node.tag === "slot") {
+			let name = "default";
+			const bindings = [];
+			for (const prop of node.props ?? []) {
+				if (prop.type === 6 && prop.name === "name" && prop.value?.content) name = prop.value.content;
+				if (prop.type === 7 && prop.name === "bind" && prop.arg?.content) bindings.push(prop.arg.content);
+			}
+			slots.push({
+				name,
+				description: "",
+				bindings
+			});
+		}
+		if (node.children) walkTemplate(node.children, slots);
+		if (node.branches) {
+			for (const branch of node.branches) if (branch.children) walkTemplate(branch.children, slots);
+		}
+	}
+}
+function mergeSlots(typedSlots, templateSlots) {
+	const merged = [...typedSlots];
+	const typedNames = new Set(typedSlots.map((s) => s.name));
+	for (const ts of templateSlots) if (!typedNames.has(ts.name)) merged.push(ts);
+	return merged;
+}
+function extractOptionsAPI(ast, source) {
+	let props = [];
+	let emits = [];
+	for (const stmt of ast) {
+		if (stmt.type !== "ExportDefaultDeclaration") continue;
+		const decl = stmt.declaration;
+		if (decl.type !== "ObjectExpression") continue;
+		for (const prop of decl.properties) {
+			if (prop.type !== "ObjectProperty") continue;
+			const key = prop.key;
+			const name = key.type === "Identifier" ? key.name : "";
+			if (name === "props") {
+				if (prop.value.type === "ObjectExpression") props = extractProps(prop.value, source);
+				else if (prop.value.type === "ArrayExpression") props = extractArrayProps(prop.value);
+			} else if (name === "emits") {
+				if (prop.value.type === "ArrayExpression") {
+					const comments = stmt.leadingComments ?? [];
+					emits = extractEmits(prop.value, comments);
+				} else if (prop.value.type === "ObjectExpression") emits = extractObjectEmits(prop.value);
+			}
+		}
+		break;
+	}
+	return {
+		props,
+		emits
+	};
+}
+function extractArrayProps(arr) {
+	const props = [];
+	for (const el of arr.elements) if (el?.type === "StringLiteral") props.push({
+		name: el.value,
+		type: "unknown",
+		required: false,
+		default: void 0,
+		description: ""
+	});
+	return props;
+}
+function extractObjectEmits(obj) {
+	const emits = [];
+	for (const prop of obj.properties) {
+		if (prop.type !== "ObjectProperty") continue;
+		const name = prop.key.type === "Identifier" ? prop.key.name : prop.key.type === "StringLiteral" ? prop.key.value : "";
+		if (!name) continue;
+		const jsdoc = parseJSDocTags(prop.leadingComments ?? []);
+		emits.push({
+			name,
+			description: jsdoc.description
+		});
+	}
+	return emits;
 }
 function stringifyDefault(node, source) {
 	switch (node.type) {
@@ -197,22 +452,46 @@ function stringifyDefault(node, source) {
 //#region src/markdown.ts
 function generateMarkdown(doc) {
 	const sections = [`# ${doc.name}`];
-	if (doc.props.length === 0 && doc.emits.length === 0) {
-		sections.push("", "No documentable props or emits found.");
+	if (doc.description) sections.push("", doc.description);
+	const hasProps = doc.props.length > 0;
+	const hasEmits = doc.emits.length > 0;
+	const hasSlots = (doc.slots?.length ?? 0) > 0;
+	const hasExposes = (doc.exposes?.length ?? 0) > 0;
+	const hasComposables = (doc.composables?.length ?? 0) > 0;
+	if (!hasProps && !hasEmits && !hasSlots && !hasExposes && !hasComposables) {
+		sections.push("", "No documentable API found.");
 		return sections.join("\n") + "\n";
 	}
-	if (doc.props.length > 0) {
+	if (hasProps) {
 		sections.push("", "## Props", "");
 		sections.push("| Name | Type | Required | Default | Description |");
 		sections.push("| --- | --- | --- | --- | --- |");
+		const examples = [];
 		for (const p of doc.props) {
 			const def = p.default !== void 0 ? `\`${p.default}\`` : "-";
-			const desc = p.description || "-";
+			let desc = p.description || "-";
+			if (p.deprecated) desc += typeof p.deprecated === "string" && p.deprecated ? ` **Deprecated**: ${p.deprecated}` : " **Deprecated**";
+			if (p.since) desc += ` *(since ${p.since})*`;
+			if (p.see) desc += ` See: ${p.see}`;
 			const req = p.required ? "Yes" : "No";
 			sections.push(`| ${p.name} | ${p.type} | ${req} | ${def} | ${desc} |`);
+			if (p.example) examples.push({
+				name: p.name,
+				example: p.example
+			});
 		}
+		for (const { name, example } of examples) sections.push("", `**\`${name}\` example:**`, "", "```", example, "```");
 	}
-	if (doc.emits.length > 0) {
+	if (hasEmits) if (doc.emits.some((e) => e.payload)) {
+		sections.push("", "## Emits", "");
+		sections.push("| Name | Payload | Description |");
+		sections.push("| --- | --- | --- |");
+		for (const e of doc.emits) {
+			const desc = e.description || "-";
+			const payload = e.payload || "-";
+			sections.push(`| ${e.name} | ${payload} | ${desc} |`);
+		}
+	} else {
 		sections.push("", "## Emits", "");
 		sections.push("| Name | Description |");
 		sections.push("| --- | --- |");
@@ -221,6 +500,29 @@ function generateMarkdown(doc) {
 			sections.push(`| ${e.name} | ${desc} |`);
 		}
 	}
+	if (hasSlots) {
+		sections.push("", "## Slots", "");
+		sections.push("| Name | Bindings | Description |");
+		sections.push("| --- | --- | --- |");
+		for (const s of doc.slots) {
+			const desc = s.description || "-";
+			const bindings = s.bindings.length > 0 ? s.bindings.join(", ") : "-";
+			sections.push(`| ${s.name} | ${bindings} | ${desc} |`);
+		}
+	}
+	if (hasExposes) {
+		sections.push("", "## Exposed", "");
+		sections.push("| Name | Type | Description |");
+		sections.push("| --- | --- | --- |");
+		for (const e of doc.exposes) {
+			const desc = e.description || "-";
+			sections.push(`| ${e.name} | ${e.type} | ${desc} |`);
+		}
+	}
+	if (hasComposables) {
+		sections.push("", "## Composables Used", "");
+		for (const c of doc.composables) sections.push(`- \`${c.name}\``);
+	}
 	return sections.join("\n") + "\n";
 }
 //#endregion

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "compmark-vue",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Auto-generate Markdown documentation from Vue 3 SFCs",
   "license": "MIT",
   "repository": "noopurphalak/compmark-vue",
   "bin": {
-    "compmark-vue": "./dist/cli.mjs"
+    "compmark": "./dist/cli.mjs"
   },
   "files": [
     "dist"
@@ -24,7 +24,8 @@
     "prepack": "pnpm build",
     "release": "pnpm test && pnpm build && changelogen --release && npm publish && git push --follow-tags",
     "test": "pnpm lint && pnpm typecheck && vitest run --coverage",
-    "typecheck": "tsgo --noEmit --skipLibCheck"
+    "typecheck": "tsgo --noEmit --skipLibCheck",
+    "prepare": "husky"
   },
   "dependencies": {
     "@vue/compiler-sfc": "^3.5.0"
@@ -36,11 +37,19 @@
     "@vitest/coverage-v8": "latest",
     "automd": "latest",
     "changelogen": "latest",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.3.3",
     "obuild": "latest",
     "oxfmt": "latest",
     "oxlint": "latest",
     "typescript": "latest",
     "vitest": "latest"
   },
+  "lint-staged": {
+    "*.{ts,vue}": [
+      "oxlint --fix",
+      "oxfmt"
+    ]
+  },
   "packageManager": "pnpm@10.29.3"
 }