feat: description and default

Author: jer3m01

src/index.ts

@@ -5,8 +5,9 @@ import {
 	type ParameterDeclaration,
 	Project,
 	type SourceFile,
-	SyntaxKind,
-	Type,
+	type TextRange,
+	VariableDeclaration,
+	VariableStatement,
 	ts,
 } from "ts-morph";
 import { parseProps } from "./props";
@@ -15,6 +16,7 @@ import type { Documentation } from "./types";
 type Component = {
 	getName: () => string;
 	getParameters: () => ParameterDeclaration[];
+	getDescription: () => string | undefined;
 };
 
 function getProject() {
@@ -40,37 +42,59 @@ export function parse(code: string): Documentation[] {
 	const project = getProject();
 	const sourceFile = project.createSourceFile("input.tsx", code);
 
-	return getExportedComponents(sourceFile).map((f) => {
+	return getExportedComponents(sourceFile).map((c) => {
 		return {
-			displayName: f.getName(),
-			props: parseProps(project, f.getParameters()),
+			displayName: c.getName(),
+			props: parseProps(project, c.getParameters()),
+			description: c.getDescription(),
 		};
 	});
 }
 
 function getExportedComponents(sourceFile: SourceFile): Component[] {
-	const exportedFunctions = sourceFile
-		.getFunctions()
-		.filter((f) => f.isExported())
-		.map((f) => wrapWithName(f, f.getName() ?? ""));
+	const components: Component[] = [];
 
-	const exportedVariables = sourceFile
-		.getVariableDeclarations()
-		.filter((v) => v.isExported() && Node.isArrowFunction(v.getInitializer()))
-		.map((v) =>
-			wrapWithName(v.getInitializer() as ArrowFunction, v.getName()!),
-		);
+	for (const [name, value] of sourceFile.getExportedDeclarations().entries()) {
+		if (Node.isFunctionDeclaration(value[0])) {
+			components.push(
+				toComponent(
+					value[0],
+					name,
+					value[0].getJsDocs()[0]?.getDescription().trim(),
+				),
+			);
+		}
 
-	return [...exportedFunctions, ...exportedVariables];
+		if (Node.isVariableDeclaration(value[0])) {
+			const initializer = value[0].getInitializer();
+			if (Node.isArrowFunction(initializer)) {
+				components.push(
+					toComponent(
+						initializer,
+						name,
+						value[0]
+							.getVariableStatement()
+							?.getJsDocs()[0]
+							?.getDescription()
+							.trim(),
+					),
+				);
+			}
+		}
+	}
+
+	return components;
 }
 
-function wrapWithName(
+function toComponent(
 	f: ArrowFunction | FunctionDeclaration,
 	name: string,
+	description?: string,
 ): Component {
-	const wrapped = f as Component;
+	const wrapped = f as unknown as Component;
 
 	wrapped.getName = () => name;
+	wrapped.getDescription = () => description;
 
 	return wrapped;
 }

src/props.ts

@@ -1,9 +1,7 @@
 import {
 	type ParameterDeclaration,
 	type Project,
-	type Symbol as TsSymbol,
 	type Type,
-	printNode,
 	ts,
 } from "ts-morph";
 import type {
@@ -12,7 +10,6 @@ import type {
 	NullType,
 	ObjectType,
 	PropDescriptor,
-	SimpleType,
 	TypeDescriptor,
 	UndefinedType,
 	UnionType,
@@ -38,6 +35,7 @@ export function parseProps(
 			const description = prop.compilerSymbol.getDocumentationComment(
 				project.getTypeChecker().compilerObject,
 			);
+			const jsDocTags = prop.getJsDocTags();
 			const required = !prop.isOptional();
 
 			props[name] = {
@@ -48,6 +46,30 @@ export function parseProps(
 			if (description && ts.displayPartsToString(description).trim() !== "") {
 				props[name].description = ts.displayPartsToString(description);
 			}
+
+			const descriptionTag =
+				jsDocTags.find((t) => t.getName() === "description") ??
+				jsDocTags.find((t) => t.getName() === "desc");
+			if (
+				descriptionTag &&
+				ts.displayPartsToString(descriptionTag.getText()).trim() !== ""
+			) {
+				props[name].description = ts.displayPartsToString(
+					descriptionTag.getText(),
+				);
+			}
+
+			const defaultValue =
+				jsDocTags.find((t) => t.getName() === "default") ??
+				jsDocTags.find((t) => t.getName() === "defaultvalue");
+			if (
+				defaultValue &&
+				ts.displayPartsToString(defaultValue.getText()).trim() !== ""
+			) {
+				props[name].defaultValue = parseRawValue(
+					ts.displayPartsToString(defaultValue.getText()),
+				);
+			}
 		}
 	}
 
@@ -133,3 +155,37 @@ function parseType(type: Type<ts.Type>): TypeDescriptor {
 		raw: type.getText(),
 	};
 }
+
+function parseRawValue(value: string): TypeDescriptor;
+function parseRawValue(value: unknown, parse: false): TypeDescriptor;
+function parseRawValue(value: unknown | string, parse = true): TypeDescriptor {
+	const parsed = parse ? JSON.parse(value as string) : value;
+
+	if (
+		typeof parsed === "string" ||
+		typeof parsed === "number" ||
+		typeof parsed === "boolean"
+	) {
+		return {
+			name: "literal",
+			value: parsed,
+		} as LiteralType;
+	}
+
+	if (typeof parsed === "object" && parsed !== null) {
+		return {
+			name: "object",
+			properties: Object.fromEntries(
+				Object.entries(parsed).map(([key, value]) => [
+					key,
+					parseRawValue(value, false),
+				]),
+			),
+		} as ObjectType;
+	}
+
+	return {
+		name: "unknown",
+		raw: !parse ? JSON.stringify(value) : (value as string),
+	};
+}

tests/combined/export-multiple/output.json

@@ -8,23 +8,23 @@
 		"props": {}
 	},
 	{
-		"displayName": "MyComp4",
+		"displayName": "MyComp3",
 		"props": {}
 	},
 	{
-		"displayName": "MyComp7",
+		"displayName": "MyComp4",
 		"props": {}
 	},
 	{
-		"displayName": "MyComp3",
+		"displayName": "MyComp5",
 		"props": {}
 	},
 	{
-		"displayName": "MyComp5",
+		"displayName": "MyComp6",
 		"props": {}
 	},
 	{
-		"displayName": "MyComp6",
+		"displayName": "MyComp7",
 		"props": {}
 	}
 ]

tests/individual/component-const-description/input.tsx

@@ -0,0 +1,6 @@
+/**
+ * My component
+ */
+export const MyComp = () => {
+	return <></>;
+};

tests/individual/component-const-description/output.json

@@ -0,0 +1,7 @@
+[
+	{
+		"displayName": "MyComp",
+		"props": {},
+		"description": "My component"
+	}
+]

tests/individual/component-function-description/input.tsx

@@ -0,0 +1,6 @@
+/**
+ * My component
+ */
+export function MyComp() {
+	return <></>;
+}

tests/individual/component-function-description/output.json

@@ -0,0 +1,7 @@
+[
+	{
+		"displayName": "MyComp",
+		"props": {},
+		"description": "My component"
+	}
+]

tests/individual/interface-props-type-default-alias/input.tsx

@@ -0,0 +1,12 @@
+interface Props {
+	/**
+	 * My prop
+	 *
+	 * @defaultvalue "Hello"
+	 */
+	myProp: string;
+}
+
+export function MyComp(props: Props) {
+	return <></>;
+}

tests/individual/interface-props-type-default-alias/output.json

@@ -0,0 +1,19 @@
+[
+	{
+		"displayName": "MyComp",
+		"props": {
+			"myProp": {
+				"type": {
+					"name": "unknown",
+					"raw": "string"
+				},
+				"required": true,
+				"description": "My prop",
+				"defaultValue": {
+					"name": "literal",
+					"value": "Hello"
+				}
+			}
+		}
+	}
+]

tests/individual/interface-props-type-default/input.tsx

@@ -0,0 +1,12 @@
+interface Props {
+	/**
+	 * My prop
+	 *
+	 * @default "Hello"
+	 */
+	myProp: string;
+}
+
+export function MyComp(props: Props) {
+	return <></>;
+}