@vue/typescript-plugin 3.2.4 → 3.2.6

package/README.md

@@ -1,28 +1,81 @@
-# typescript plugin
+# @vue/typescript-plugin
 
-This is a plug-in for `tsserver` or `typescript-language-server`. It must be installed in a file-system location accessible by the language server or in the `node_modules` directory of projects being edited.
+<p>
+  <a href="https://www.npmjs.com/package/@vue/typescript-plugin"><img src="https://img.shields.io/npm/v/@vue/typescript-plugin.svg?labelColor=18181B&color=1584FC" alt="NPM version"></a>
+  <a href="https://github.com/vuejs/language-tools/blob/master/LICENSE"><img src="https://img.shields.io/github/license/vuejs/language-tools.svg?labelColor=18181B&color=1584FC" alt="License"></a>
+</p>
 
-The LSP client must be configured to explicitly enable this plug-in. This is done by passing `initializationOptions` with the appropriate [`plugins`] configuration to the language server:
+A TypeScript language service plugin that enables `tsserver` to understand `.vue` files. This plugin is used by `@vue/language-server` to collaborate with the TypeScript language service.
 
-[`plugins`]: https://github.com/typescript-language-server/typescript-language-server/blob/b224b878652438bcdd639137a6b1d1a6630129e4/docs/configuration.md?plain=1#L27-L31
+## Installation
+
+```bash
+npm install @vue/typescript-plugin --save-dev
+```
+
+## Configuration
+
+### VSCode
+
+Create `.vscode/settings.json` in your project root:
 
 ```json
-"initializationOptions":  {
+{
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.enablePromptUseWorkspaceTsdk": true
+}
+```
+
+### tsconfig.json
+
+```jsonc
+{
+  "compilerOptions": {
     "plugins": [
-        {
-          "name": "@vue/typescript-plugin",
-          "location": "/usr/local/lib/node_modules/@vue/language-server",
-          "languages": ["vue"],
-        },
-    ],
-  },
+      { "name": "@vue/typescript-plugin" }
+    ]
+  }
+}
 ```
 
-The `languages` field must specify file-types for which the plug-in will be enabled. If the plug-in package is installed in the local `node_modules`, the `location` field may contain any arbitrary string, but MUST be present.
+## Provided Features
+
+This plugin registers the following Vue-specific commands for `tsserver`:
+
+| Command | Description |
+| :--- | :--- |
+| `_vue:projectInfo` | Get project information |
+| `_vue:collectExtractProps` | Collect extractable props |
+| `_vue:getImportPathForFile` | Get import path for a file |
+| `_vue:getAutoImportSuggestions` | Get auto-import suggestions |
+| `_vue:resolveAutoImportCompletionEntry` | Resolve auto-import completion entry |
+| `_vue:isRefAtPosition` | Check if position is a ref |
+| `_vue:getComponentDirectives` | Get component directives |
+| `_vue:getComponentNames` | Get component name list |
+| `_vue:getComponentMeta` | Get component metadata |
+| `_vue:getComponentSlots` | Get component slots |
+| `_vue:getElementAttrs` | Get element attributes |
+| `_vue:getElementNames` | Get element name list |
+| `_vue:resolveModuleName` | Resolve module name |
+| `_vue:documentHighlights-full` | Document highlights |
+| `_vue:encodedSemanticClassifications-full` | Semantic classifications |
+| `_vue:quickinfo` | Quick info |
+
+## How it Works
+
+This plugin is created using `createLanguageServicePlugin` from `@volar/typescript`. It:
+
+1. Reads `vueCompilerOptions` from `tsconfig.json`
+2. Creates a Vue language plugin to process `.vue` files
+3. Intercepts and handles TypeScript language service requests
+4. Registers Vue-specific protocol handlers
+
+## Related Packages
 
-## Client-specific configuration
+- [`@vue/language-core`](../language-core) - Core module
+- [`@vue/language-server`](../language-server) - Language server
+- [`vue-component-meta`](../component-meta) - Component metadata
 
-- For neovim, see the [details on configuring `tsserver`][nvim].
+## License
 
