Merge pull request #13 from ghostdevv/ghostdevv/parse-the-component-comment-7

Author: ghostdevv

.changeset/honest-avocados-collect.md

@@ -0,0 +1,5 @@
+---
+'extractinator': minor
+---
+
+feat: parse the component comment

README.md

@@ -101,6 +101,10 @@ Output:
 {
   "fileName": "KitchenSink.svelte",
   "filePath": "/workspace/extractinator/playground/KitchenSink.svelte",
+  "comment": {
+    "raw": "/**\n * Kitchen Sink Svelte Component\n */\n",
+    "summary": "Kitchen Sink Svelte Component"
+  },
   "componentName": "KitchenSink",
   "props": [
     {

src/files/svelte.ts

@@ -27,9 +27,14 @@ export function parseSvelteFile({
 	//? Extract the export bits
 	const exports = extractModuleExports(componentName, file, tsdoc)
 
+	const component_class_node = file.getDefaultExportSymbol()?.getValueDeclaration()
+
 	return {
 		fileName: file_name,
 		filePath: input_file_path,
+		comment: component_class_node
+			? parseCommentFromNode(component_class_node, tsdoc)
+			: undefined,
 		componentName,
 		props,
 		events,

src/types.d.ts

@@ -47,6 +47,17 @@ export interface ParsedSvelteFile extends BaseParsedFile {
 	 */
 	componentName: string
 
+	/**
+	 * The top level component comment
+	 *
+	 * @example
+	 * <!--
+	 *	 @component
+	 *   Kitchen Sink Svelte Component
+	 * -->
+	 */
+	comment?: TSDocComment
+
 	/**
 	 * The props of the component
 	 *