vue-component-meta 0.39.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present Johnson Chu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# vue-component-meta
+
+## Usage
+
+See https://github.com/johnsoncodehk/volar/blob/master/packages/vue-component-meta/tests/index.spec.ts.
+
+## Sponsors
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/johnsoncodehk/sponsors/company/sponsors.svg">
+    <img src="https://cdn.jsdelivr.net/gh/johnsoncodehk/sponsors/company/sponsors.svg"/>
+  </a>
+</p>
+
+---
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/johnsoncodehk/sponsors/sponsors.svg">
+    <img src="https://cdn.jsdelivr.net/gh/johnsoncodehk/sponsors/sponsors.svg"/>
+  </a>
+</p>

package/out/index.d.ts

@@ -0,0 +1,25 @@
+export declare function createComponentMetaChecker(tsconfigPath: string): {
+    getComponentMeta: (componentPath: string) => {
+        props: {
+            name: string;
+            isOptional: boolean;
+            type: string;
+            documentationComment: string;
+        }[];
+        events: {
+            name: any;
+            parametersType: string;
+            parameters: {
+                name: string;
+                type: string;
+                isOptional: string;
+            }[];
+            documentationComment: string;
+        }[];
+        slots: {
+            name: string;
+            propsType: string;
+            documentationComment: string;
+        }[];
+    };
+};

