@vue/typescript-plugin 2.2.8 → 3.0.0-alpha.0

package/lib/requests/componentInfos.js

@@ -1,249 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getComponentProps = getComponentProps;
-exports.getComponentEvents = getComponentEvents;
-exports.getTemplateContextProps = getTemplateContextProps;
-exports.getComponentNames = getComponentNames;
-exports._getComponentNames = _getComponentNames;
-exports.getElementAttrs = getElementAttrs;
-const vue = require("@vue/language-core");
-const shared_1 = require("@vue/shared");
-function getComponentProps(fileName, tag) {
-    const { typescript: ts, language, languageService, getFileId } = this;
-    const volarFile = language.scripts.get(getFileId(fileName));
-    if (!(volarFile?.generated?.root instanceof vue.VueVirtualCode)) {
-        return;
-    }
-    const vueCode = volarFile.generated.root;
-    const program = languageService.getProgram();
-    const checker = program.getTypeChecker();
-    const components = getVariableType(ts, languageService, vueCode, '__VLS_components');
-    if (!components) {
-        return [];
-    }
-    const name = tag.split('.');
-    let componentSymbol = components.type.getProperty(name[0])
-        ?? components.type.getProperty((0, shared_1.camelize)(name[0]))
-        ?? components.type.getProperty((0, shared_1.capitalize)((0, shared_1.camelize)(name[0])));
-    if (!componentSymbol) {
-        return [];
-    }
-    let componentType = checker.getTypeOfSymbolAtLocation(componentSymbol, components.node);
-    for (let i = 1; i < name.length; i++) {
-        componentSymbol = componentType.getProperty(name[i]);
-        if (componentSymbol) {
-            componentType = checker.getTypeOfSymbolAtLocation(componentSymbol, components.node);
-        }
-        else {
-            return [];
-        }
-    }
-    const result = new Map();
-    for (const sig of componentType.getCallSignatures()) {
-        const propParam = sig.parameters[0];
-        if (propParam) {
-            const propsType = checker.getTypeOfSymbolAtLocation(propParam, components.node);
-            const props = propsType.getProperties();
-            for (const prop of props) {
-                const name = prop.name;
-                const required = !(prop.flags & ts.SymbolFlags.Optional) || undefined;
-                const commentMarkdown = generateCommentMarkdown(prop.getDocumentationComment(checker), prop.getJsDocTags()) || undefined;
-                result.set(name, { name, required, commentMarkdown });
-            }
-        }
-    }
-    for (const sig of componentType.getConstructSignatures()) {
-        const instanceType = sig.getReturnType();
-        const propsSymbol = instanceType.getProperty('$props');
-        if (propsSymbol) {
-            const propsType = checker.getTypeOfSymbolAtLocation(propsSymbol, components.node);
-            const props = propsType.getProperties();
-            for (const prop of props) {
-                if (prop.flags & ts.SymbolFlags.Method) { // #2443
-                    continue;
-                }
-                const name = prop.name;
-                const required = !(prop.flags & ts.SymbolFlags.Optional) || undefined;
-                const commentMarkdown = generateCommentMarkdown(prop.getDocumentationComment(checker), prop.getJsDocTags()) || undefined;
-                result.set(name, { name, required, commentMarkdown });
-            }
-        }
-    }
-    return [...result.values()];
-}
-function getComponentEvents(fileName, tag) {
-    const { typescript: ts, language, languageService, getFileId } = this;
-    const volarFile = language.scripts.get(getFileId(fileName));
-    if (!(volarFile?.generated?.root instanceof vue.VueVirtualCode)) {
-        return;
-    }
-    const vueCode = volarFile.generated.root;
-    const program = languageService.getProgram();
-    const checker = program.getTypeChecker();
-    const components = getVariableType(ts, languageService, vueCode, '__VLS_components');
-    if (!components) {
-        return [];
-    }
-    const name = tag.split('.');
-    let componentSymbol = components.type.getProperty(name[0]);
-    if (!componentSymbol) {
-        componentSymbol = components.type.getProperty((0, shared_1.camelize)(name[0]))
-            ?? components.type.getProperty((0, shared_1.capitalize)((0, shared_1.camelize)(name[0])));
-    }
-    if (!componentSymbol) {
-        return [];
-    }
-    let componentType = checker.getTypeOfSymbolAtLocation(componentSymbol, components.node);
-    for (let i = 1; i < name.length; i++) {
-        componentSymbol = componentType.getProperty(name[i]);
-        if (componentSymbol) {
-            componentType = checker.getTypeOfSymbolAtLocation(componentSymbol, components.node);
-        }
-        else {
-            return [];
-        }
-    }
-    const result = new Set();
-    // for (const sig of componentType.getCallSignatures()) {
-    // 	const emitParam = sig.parameters[1];
-    // 	if (emitParam) {
-    // 		// TODO
-    // 	}
-    // }
-    for (const sig of componentType.getConstructSignatures()) {
-        const instanceType = sig.getReturnType();
-        const emitSymbol = instanceType.getProperty('$emit');
-        if (emitSymbol) {
-            const emitType = checker.getTypeOfSymbolAtLocation(emitSymbol, components.node);
-            for (const call of emitType.getCallSignatures()) {
-                const eventNameParamSymbol = call.parameters[0];
-                if (eventNameParamSymbol) {
-                    const eventNameParamType = checker.getTypeOfSymbolAtLocation(eventNameParamSymbol, components.node);
-                    if (eventNameParamType.isStringLiteral()) {
-                        result.add(eventNameParamType.value);
-                    }
-                }
-            }
-        }
-    }
-    return [...result];
-}
-function getTemplateContextProps(fileName) {
-    const { typescript: ts, language, languageService, getFileId } = this;
-    const volarFile = language.scripts.get(getFileId(fileName));
-    if (!(volarFile?.generated?.root instanceof vue.VueVirtualCode)) {
-        return;
-    }
-    const vueCode = volarFile.generated.root;
-    return getVariableType(ts, languageService, vueCode, '__VLS_ctx')
-        ?.type
-        ?.getProperties()
-        .map(c => c.name);
-}
-function getComponentNames(fileName) {
-    const { typescript: ts, language, languageService, getFileId } = this;
-    const volarFile = language.scripts.get(getFileId(fileName));
-    if (!(volarFile?.generated?.root instanceof vue.VueVirtualCode)) {
-        return;
-    }
-    const vueCode = volarFile.generated.root;
-    return getVariableType(ts, languageService, vueCode, '__VLS_components')
-        ?.type
-        ?.getProperties()
-        .map(c => c.name)
-        .filter(entry => !entry.includes('$') && !entry.startsWith('_'))
-        ?? [];
-}
-function _getComponentNames(ts, tsLs, vueCode) {
-    return getVariableType(ts, tsLs, vueCode, '__VLS_components')
-        ?.type
-        ?.getProperties()
-        .map(c => c.name)
-        .filter(entry => !entry.includes('$') && !entry.startsWith('_'))
-        ?? [];
-}
-function getElementAttrs(fileName, tagName) {
-    const { typescript: ts, language, languageService, getFileId } = this;
-    const volarFile = language.scripts.get(getFileId(fileName));
-    if (!(volarFile?.generated?.root instanceof vue.VueVirtualCode)) {
-        return;
-    }
-    const program = languageService.getProgram();
-    let tsSourceFile;
-    if (tsSourceFile = program.getSourceFile(fileName)) {
-        const typeNode = tsSourceFile.statements.find((node) => ts.isTypeAliasDeclaration(node) && node.name.getText() === '__VLS_IntrinsicElementsCompletion');
-        const checker = program.getTypeChecker();
-        if (checker && typeNode) {
-            const type = checker.getTypeFromTypeNode(typeNode.type);
-            const el = type.getProperty(tagName);
-            if (el) {
-                const attrs = checker.getTypeOfSymbolAtLocation(el, typeNode).getProperties();
-                return attrs.map(c => c.name);
-            }
-        }
-    }
-    return [];
-}
-function getVariableType(ts, languageService, vueCode, name) {
-    const program = languageService.getProgram();
-    let tsSourceFile;
-    if (tsSourceFile = program.getSourceFile(vueCode.fileName)) {
-        const node = searchVariableDeclarationNode(ts, tsSourceFile, name);
-        const checker = program.getTypeChecker();
-        if (checker && node) {
-            return {
-                node: node,
-                type: checker.getTypeAtLocation(node),
-            };
-        }
-    }
-}
-function searchVariableDeclarationNode(ts, sourceFile, name) {
-    let componentsNode;
-    walk(sourceFile);
-    return componentsNode;
-    function walk(node) {
-        if (componentsNode) {
-            return;
-        }
-        else if (ts.isVariableDeclaration(node) && node.name.getText() === name) {
-            componentsNode = node;
-        }
-        else {
-            node.forEachChild(walk);
-        }
-    }
-}
-function generateCommentMarkdown(parts, jsDocTags) {
-    const parsedComment = _symbolDisplayPartsToMarkdown(parts);
-    const parsedJsDoc = _jsDocTagInfoToMarkdown(jsDocTags);
-    let result = [parsedComment, parsedJsDoc].filter(str => !!str).join('\n\n');
-    return result;
-}
-function _symbolDisplayPartsToMarkdown(parts) {
-    return parts.map(part => {
-        switch (part.kind) {
-            case 'keyword':
-                return `\`${part.text}\``;
-            case 'functionName':
-                return `**${part.text}**`;
-            default:
-                return part.text;
-        }
-    }).join('');
-}
-function _jsDocTagInfoToMarkdown(jsDocTags) {
-    return jsDocTags.map(tag => {
-        const tagName = `*@${tag.name}*`;
-        const tagText = tag.text?.map(t => {
-            if (t.kind === 'parameterName') {
-                return `\`${t.text}\``;
-            }
-            else {
-                return t.text;
-            }
-        }).join('') || '';
-        return `${tagName} ${tagText}`;
-    }).join('\n\n');
-}
-//# sourceMappingURL=componentInfos.js.map