-[nvim]: https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md#vue-support
-  
+[MIT](https://github.com/vuejs/language-tools/blob/master/LICENSE) License

package/index.js

@@ -105,13 +105,13 @@ module.exports = (0, createLanguageServicePlugin_1.createLanguageServicePlugin)(
         });
         session.addProtocolHandler('_vue:collectExtractProps', request => {
             const [fileName, templateCodeRange] = request.arguments;
-            const { project, language, sourceScript, virtualCode } = getProjectAndVirtualCode(fileName);
-            return createResponse((0, collectExtractProps_1.collectExtractProps)(ts, language, project.getLanguageService().getProgram(), sourceScript, virtualCode, templateCodeRange, sourceScript.generated ? sourceScript.snapshot.getLength() : 0));
+            const { program, language, sourceScript, virtualCode } = getProjectAndVirtualCode(fileName);
+            return createResponse((0, collectExtractProps_1.collectExtractProps)(ts, language, program, sourceScript, virtualCode, templateCodeRange, sourceScript.generated ? sourceScript.snapshot.getLength() : 0));
         });
         session.addProtocolHandler('_vue:getImportPathForFile', request => {
             const [fileName, incomingFileName, preferences] = request.arguments;
-            const { project } = getProject(fileName);
-            return createResponse((0, getImportPathForFile_1.getImportPathForFile)(ts, project, project.getLanguageService().getProgram(), fileName, incomingFileName, preferences));
+            const { project, program } = getProject(fileName);
+            return createResponse((0, getImportPathForFile_1.getImportPathForFile)(ts, project, program, fileName, incomingFileName, preferences));
         });
         session.addProtocolHandler('_vue:getAutoImportSuggestions', request => {
             const [fileName, position] = request.arguments;
@@ -194,40 +194,39 @@ module.exports = (0, createLanguageServicePlugin_1.createLanguageServicePlugin)(
         });
         session.addProtocolHandler('_vue:isRefAtPosition', request => {
             const [fileName, position] = request.arguments;
-            const { project, language, sourceScript, virtualCode } = getProjectAndVirtualCode(fileName);
-            return createResponse((0, isRefAtPosition_1.isRefAtPosition)(ts, language, project.getLanguageService().getProgram(), sourceScript, virtualCode, position, sourceScript.generated ? sourceScript.snapshot.getLength() : 0));
+            const { program, language, sourceScript, virtualCode } = getProjectAndVirtualCode(fileName);
+            return createResponse((0, isRefAtPosition_1.isRefAtPosition)(ts, language, program, sourceScript, virtualCode, position, sourceScript.generated ? sourceScript.snapshot.getLength() : 0));
         });
         session.addProtocolHandler('_vue:getComponentDirectives', request => {
             const [fileName] = request.arguments;
-            const { project } = getProject(fileName);
-            return createResponse((0, getComponentDirectives_1.getComponentDirectives)(ts, project.getLanguageService().getProgram(), fileName));
+            const { program } = getProject(fileName);
+            return createResponse((0, getComponentDirectives_1.getComponentDirectives)(ts, program, fileName));
         });
         session.addProtocolHandler('_vue:getComponentNames', request => {
             const [fileName] = request.arguments;
-            const { project, virtualCode } = getProjectAndVirtualCode(fileName);
-            return createResponse((0, getComponentNames_1.getComponentNames)(ts, project.getLanguageService().getProgram(), virtualCode));
+            const { program, virtualCode } = getProjectAndVirtualCode(fileName);
+            return createResponse((0, getComponentNames_1.getComponentNames)(ts, program, virtualCode));
         });
         session.addProtocolHandler('_vue:getComponentMeta', request => {
             const [fileName, tag] = request.arguments;
-            const { project, virtualCode, language } = getProjectAndVirtualCode(fileName);
-            const program = project.getLanguageService().getProgram();
+            const { program, virtualCode, language } = getProjectAndVirtualCode(fileName);
             const sourceFile = program.getSourceFile(virtualCode.fileName);
-            return createResponse((0, getComponentMeta_1.getComponentMeta)(ts, program, language, sourceFile, virtualCode, tag));
+            return createResponse((0, getComponentMeta_1.getComponentMeta)(ts, program, language, fileName => language.scripts.get(fileName), sourceFile, virtualCode, tag));
         });
         session.addProtocolHandler('_vue:getComponentSlots', request => {
             const [fileName] = request.arguments;
-            const { project, virtualCode } = getProjectAndVirtualCode(fileName);
-            return createResponse((0, getComponentSlots_1.getComponentSlots)(ts, project.getLanguageService().getProgram(), virtualCode));
+            const { program, virtualCode } = getProjectAndVirtualCode(fileName);
+            return createResponse((0, getComponentSlots_1.getComponentSlots)(ts, program, virtualCode));
         });
         session.addProtocolHandler('_vue:getElementAttrs', request => {
             const [fileName, tag] = request.arguments;
-            const { project } = getProject(fileName);
-            return createResponse((0, getElementAttrs_1.getElementAttrs)(ts, project.getLanguageService().getProgram(), fileName, tag));
+            const { program } = getProject(fileName);
+            return createResponse((0, getElementAttrs_1.getElementAttrs)(ts, program, fileName, tag));
         });
         session.addProtocolHandler('_vue:getElementNames', request => {
             const [fileName] = request.arguments;
-            const { project } = getProject(fileName);
-            return createResponse((0, getElementNames_1.getElementNames)(ts, project.getLanguageService().getProgram(), fileName));
+            const { program } = getProject(fileName);
+            return createResponse((0, getElementNames_1.getElementNames)(ts, program, fileName));
         });
         session.addProtocolHandler('_vue:resolveModuleName', request => {
             const [fileName, moduleName] = request.arguments;
@@ -241,8 +240,8 @@ module.exports = (0, createLanguageServicePlugin_1.createLanguageServicePlugin)(
             };
         }
         function getProjectAndVirtualCode(fileName) {
-            const service = getProject(fileName);
-            const sourceScript = service.language.scripts.get(fileName);
+            const project = getProject(fileName);
+            const sourceScript = project.language.scripts.get(fileName);
             if (!sourceScript) {
                 throw new Error('No source script found for file: ' + fileName);
             }
@@ -251,7 +250,7 @@ module.exports = (0, createLanguageServicePlugin_1.createLanguageServicePlugin)(
                 throw new Error('No virtual code found for file: ' + fileName);
             }
             return {
-                ...service,
+                ...project,
                 sourceScript,
                 virtualCode,
             };
@@ -266,6 +265,7 @@ module.exports = (0, createLanguageServicePlugin_1.createLanguageServicePlugin)(
             }
             return {
                 project,
+                program: project.getLanguageService().getProgram(),
                 language: project.__vue__.language,
             };
         }

package/lib/requests/getComponentMeta.d.ts

@@ -1,4 +1,4 @@
-import type { Language, VueVirtualCode } from '@vue/language-core';
+import type { Language, SourceScript, VueVirtualCode } from '@vue/language-core';
 import type * as ts from 'typescript';
 import type { ComponentMeta } from 'vue-component-meta';
-export declare function getComponentMeta(ts: typeof import('typescript'), program: ts.Program, language: Language<string>, sourceFile: ts.SourceFile, virtualCode: VueVirtualCode, tag: string): ComponentMeta | undefined;
+export declare function getComponentMeta(ts: typeof import('typescript'), program: ts.Program, language: Language, getSourceScript: (fileName: string) => SourceScript | undefined, sourceFile: ts.SourceFile, virtualCode: VueVirtualCode, tag: string): ComponentMeta | undefined;

package/lib/requests/getComponentMeta.js

@@ -3,12 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getComponentMeta = getComponentMeta;
 const componentMeta_1 = require("vue-component-meta/lib/componentMeta");
 const utils_1 = require("./utils");
-function getComponentMeta(ts, program, language, sourceFile, virtualCode, tag) {
+function getComponentMeta(ts, program, language, getSourceScript, sourceFile, virtualCode, tag) {
     const checker = program.getTypeChecker();
     const componentType = (0, utils_1.getComponentType)(ts, checker, sourceFile, virtualCode, tag);
     if (!componentType) {
         return;
     }
-    return (0, componentMeta_1.getComponentMeta)(ts, checker, ts.createPrinter(), language, componentType.node, componentType.type, false);
+    return (0, componentMeta_1.getComponentMeta)(ts, checker, ts.createPrinter(), language, getSourceScript, componentType.node, componentType.type, false);
 }
 //# sourceMappingURL=getComponentMeta.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@vue/typescript-plugin",
-	"version": "3.2.4",
+	"version": "3.2.6",
 	"license": "MIT",
 	"files": [
 		"**/*.js",
@@ -13,15 +13,15 @@
 		"directory": "packages/typescript-plugin"
 	},
 	"dependencies": {
-		"@volar/typescript": "2.4.27",
-		"@vue/language-core": "3.2.4",
+		"@volar/typescript": "2.4.28",
+		"@vue/language-core": "3.2.6",
 		"@vue/shared": "^3.5.0",
 		"path-browserify": "^1.0.1",
-		"vue-component-meta": "3.2.4"
+		"vue-component-meta": "3.2.6"
 	},
 	"devDependencies": {
 		"@types/node": "^22.10.4",
 		"@types/path-browserify": "^1.0.1"
 	},
-	"gitHead": "f0ede303fadb192a59068b4b667b0405523d24c8"
+	"gitHead": "94907be4f056f25867e46a117ab18d2782b425d7"
 }