@vue/typescript-plugin 2.1.5 → 2.1.8

package/index.js

@@ -1,18 +1,13 @@
 "use strict";
 const createLanguageServicePlugin_1 = require("@volar/typescript/lib/quickstart/createLanguageServicePlugin");
-const path = require("path");
 const vue = require("@vue/language-core");
 const common_1 = require("./lib/common");
 const server_1 = require("./lib/server");
 const windowsPathReg = /\\/g;
 const vueCompilerOptions = new WeakMap();
-const setupedProjects = new WeakSet();
-const basePlugin = (0, createLanguageServicePlugin_1.createLanguageServicePlugin)((ts, info) => {
+const plugin = (0, createLanguageServicePlugin_1.createLanguageServicePlugin)((ts, info) => {
     const vueOptions = getVueCompilerOptions();
-    const languagePlugin = vue.createVueLanguagePlugin(ts, info.languageServiceHost.getCompilationSettings(), {
-        ...vueOptions,
-        __setupedGlobalTypes: () => setupedProjects.has(info.project),
-    }, id => id);
+    const languagePlugin = vue.createVueLanguagePlugin(ts, info.languageServiceHost.getCompilationSettings(), vueOptions, id => id);
     vueCompilerOptions.set(info.project, vueOptions);
     return {
         languagePlugins: [languagePlugin],
@@ -41,32 +36,5 @@ const basePlugin = (0, createLanguageServicePlugin_1.createLanguageServicePlugin
         }
     }
 });
-const plugin = mods => {
-    const pluginModule = basePlugin(mods);
-    return {
-        ...pluginModule,
-        getExternalFiles(proj, updateLevel = 0) {
-            const options = vueCompilerOptions.get(proj);
-            if (updateLevel >= 1 && options) {
-                try {
-                    let dir = proj.getCurrentDirectory();
-                    while (!proj.directoryExists(path.resolve(dir, 'node_modules'))) {
-                        const parentDir = path.resolve(dir, '..');
-                        if (dir === parentDir) {
-                            throw 0;
-                        }
-                        dir = parentDir;
-                    }
-                    const globalTypesPath = path.resolve(dir, `node_modules/.vue-global-types/${options.lib}_${options.target}_${options.strictTemplates}.d.ts`);
-                    const globalTypesContents = vue.generateGlobalTypes('global', options.lib, options.target, options.strictTemplates);
-                    proj.writeFile(globalTypesPath, globalTypesContents);
-                    setupedProjects.add(proj);
-                }
-                catch { }
-            }
-            return pluginModule.getExternalFiles?.(proj, updateLevel) ?? [];
-        },
-    };
-};
 module.exports = plugin;
 //# sourceMappingURL=index.js.map

package/lib/client.d.ts

@@ -6,7 +6,10 @@ export declare function collectExtractProps(...args: Parameters<typeof import('.
 export declare function getImportPathForFile(...args: Parameters<typeof import('./requests/getImportPathForFile.js')['getImportPathForFile']>): Promise<string | null | undefined>;
 export declare function getPropertiesAtLocation(...args: Parameters<typeof import('./requests/getPropertiesAtLocation.js')['getPropertiesAtLocation']>): Promise<string[] | null | undefined>;
 export declare function getQuickInfoAtPosition(...args: Parameters<typeof import('./requests/getQuickInfoAtPosition.js')['getQuickInfoAtPosition']>): Promise<string | null | undefined>;
-export declare function getComponentProps(...args: Parameters<typeof import('./requests/componentInfos.js')['getComponentProps']>): Promise<string[] | null | undefined>;
+export declare function getComponentProps(...args: Parameters<typeof import('./requests/componentInfos.js')['getComponentProps']>): Promise<{
+    name: string;
+    commentMarkdown: string;
+}[] | null | undefined>;
 export declare function getComponentEvents(...args: Parameters<typeof import('./requests/componentInfos.js')['getComponentEvents']>): Promise<string[] | null | undefined>;
 export declare function getTemplateContextProps(...args: Parameters<typeof import('./requests/componentInfos.js')['getTemplateContextProps']>): Promise<string[] | null | undefined>;
 export declare function getComponentNames(...args: Parameters<typeof import('./requests/componentInfos.js')['getComponentNames']>): Promise<string[] | null | undefined>;

package/lib/common.d.ts

@@ -2,4 +2,4 @@ import { Language, VueCompilerOptions, VueVirtualCode } from '@vue/language-core
 import type * as ts from 'typescript';
 import type { RequestContext } from './requests/types';
 export declare function proxyLanguageServiceForVue<T>(ts: typeof import('typescript'), language: Language<T>, languageService: ts.LanguageService, vueOptions: VueCompilerOptions, asScriptId: (fileName: string) => T): ts.LanguageService;
-export declare function getComponentSpans(this: Pick<RequestContext, 'typescript' | 'languageService'>, vueCode: VueVirtualCode, template: NonNullable<VueVirtualCode['sfc']['template']>, spanTemplateRange: ts.TextSpan): ts.TextSpan[];
+export declare function getComponentSpans(this: Pick<RequestContext, 'typescript' | 'languageService'>, vueCode: VueVirtualCode, template: NonNullable<VueVirtualCode['_sfc']['template']>, spanTemplateRange: ts.TextSpan): ts.TextSpan[];

package/lib/common.js

@@ -102,7 +102,7 @@ function getCompletionEntryDetails(language, asScriptId, getCompletionEntryDetai
             const { fileName } = args[6]?.__isAutoImport;
             const sourceScript = language.scripts.get(asScriptId(fileName));
             if (sourceScript?.generated?.root instanceof language_core_1.VueVirtualCode) {
-                const sfc = sourceScript.generated.root.getVueSfc();
+                const sfc = sourceScript.generated.root._vueSfc.get();
                 if (!sfc?.descriptor.script && !sfc?.descriptor.scriptSetup) {
                     for (const codeAction of details?.codeActions ?? []) {
                         for (const change of codeAction.changes) {
@@ -172,7 +172,7 @@ function getEncodedSemanticClassifications(ts, language, languageService, asScri
         const result = getEncodedSemanticClassifications(fileName, span, format);
         const file = language.scripts.get(asScriptId(fileName));
         if (file?.generated?.root instanceof language_core_1.VueVirtualCode) {
-            const { template } = file.generated.root.sfc;
+            const { template } = file.generated.root._sfc;
             if (template) {
                 for (const componentSpan of getComponentSpans.call({ typescript: ts, languageService }, file.generated.root, template, {
                     start: span.start - template.startTagEnd,

package/lib/requests/collectExtractProps.js

@@ -14,7 +14,7 @@ function collectExtractProps(fileName, templateCodeRange) {
     const checker = program.getTypeChecker();
     const script = volarFile.generated?.languagePlugin.typescript?.getServiceScript(volarFile.generated.root);
     const maps = script ? [...language.maps.forEach(script.code)].map(([_sourceScript, map]) => map) : [];
-    const sfc = volarFile.generated.root.sfc;
+    const sfc = volarFile.generated.root._sfc;
     sourceFile.forEachChild(function visit(node) {
         if (ts.isPropertyAccessExpression(node)
             && ts.isIdentifier(node.expression)

package/lib/requests/componentInfos.d.ts

@@ -1,7 +1,10 @@
 import * as vue from '@vue/language-core';
 import type * as ts from 'typescript';
 import type { RequestContext } from './types';
-export declare function getComponentProps(this: RequestContext, fileName: string, tag: string, requiredOnly?: boolean): string[] | undefined;
+export declare function getComponentProps(this: RequestContext, fileName: string, tag: string, requiredOnly?: boolean): {
+    name: string;
+    commentMarkdown: string;
+}[] | undefined;
 export declare function getComponentEvents(this: RequestContext, fileName: string, tag: string): string[] | undefined;
 export declare function getTemplateContextProps(this: RequestContext, fileName: string): string[] | undefined;
 export declare function getComponentNames(this: RequestContext, fileName: string): string[] | undefined;

package/lib/requests/componentInfos.js

@@ -40,7 +40,7 @@ function getComponentProps(fileName, tag, requiredOnly = false) {
             return [];
         }
     }
-    const result = new Set();
+    const result = new Map();
     for (const sig of componentType.getCallSignatures()) {
         const propParam = sig.parameters[0];
         if (propParam) {
@@ -48,7 +48,9 @@ function getComponentProps(fileName, tag, requiredOnly = false) {
             const props = propsType.getProperties();
             for (const prop of props) {
                 if (!requiredOnly || !(prop.flags & ts.SymbolFlags.Optional)) {
-                    result.add(prop.name);
+                    const name = prop.name;
+                    const commentMarkdown = generateCommentMarkdown(prop.getDocumentationComment(checker), prop.getJsDocTags());
+                    result.set(name, { name, commentMarkdown });
                 }
             }
         }
@@ -64,12 +66,14 @@ function getComponentProps(fileName, tag, requiredOnly = false) {
                     continue;
                 }
                 if (!requiredOnly || !(prop.flags & ts.SymbolFlags.Optional)) {
-                    result.add(prop.name);
+                    const name = prop.name;
+                    const commentMarkdown = generateCommentMarkdown(prop.getDocumentationComment(checker), prop.getJsDocTags());
+                    result.set(name, { name, commentMarkdown });
                 }
             }
         }
     }
-    return [...result];
+    return [...result.values()];
 }
 function getComponentEvents(fileName, tag) {
     const { typescript: ts, language, languageService, getFileId } = this;
@@ -214,4 +218,36 @@ function searchVariableDeclarationNode(ts, sourceFile, name) {
         }
     }
 }
+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/utils.js

@@ -27,7 +27,7 @@ const configuredNamedPipePathPrefix = toFullPath(`vue-named-pipe-${version}-conf
 const inferredNamedPipePathPrefix = toFullPath(`vue-named-pipe-${version}-inferred-`);
 const pipes = new Map();
 exports.onSomePipeReadyCallbacks = [];
-function watchNamedPipeReady(namedPipePath) {
+function waitingForNamedPipeServerReady(namedPipePath) {
     const socket = net.connect(namedPipePath);
     const start = Date.now();
     socket.on('connect', () => {
@@ -51,6 +51,10 @@ function watchNamedPipeReady(namedPipePath) {
         pipes.delete(namedPipePath);
         socket.end();
     });
+    socket.on('timeout', () => {
+        pipes.delete(namedPipePath);
+        socket.end();
+    });
 }
 function getNamedPipePath(projectKind, key) {
     return projectKind === 1
@@ -68,14 +72,14 @@ function getReadyNamedPipePaths() {
         }
         else if (!pipes.has(configuredPipe)) {
             pipes.set(configuredPipe, 'unknown');
-            watchNamedPipeReady(configuredPipe);
+            waitingForNamedPipeServerReady(configuredPipe);
         }
         if (pipes.get(inferredPipe) === 'ready') {
             inferredPipes.push(inferredPipe);
         }
         else if (!pipes.has(inferredPipe)) {
             pipes.set(inferredPipe, 'unknown');
-            watchNamedPipeReady(inferredPipe);
+            waitingForNamedPipeServerReady(inferredPipe);
         }
     }
     return {
@@ -104,10 +108,12 @@ function connect(namedPipePath, timeout) {
             pipes.delete(namedPipePath);
             cleanup();
             resolve('error');
+            socket.end();
         };
         const onTimeout = () => {
             cleanup();
             resolve('timeout');
+            socket.end();
         };
         const cleanup = () => {
             socket.off('connect', onConnect);

package/package.json

@@ -1,23 +1,24 @@
 {
 	"name": "@vue/typescript-plugin",
-	"version": "2.1.5",
+	"version": "2.1.8",
 	"license": "MIT",
 	"files": [
 		"**/*.js",
 		"**/*.d.ts"
 	],
+	"sideEffects": false,
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/vuejs/language-tools.git",
 		"directory": "packages/typescript-plugin"
 	},
 	"dependencies": {
-		"@volar/typescript": "~2.4.1",
-		"@vue/language-core": "2.1.5",
-		"@vue/shared": "^3.4.0"
+		"@volar/typescript": "~2.4.8",
+		"@vue/language-core": "2.1.8",
+		"@vue/shared": "^3.5.0"
 	},
 	"devDependencies": {
 		"@types/node": "latest"
 	},
-	"gitHead": "a95b51ac0b0db8825f77fbba37e29932b5be61e4"
+	"gitHead": "25cccedc53e7361ed4e34296d6ecd43d7de2a095"
 }