package/lib/requests/getComponentInfo.d.ts

@@ -1,5 +0,0 @@
-import type { RequestContext } from './types';
-export declare function getComponentInfo(this: RequestContext, fileName: string, tag: string): {
-    props: import("./getComponentProps").ComponentPropInfo[] | undefined;
-    events: string[] | undefined;
-};

package/lib/requests/getComponentInfo.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getComponentInfo = getComponentInfo;
-const shared_1 = require("@vue/shared");
-const getComponentEvents_1 = require("./getComponentEvents");
-const getComponentProps_1 = require("./getComponentProps");
-const globalProperties = [
-    'key',
-    'ref',
-    'ref_for',
-    'ref_key',
-    'class',
-    'style'
-];
-function getComponentInfo(fileName, tag) {
-    const props = getComponentProps_1.getComponentProps.call(this, fileName, tag, true)?.filter(({ name }) => !globalProperties.includes(name) && !(0, shared_1.hyphenate)(name).startsWith('on-vnode-'));
-    const events = getComponentEvents_1.getComponentEvents.call(this, fileName, tag);
-    return {
-        props,
-        events,
-    };
-}
-//# sourceMappingURL=getComponentInfo.js.map

package/lib/server.d.ts

@@ -1,25 +0,0 @@
-import { Language } from '@vue/language-core';
-import type * as ts from 'typescript';
-export type RequestType = 'containsFile' | 'projectInfo' | 'collectExtractProps' | 'getImportPathForFile' | 'getPropertiesAtLocation' | 'getQuickInfoAtPosition' | 'subscribeComponentProps' | 'getComponentEvents' | 'getComponentDirectives' | 'getElementAttrs';
-export type NotificationType = 'componentNamesUpdated' | 'componentPropsUpdated';
-export type RequestData = [
-    seq: number,
-    type: RequestType,
-    fileName: string,
-    ...args: any[]
-];
-export type ResponseData = [
-    seq: number,
-    data: any
-];
-export type NotificationData = [
-    type: NotificationType,
-    fileName: string,
-    data: any
-];
-export interface ProjectInfo {
-    name: string;
-    kind: ts.server.ProjectKind;
-    currentDirectory: string;
-}
-export declare function startNamedPipeServer(ts: typeof import('typescript'), info: ts.server.PluginCreateInfo, language: Language<string>, projectKind: ts.server.ProjectKind.Inferred | ts.server.ProjectKind.Configured): Promise<void>;