package/out/index.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createComponentMetaChecker = void 0;
+const vue = require("@volar/vue-language-core");
+const ts = require("typescript/lib/tsserverlibrary");
+function createComponentMetaChecker(tsconfigPath) {
+    const parsedCommandLine = vue.tsShared.createParsedCommandLine(ts, {
+        useCaseSensitiveFileNames: ts.sys.useCaseSensitiveFileNames,
+        readDirectory: (path, extensions, exclude, include, depth) => {
+            return ts.sys.readDirectory(path, [...extensions, '.vue'], exclude, include, depth);
+        },
+        fileExists: ts.sys.fileExists,
+        readFile: ts.sys.readFile,
+    }, tsconfigPath);
+    const scriptSnapshot = {};
+    const core = vue.createLanguageContext(Object.assign(Object.assign({}, ts.sys), { getDefaultLibFileName: (options) => ts.getDefaultLibFilePath(options), useCaseSensitiveFileNames: () => ts.sys.useCaseSensitiveFileNames, getCompilationSettings: () => parsedCommandLine.options, getScriptFileNames: () => {
+            const result = [...parsedCommandLine.fileNames];
+            for (const fileName of parsedCommandLine.fileNames) {
+                if (fileName.endsWith('.vue')) {
+                    result.push(fileName + '.meta.ts');
+                }
+            }
+            return result;
+        }, getProjectReferences: () => parsedCommandLine.projectReferences, getScriptVersion: (fileName) => '0', getScriptSnapshot: (fileName) => {
+            if (!scriptSnapshot[fileName]) {
+                const fileText = fileName.endsWith('.meta.ts') ? getMetaScriptContent(fileName) : ts.sys.readFile(fileName);
+                if (fileText !== undefined) {
+                    scriptSnapshot[fileName] = ts.ScriptSnapshot.fromString(fileText);
+                }
+            }
+            return scriptSnapshot[fileName];
+        }, getTypeScriptModule: () => ts, getVueCompilationSettings: () => parsedCommandLine.vueOptions }));
+    const tsLs = ts.createLanguageService(core.typescriptLanguageServiceHost);
+    const program = tsLs.getProgram();
+    const typeChecker = program.getTypeChecker();
+    return {
+        getComponentMeta,
+    };
+    function getMetaScriptContent(fileName) {
+        return `
+			import Component from '${fileName.substring(0, fileName.length - '.meta.ts'.length)}';
+			export default new Component();
+		`;
+    }
+    function getComponentMeta(componentPath) {
+        var _a;
+        const sourceFile = program === null || program === void 0 ? void 0 : program.getSourceFile(componentPath + '.meta.ts');
+        if (!sourceFile) {
+            throw 'Could not find main source file';
+        }
+        const moduleSymbol = typeChecker.getSymbolAtLocation(sourceFile);
+        if (!moduleSymbol) {
+            throw 'Could not find module symbol';
+        }
+        const exportedSymbols = typeChecker.getExportsOfModule(moduleSymbol);
+        let symbolNode;
+        for (const symbol of exportedSymbols) {
+            const [declaration] = (_a = symbol.getDeclarations()) !== null && _a !== void 0 ? _a : [];
+            if (ts.isExportAssignment(declaration)) {
+                symbolNode = declaration.expression;
+            }
+        }
+        if (!symbolNode) {
+            throw 'Could not find symbol node';
+        }
+        const symbolType = typeChecker.getTypeAtLocation(symbolNode);
+        const symbolProperties = symbolType.getProperties();
+        return {
+            props: getProps(),
+            events: getEvents(),
+            slots: getSlots(),
+        };
+        function getProps() {
+            const $props = symbolProperties.find(prop => prop.escapedName === '$props');
+            if ($props) {
+                const type = typeChecker.getTypeOfSymbolAtLocation($props, symbolNode);
+                const properties = type.getProperties();
+                return properties.map(prop => {
+                    var _a, _b;
+                    return ({
+                        name: prop.escapedName,
+                        // @ts-ignore
+                        isOptional: !!((_b = (_a = prop.declarations) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.questionToken),
+                        type: typeChecker.typeToString(typeChecker.getTypeOfSymbolAtLocation(prop, symbolNode)),
+                        documentationComment: ts.displayPartsToString(prop.getDocumentationComment(typeChecker)),
+                    });
+                });
+            }
+            return [];
+        }
+        function getEvents() {
+            const $emit = symbolProperties.find(prop => prop.escapedName === '$emit');
+            if ($emit) {
+                const type = typeChecker.getTypeOfSymbolAtLocation($emit, symbolNode);
+                const calls = type.getCallSignatures();
+                return calls.map(call => ({
+                    // @ts-ignore
+                    name: typeChecker.getTypeOfSymbolAtLocation(call.parameters[0], symbolNode).value,
+                    parametersType: typeChecker.typeToString(typeChecker.getTypeOfSymbolAtLocation(call.parameters[1], symbolNode)),
+                    // @ts-ignore
+                    parameters: typeChecker.getTypeArguments(typeChecker.getTypeOfSymbolAtLocation(call.parameters[1], symbolNode)).map(arg => ({
+                        name: 'TODO',
+                        type: typeChecker.typeToString(arg),
+                        isOptional: 'TODO',
+                    })),
+                    documentationComment: ts.displayPartsToString(call.getDocumentationComment(typeChecker)),
+                }));
+            }
+            return [];
+        }
+        function getSlots() {
+            var _a;
+            const propertyName = ((_a = parsedCommandLine.vueOptions.target) !== null && _a !== void 0 ? _a : 3) < 3 ? '$scopedSlots' : '$slots';
+            const $slots = symbolProperties.find(prop => prop.escapedName === propertyName);
+            if ($slots) {
+                const type = typeChecker.getTypeOfSymbolAtLocation($slots, symbolNode);
+                const properties = type.getProperties();
+                return properties.map(prop => ({
+                    name: prop.escapedName,
+                    propsType: typeChecker.typeToString(typeChecker.getTypeOfSymbolAtLocation(typeChecker.getTypeOfSymbolAtLocation(prop, symbolNode).getCallSignatures()[0].parameters[0], symbolNode)),
+                    // props: {}, // TODO
+                    documentationComment: ts.displayPartsToString(prop.getDocumentationComment(typeChecker)),
+                }));
+            }
+            return [];
+        }
+    }
+}
+exports.createComponentMetaChecker = createComponentMetaChecker;
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,21 @@
+{
+	"name": "vue-component-meta",
+	"version": "0.39.0",
+	"main": "out/index.js",
+	"license": "MIT",
+	"files": [
+		"out/**/*.js",
+		"out/**/*.d.ts"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/johnsoncodehk/volar.git",
+		"directory": "packages/vue-component-meta"
+	},
+	"dependencies": {
+		"@volar/vue-language-core": "0.39.0"
+	},
+	"peerDependencies": {
+		"typescript": "*"
+	}
+}