@vue/typescript-plugin 2.1.4 → 2.1.6

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/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,6 +1,6 @@
 {
 	"name": "@vue/typescript-plugin",
-	"version": "2.1.4",
+	"version": "2.1.6",
 	"license": "MIT",
 	"files": [
 		"**/*.js",
@@ -13,11 +13,11 @@
 	},
 	"dependencies": {
 		"@volar/typescript": "~2.4.1",
-		"@vue/language-core": "2.1.4",
+		"@vue/language-core": "2.1.6",
 		"@vue/shared": "^3.4.0"
 	},
 	"devDependencies": {
 		"@types/node": "latest"
 	},
-	"gitHead": "5e197d08eaef57209ff2927c943ba1db3bf4eff6"
+	"gitHead": "fd61953ce9eb924eeaf4df0bf8d2237267321194"
 }