package/lib/server.js

@@ -1,260 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.startNamedPipeServer = startNamedPipeServer;
-const language_core_1 = require("@vue/language-core");
-const fs = require("node:fs");
-const net = require("node:net");
-const collectExtractProps_1 = require("./requests/collectExtractProps");
-const getComponentDirectives_1 = require("./requests/getComponentDirectives");
-const getComponentEvents_1 = require("./requests/getComponentEvents");
-const getComponentNames_1 = require("./requests/getComponentNames");
-const getComponentProps_1 = require("./requests/getComponentProps");
-const getElementAttrs_1 = require("./requests/getElementAttrs");
-const getImportPathForFile_1 = require("./requests/getImportPathForFile");
-const getPropertiesAtLocation_1 = require("./requests/getPropertiesAtLocation");
-const getQuickInfoAtPosition_1 = require("./requests/getQuickInfoAtPosition");
-const utils_1 = require("./utils");
-async function startNamedPipeServer(ts, info, language, projectKind) {
-    let lastProjectVersion;
-    const requestContext = {
-        typescript: ts,
-        languageService: info.languageService,
-        languageServiceHost: info.languageServiceHost,
-        language: language,
-        isTsPlugin: true,
-        getFileId: (fileName) => fileName,
-    };
-    const dataChunks = [];
-    const currentData = new language_core_1.FileMap(false);
-    const allConnections = new Set();
-    const pendingRequests = new Set();
-    const server = net.createServer(connection => {
-        allConnections.add(connection);
-        connection.on('end', () => {
-            allConnections.delete(connection);
-        });
-        connection.on('data', buffer => {
-            dataChunks.push(buffer);
-            const text = dataChunks.toString();
-            if (text.endsWith('\n\n')) {
-                dataChunks.length = 0;
-                const requests = text.split('\n\n');
-                for (let json of requests) {
-                    json = json.trim();
-                    if (!json) {
-                        continue;
-                    }
-                    try {
-                        onRequest(connection, JSON.parse(json));
-                    }
-                    catch (e) {
-                        console.error('[Vue Named Pipe Server] JSON parse error:', e);
-                    }
-                }
-            }
-        });
-        connection.on('error', err => console.error('[Vue Named Pipe Server]', err.message));
-        for (const [fileName, [componentNames, componentProps]] of currentData) {
-            notify(connection, 'componentNamesUpdated', fileName, componentNames);
-            for (const [name, props] of Object.entries(componentProps)) {
-                notify(connection, 'componentPropsUpdated', fileName, [name, props]);
-            }
-        }
-    });
-    for (let i = 0; i < 10; i++) {
-        const path = (0, utils_1.getServerPath)(projectKind, i);
-        const socket = await connect(path, 100);
-        if (typeof socket === 'object') {
-            socket.end();
-        }
-        const namedPipeOccupied = typeof socket === 'object' || socket === 'timeout';
-        if (namedPipeOccupied) {
-            continue;
-        }
-        const success = await tryListen(server, path);
-        if (success) {
-            break;
-        }
-    }
-    updateWhile();
-    async function updateWhile() {
-        while (true) {
-            await sleep(500);
-            const projectVersion = info.project.getProjectVersion();
-            if (lastProjectVersion === projectVersion) {
-                continue;
-            }
-            const connections = [...allConnections].filter(c => !c.destroyed);
-            if (!connections.length) {
-                continue;
-            }
-            const token = info.languageServiceHost.getCancellationToken?.();
-            const openedScriptInfos = info.project.getRootScriptInfos().filter(info => info.isScriptOpen());
-            if (!openedScriptInfos.length) {
-                continue;
-            }
-            for (const scriptInfo of openedScriptInfos) {
-                await sleep(10);
-                if (token?.isCancellationRequested()) {
-                    break;
-                }
-                let data = currentData.get(scriptInfo.fileName);
-                if (!data) {
-                    data = [[], {}];
-                    currentData.set(scriptInfo.fileName, data);
-                }
-                const [oldComponentNames, componentProps] = data;
-                const newComponentNames = getComponentNames_1.getComponentNames.apply(requestContext, [scriptInfo.fileName]) ?? [];
-                if (JSON.stringify(oldComponentNames) !== JSON.stringify(newComponentNames)) {
-                    data[0] = newComponentNames;
-                    for (const connection of connections) {
-                        notify(connection, 'componentNamesUpdated', scriptInfo.fileName, newComponentNames);
-                    }
-                }
-                for (const [name, props] of Object.entries(componentProps)) {
-                    await sleep(10);
-                    if (token?.isCancellationRequested()) {
-                        break;
-                    }
-                    const newProps = getComponentProps_1.getComponentProps.apply(requestContext, [scriptInfo.fileName, name]) ?? [];
-                    if (JSON.stringify(props) !== JSON.stringify(newProps)) {
-                        componentProps[name] = newProps;
-                        for (const connection of connections) {
-                            notify(connection, 'componentPropsUpdated', scriptInfo.fileName, [name, newProps]);
-                        }
-                    }
-                }
-            }
-            lastProjectVersion = projectVersion;
-        }
-    }
-    function sleep(ms) {
-        return new Promise(resolve => setTimeout(resolve, ms));
-    }
-    function notify(connection, type, fileName, data) {
-        connection.write(JSON.stringify([type, fileName, data]) + '\n\n');
-    }
-    function onRequest(connection, [seq, requestType, ...args]) {
-        if (pendingRequests.has(seq)) {
-            return;
-        }
-        setTimeout(() => pendingRequests.delete(seq), 500);
-        pendingRequests.add(seq);
-        let data;
-        try {
-            data = handleRequest(requestType, ...args);
-        }
-        catch {
-            data = null;
-        }
-        connection.write(JSON.stringify([seq, data ?? null]) + '\n\n');
-    }
-    function handleRequest(requestType, ...args) {
-        const fileName = args[0];
-        if (requestType === 'projectInfo') {
-            return {
-                name: info.project.getProjectName(),
-                kind: info.project.projectKind,
-                currentDirectory: info.project.getCurrentDirectory(),
-            };
-        }
-        else if (requestType === 'containsFile') {
-            return info.project.containsFile(ts.server.toNormalizedPath(fileName));
-        }
-        else if (requestType === 'collectExtractProps') {
-            return collectExtractProps_1.collectExtractProps.apply(requestContext, args);
-        }
-        else if (requestType === 'getImportPathForFile') {
-            return getImportPathForFile_1.getImportPathForFile.apply(requestContext, args);
-        }
-        else if (requestType === 'getPropertiesAtLocation') {
-            return getPropertiesAtLocation_1.getPropertiesAtLocation.apply(requestContext, args);
-        }
-        else if (requestType === 'getQuickInfoAtPosition') {
-            return getQuickInfoAtPosition_1.getQuickInfoAtPosition.apply(requestContext, args);
-        }
-        else if (requestType === 'subscribeComponentProps') {
-            const tag = args[1];
-            const props = getComponentProps_1.getComponentProps.apply(requestContext, [fileName, tag]) ?? [];
-            let data = currentData.get(fileName);
-            if (!data) {
-                data = [[], {}];
-                currentData.set(fileName, data);
-            }
-            data[1][tag] = props;
-            return props;
-        }
-        else if (requestType === 'getComponentEvents') {
-            return getComponentEvents_1.getComponentEvents.apply(requestContext, args);
-        }
-        else if (requestType === 'getComponentDirectives') {
-            return getComponentDirectives_1.getComponentDirectives.apply(requestContext, args);
-        }
-        else if (requestType === 'getElementAttrs') {
-            return getElementAttrs_1.getElementAttrs.apply(requestContext, args);
-        }
-        console.warn('[Vue Named Pipe Server] Unknown request:', requestType);
-        debugger;
-        return undefined;
-    }
-}
-function connect(namedPipePath, timeout) {
-    return new Promise(resolve => {
-        const socket = net.connect(namedPipePath);
-        if (timeout) {
-            socket.setTimeout(timeout);
-        }
-        const onConnect = () => {
-            cleanup();
-            resolve(socket);
-        };
-        const onError = (err) => {
-            if (err.code === 'ECONNREFUSED') {
-                try {
-                    console.log('[Vue Named Pipe Client] Deleting:', namedPipePath);
-                    fs.promises.unlink(namedPipePath);
-                }
-                catch { }
-            }
-            cleanup();
-            resolve('error');
-            socket.end();
-        };
-        const onTimeout = () => {
-            cleanup();
-            resolve('timeout');
-            socket.end();
-        };
-        const cleanup = () => {
-            socket.off('connect', onConnect);
-            socket.off('error', onError);
-            socket.off('timeout', onTimeout);
-        };
-        socket.on('connect', onConnect);
-        socket.on('error', onError);
-        socket.on('timeout', onTimeout);
-    });
-}
-function tryListen(server, namedPipePath) {
-    return new Promise(resolve => {
-        const onSuccess = () => {
-            server.off('error', onError);
-            resolve(true);
-        };
-        const onError = (err) => {
-            if (err.code === 'ECONNREFUSED') {
-                try {
-                    console.log('[Vue Named Pipe Client] Deleting:', namedPipePath);
-                    fs.promises.unlink(namedPipePath);
-                }
-                catch { }
-            }
-            server.off('error', onError);
-            server.close();
-            resolve(false);
-        };
-        server.listen(namedPipePath, onSuccess);
-        server.on('error', onError);
-    });
-}
-//# sourceMappingURL=server.js.map

