vue-component-meta 3.1.5 → 3.1.7

package/README.md

@@ -42,6 +42,29 @@ const meta = checker.getComponentMeta(componentPath);
 
 This meta contains really useful stuff like component props, slots, events and more. You can refer to its [type definition](https://github.com/vuejs/language-tools/blob/master/packages/component-meta/lib/types.ts) for more details.
 
+### Extracting component name and description
+
+The component meta also includes `name` and `description` fields at the root level:
+
+- **`name`**: Extracted from the `name` property in the component options (for Options API components)
+- **`description`**: Extracted from JSDoc comments above the component export (for TypeScript/JavaScript files)
+
+```ts
+/**
+ * My awesome component description
+ */
+export default defineComponent({
+  name: 'MyComponent',
+  // ... component definition
+})
+```
+
+When you extract the component meta, you'll get:
+```ts
+meta.name // 'MyComponent'
+meta.description // 'My awesome component description'
+```
+
 ### Extracting prop meta
 
 `vue-component-meta` will automatically extract the prop details like its name, default value, is required or not, etc. Additionally, you can even write prop description in source code via [JSDoc](https://jsdoc.app/) comment for that prop.

package/index.d.ts

@@ -8,6 +8,7 @@ export declare function createCheckerByJson(rootPath: string, json: any, checker
     deleteFile(fileName: string): void;
     reload(): void;
     clearCache(): void;
+    getProgram(): ts.Program | undefined;
     __internal__: {
         tsLs: ts.LanguageService;
     };
@@ -19,6 +20,7 @@ export declare function createChecker(tsconfig: string, checkerOptions?: MetaChe
     deleteFile(fileName: string): void;
     reload(): void;
     clearCache(): void;
+    getProgram(): ts.Program | undefined;
     __internal__: {
         tsLs: ts.LanguageService;
     };

package/lib/base.d.ts

@@ -8,6 +8,10 @@ export declare function createCheckerByJsonConfigBase(ts: typeof import('typescr
     deleteFile(fileName: string): void;
     reload(): void;
     clearCache(): void;
+    getProgram(): ts.Program | undefined;
+    /**
+     * @deprecated use `getProgram()` instead
+     */
     __internal__: {
         tsLs: ts.LanguageService;
     };
@@ -19,6 +23,10 @@ export declare function createCheckerBase(ts: typeof import('typescript'), tscon
     deleteFile(fileName: string): void;
     reload(): void;
     clearCache(): void;
+    getProgram(): ts.Program | undefined;
+    /**
+     * @deprecated use `getProgram()` instead
+     */
     __internal__: {
         tsLs: ts.LanguageService;
     };

package/lib/base.js

@@ -21,6 +21,49 @@ const core = require("@vue/language-core");
 const path_browserify_1 = require("path-browserify");
 __exportStar(require("./types"), exports);
 const windowsPathReg = /\\/g;
+// Utility function to get the component node from an AST
+function getComponentNodeFromAst(ast, exportName, ts) {
+    let result;
+    if (exportName === 'default') {
+        ast.forEachChild(child => {
+            if (ts.isExportAssignment(child)) {
+                result = child.expression;
+            }
+        });
+    }
+    else {
+        ast.forEachChild(child => {
+            if (ts.isVariableStatement(child)
+                && child.modifiers?.some(mod => mod.kind === ts.SyntaxKind.ExportKeyword)) {
+                for (const dec of child.declarationList.declarations) {
+                    if (dec.name.getText(ast) === exportName) {
+                        result = dec.initializer;
+                    }
+                }
+            }
+        });
+    }
+    return result;
+}
+// Utility function to get the component options node from a component node
+function getComponentOptionsNodeFromComponent(component, ts) {
+    if (component) {
+        // export default { ... }
+        if (ts.isObjectLiteralExpression(component)) {
+            return component;
+        }
+        // export default defineComponent({ ... })
+        else if (ts.isCallExpression(component)) {
+            if (component.arguments.length) {
+                const arg = component.arguments[0];
+                if (ts.isObjectLiteralExpression(arg)) {
+                    return arg;
+                }
+            }
+        }
+    }
+    return undefined;
+}
 function createCheckerByJsonConfigBase(ts, rootDir, json, checkerOptions = {}) {
     rootDir = rootDir.replace(windowsPathReg, '/');
     return baseCreate(ts, () => {
@@ -156,6 +199,12 @@ function baseCreate(ts, getConfigAndFiles, checkerOptions, rootPath, globalCompo
             scriptSnapshots.clear();
             projectVersion++;
         },
+        getProgram() {
+            return tsLs.getProgram();
+        },
+        /**
+         * @deprecated use `getProgram()` instead
+         */
         __internal__: {
             tsLs,
         },
@@ -210,7 +259,15 @@ interface ComponentMeta<T> {
         let _events;
         let _slots;
         let _exposed;
+        let _name;
+        let _description;
         const meta = {
+            get name() {
+                return _name ?? (_name = getName());
+            },
+            get description() {
+                return _description ?? (_description = getDescription());
+            },
             get type() {
                 return _type ?? (_type = getType());
             },
@@ -325,6 +382,34 @@ interface ComponentMeta<T> {
             }
             return [];
         }
+        function getName() {
+            // Try to get name from component options
+            const sourceScript = language.scripts.get(componentPath);
+            const { snapshot } = sourceScript;
+            const vueFile = sourceScript.generated?.root;
+            if (vueFile && exportName === 'default' && vueFile instanceof core.VueVirtualCode) {
+                // For Vue SFC, check the script section
+                const { sfc } = vueFile;
+                if (sfc.script) {
+                    const name = readComponentName(sfc.script.ast, exportName, ts);
+                    if (name) {
+                        return name;
+                    }
+                }
+            }
+            else if (!vueFile) {
+                // For TS/JS files
+                const ast = ts.createSourceFile('/tmp.' + componentPath.slice(componentPath.lastIndexOf('.') + 1), snapshot.getText(0, snapshot.getLength()), ts.ScriptTarget.Latest);
+                return readComponentName(ast, exportName, ts);
+            }
+            return undefined;
+        }
+        function getDescription() {
+            const sourceFile = program.getSourceFile(componentPath);
+            if (sourceFile) {
+                return readComponentDescription(sourceFile, exportName, ts, typeChecker);
+            }
+        }
     }
     function _getExports(program, typeChecker, componentPath) {
         const sourceFile = program.getSourceFile(getMetaFileName(componentPath));
@@ -397,13 +482,16 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
             })),
             required: !(prop.flags & ts.SymbolFlags.Optional),
             type: getFullyQualifiedName(subtype),
-            rawType: rawType ? subtype : undefined,
             get declarations() {
                 return declarations ??= getDeclarations(prop.declarations ?? []);
             },
             get schema() {
                 return schema ??= resolveSchema(subtype);
             },
+            rawType: rawType ? subtype : undefined,
+            getTypeObject() {
+                return subtype;
+            },
         };
     }
     function resolveSlotProperties(prop) {
@@ -416,7 +504,6 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
         return {
             name: prop.getName(),
             type: getFullyQualifiedName(subtype),
-            rawType: rawType ? subtype : undefined,
             description: ts.displayPartsToString(prop.getDocumentationComment(typeChecker)),
             get declarations() {
                 return declarations ??= getDeclarations(prop.declarations ?? []);
@@ -424,6 +511,10 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
             get schema() {
                 return schema ??= resolveSchema(subtype);
             },
+            rawType: rawType ? subtype : undefined,
+            getTypeObject() {
+                return subtype;
+            },
         };
     }
     function resolveExposedProperties(expose) {
@@ -433,7 +524,6 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
         return {
             name: expose.getName(),
             type: getFullyQualifiedName(subtype),
-            rawType: rawType ? subtype : undefined,
             description: ts.displayPartsToString(expose.getDocumentationComment(typeChecker)),
             get declarations() {
                 return declarations ??= getDeclarations(expose.declarations ?? []);
@@ -441,16 +531,22 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
             get schema() {
                 return schema ??= resolveSchema(subtype);
             },
+            rawType: rawType ? subtype : undefined,
+            getTypeObject() {
+                return subtype;
+            },
         };
     }
     function resolveEventSignature(call) {
         let schema;
         let declarations;
-        let subtype = undefined;
+        let subtype;
+        let symbol;
         let subtypeStr = '[]';
         let getSchema = () => [];
         if (call.parameters.length >= 2) {
-            subtype = typeChecker.getTypeOfSymbolAtLocation(call.parameters[1], symbolNode);
+            symbol = call.parameters[1];
+            subtype = typeChecker.getTypeOfSymbolAtLocation(symbol, symbolNode);
             if (call.parameters[1].valueDeclaration?.dotDotDotToken) {
                 subtypeStr = getFullyQualifiedName(subtype);
                 getSchema = () => typeChecker.getTypeArguments(subtype).map(resolveSchema);
@@ -479,7 +575,6 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
                 text: tag.text !== undefined ? ts.displayPartsToString(tag.text) : undefined,
             })),
             type: subtypeStr,
-            rawType: rawType ? subtype : undefined,
             signature: typeChecker.signatureToString(call),
             get declarations() {
                 return declarations ??= call.declaration ? getDeclarations([call.declaration]) : [];
@@ -487,6 +582,10 @@ function createSchemaResolvers(typeChecker, symbolNode, { rawType, schema: optio
             get schema() {
                 return schema ??= getSchema();
             },
+            rawType: rawType ? subtype : undefined,
+            getTypeObject() {
+                return subtype;
+            },
         };
     }
     function resolveCallbackSchema(signature) {
@@ -680,45 +779,11 @@ function readTsComponentDefaultProps(ast, exportName, printer, ts) {
     }
     return {};
     function getComponentNode() {
-        let result;
-        if (exportName === 'default') {
-            ast.forEachChild(child => {
-                if (ts.isExportAssignment(child)) {
-                    result = child.expression;
-                }
-            });
-        }
-        else {
-            ast.forEachChild(child => {
-                if (ts.isVariableStatement(child)
-                    && child.modifiers?.some(mod => mod.kind === ts.SyntaxKind.ExportKeyword)) {
-                    for (const dec of child.declarationList.declarations) {
-                        if (dec.name.getText(ast) === exportName) {
-                            result = dec.initializer;
-                        }
-                    }
-                }
-            });
-        }
-        return result;
+        return getComponentNodeFromAst(ast, exportName, ts);
     }
     function getComponentOptionsNode() {
         const component = getComponentNode();
-        if (component) {
-            // export default { ... }
-            if (ts.isObjectLiteralExpression(component)) {
-                return component;
-            }
-            // export default defineComponent({ ... })
-            else if (ts.isCallExpression(component)) {
-                if (component.arguments.length) {
-                    const arg = component.arguments[0];
-                    if (ts.isObjectLiteralExpression(arg)) {
-                        return arg;
-                    }
-                }
-            }
-        }
+        return getComponentOptionsNodeFromComponent(component, ts);
     }
     function getPropsNode() {
         const options = getComponentOptionsNode();
@@ -781,4 +846,61 @@ function resolveDefaultOptionExpression(_default, ts) {
     }
     return _default;
 }
+function readComponentName(ast, exportName, ts) {
+    const componentNode = getComponentNodeFromAst(ast, exportName, ts);
+    const optionsNode = getComponentOptionsNodeFromComponent(componentNode, ts);
+    if (optionsNode) {
+        const nameProp = optionsNode.properties.find(prop => ts.isPropertyAssignment(prop) && prop.name?.getText(ast) === 'name');
+        if (nameProp && ts.isPropertyAssignment(nameProp) && ts.isStringLiteral(nameProp.initializer)) {
+            return nameProp.initializer.text;
+        }
+    }
+    return undefined;
+}
+function readComponentDescription(ast, exportName, ts, typeChecker) {
+    const exportNode = getExportNode();
+    if (exportNode) {
+        // Try to get JSDoc comments from the node using TypeScript API
+        const jsDocComments = ts.getJSDocCommentsAndTags(exportNode);
+        for (const jsDoc of jsDocComments) {
+            if (ts.isJSDoc(jsDoc) && jsDoc.comment) {
+                // Handle both string and array of comment parts
+                if (typeof jsDoc.comment === 'string') {
+                    return jsDoc.comment;
+                }
+                else if (Array.isArray(jsDoc.comment)) {
+                    return jsDoc.comment.map(part => part.text || '').join('');
+                }
+            }
+        }
+        // Fallback to symbol documentation
+        const symbol = typeChecker.getSymbolAtLocation(exportNode);
+        if (symbol) {
+            const description = ts.displayPartsToString(symbol.getDocumentationComment(typeChecker));
+            return description || undefined;
+        }
+    }
+    return undefined;
+    function getExportNode() {
+        let result;
+        if (exportName === 'default') {
+            ast.forEachChild(child => {
+                if (ts.isExportAssignment(child)) {
+                    // Return the export assignment itself, not the expression
+                    result = child;
+                }
+            });
+        }
+        else {
+            ast.forEachChild(child => {
+                if (ts.isVariableStatement(child)
+                    && child.modifiers?.some(mod => mod.kind === ts.SyntaxKind.ExportKeyword)) {
+                    // Return the variable statement itself
+                    result = child;
+                }
+            });
+        }
+        return result;
+    }
+}
 //# sourceMappingURL=base.js.map

package/lib/types.d.ts

@@ -5,6 +5,8 @@ export interface Declaration {
     range: [number, number];
 }
 export interface ComponentMeta {
+    name?: string;
+    description?: string;
     type: TypeMeta;
     props: PropertyMeta[];
     events: EventMeta[];
@@ -23,19 +25,22 @@ export interface PropertyMeta {
     global: boolean;
     required: boolean;
     type: string;
-    rawType?: ts.Type;
     tags: {
         name: string;
         text?: string;
     }[];
     declarations: Declaration[];
     schema: PropertyMetaSchema;
+    /**
+     * @deprecated use `getTypeObject()` instead
+     */
+    rawType?: ts.Type;
+    getTypeObject(): ts.Type;
 }
 export interface EventMeta {
     name: string;
     description: string;
     type: string;
-    rawType?: ts.Type;
     signature: string;
     tags: {
         name: string;
@@ -43,22 +48,35 @@ export interface EventMeta {
     }[];
     declarations: Declaration[];
     schema: PropertyMetaSchema[];
+    /**
+     * @deprecated use `getTypeObject()` instead
+     */
+    rawType?: ts.Type;
+    getTypeObject(): ts.Type | undefined;
 }
 export interface SlotMeta {
     name: string;
     type: string;
-    rawType?: ts.Type;
     description: string;
     declarations: Declaration[];
     schema: PropertyMetaSchema;
+    /**
+     * @deprecated use `getTypeObject()` instead
+     */
+    rawType?: ts.Type;
+    getTypeObject(): ts.Type;
 }
 export interface ExposeMeta {
     name: string;
     description: string;
     type: string;
-    rawType?: ts.Type;
     declarations: Declaration[];
     schema: PropertyMetaSchema;
+    /**
+     * @deprecated use `getTypeObject()` instead
+     */
+    rawType?: ts.Type;
+    getTypeObject(): ts.Type;
 }
 export type PropertyMetaSchema = string | {
     kind: 'enum';
@@ -88,6 +106,9 @@ export interface MetaCheckerOptions {
     schema?: MetaCheckerSchemaOptions;
     forceUseTs?: boolean;
     printer?: ts.PrinterOptions;
-    rawType?: boolean;
     noDeclarations?: boolean;
+    /**
+     * @deprecated No longer needed, use `getTypeObject()` instead
+     */
+    rawType?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vue-component-meta",
-	"version": "3.1.5",
+	"version": "3.1.7",
 	"license": "MIT",
 	"files": [
 		"**/*.js",
@@ -13,10 +13,10 @@
 		"directory": "packages/component-meta"
 	},
 	"dependencies": {
-		"@volar/typescript": "2.4.23",
-		"@vue/language-core": "3.1.5",
+		"@volar/typescript": "2.4.26",
+		"@vue/language-core": "3.1.7",
 		"path-browserify": "^1.0.1",
-		"vue-component-type-helpers": "3.1.5"
+		"vue-component-type-helpers": "3.1.7"
 	},
 	"peerDependencies": {
 		"typescript": "*"
@@ -25,5 +25,5 @@
 		"@types/node": "^22.10.4",
 		"@types/path-browserify": "^1.0.1"
 	},
-	"gitHead": "d124a88fbf169e793c39ae4248da2092098de92d"
+	"gitHead": "20dcd47c0cb4ce30e2c5e3ef1986ce297c218a06"
 }

package/lib/helpers.d.ts

@@ -1 +0,0 @@
-export type * from 'vue-component-type-helpers';

package/lib/helpers.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=helpers.js.map