package/lib/utils.d.ts

@@ -1,31 +0,0 @@
-import { FileMap } from '@vue/language-core';
-import * as net from 'node:net';
-import type * as ts from 'typescript';
-import type { ComponentPropInfo } from './requests/getComponentProps';
-import type { NotificationData, ProjectInfo, RequestData } from './server';
-export { TypeScriptProjectHost } from '@volar/typescript';
-export declare function getServerPath(kind: ts.server.ProjectKind, id: number): string;
-declare class NamedPipeServer {
-    path: string;
-    connecting: boolean;
-    projectInfo?: ProjectInfo;
-    containsFileCache: Map<string, Promise<boolean | null | undefined>>;
-    componentNamesAndProps: FileMap<Record<string, ComponentPropInfo[] | null>>;
-    constructor(kind: ts.server.ProjectKind, id: number);
-    containsFile(fileName: string): Promise<boolean | null | undefined> | undefined;
-    getComponentProps(fileName: string, tag: string): Promise<ComponentPropInfo[] | null | undefined>;
-    update(): void;
-    connect(): void;
-    close(): void;
-    socket?: net.Socket;
-    seq: number;
-    dataChunks: Buffer[];
-    requestHandlers: Map<number, (res: any) => void>;
-    onData(chunk: Buffer): void;
-    onNotification(type: NotificationData[0], fileName: string, data: any): void;
-    sendRequest<T>(requestType: RequestData[1], fileName: string, ...args: any[]): Promise<T | null | undefined>;
-}
-export declare const configuredServers: NamedPipeServer[];
-export declare const inferredServers: NamedPipeServer[];
-export declare const onServerReady: (() => void)[];
-export declare function getBestServer(fileName: string): Promise<NamedPipeServer | undefined>;