@vue/language-server 3.2.3 → 3.2.5

package/README.md

@@ -0,0 +1,84 @@
+# @vue/language-server
+
+<p>
+  <a href="https://www.npmjs.com/package/@vue/language-server"><img src="https://img.shields.io/npm/v/@vue/language-server.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>
+
+A Vue language server based on the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/). This package provides an executable language server that can be integrated with any LSP-compatible editor.
+
+## Installation
+
+```bash
+npm install @vue/language-server
+```
+
+## Command-Line Usage
+
+After installation, the `vue-language-server` command is available:
+
+```bash
+# Start in stdio mode
+vue-language-server --stdio
+
+# Check version
+vue-language-server --version
+
+# Specify TypeScript SDK path
+vue-language-server --stdio --tsdk=/path/to/typescript/lib
+```
+
+### `--tsdk` Parameter
+
+The `--tsdk` parameter is used to specify the path to the TypeScript SDK. This is useful when you need to use a specific version of TypeScript from your project instead of the globally installed version. The path should point to TypeScript's `lib` directory.
+
+## Editor Integration
+
+### VSCode
+
+Simply install the [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) extension, which already includes this language server.
+
+### Neovim
+
+Configure via [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig):
+
+```lua
+require('lspconfig').volar.setup({})
+```
+
+### Sublime Text
+
+See [sublimelsp/LSP-volar](https://github.com/sublimelsp/LSP-volar).
+
+### Emacs
+
+See [lsp-mode](https://github.com/emacs-lsp/lsp-mode) for Vue support.
+
+## Programmatic Usage
+
+If you need to start the language server within your own program:
+
+```typescript
+import { startServer } from '@vue/language-server/lib/server';
+import * as ts from 'typescript';
+
+// startServer creates an LSP connection and starts listening
+// Requires communication with the client via stdio or other means
+startServer(ts);
+```
+
+> **Note**: `startServer` creates a stdio-based LSP connection and communicates with `@vue/typescript-plugin` through `tsserver/request` and `tsserver/response` notifications.
+
+## Collaboration with TypeScript Plugin
+
+This language server communicates with `@vue/typescript-plugin` through custom `tsserver/request` and `tsserver/response` notifications. This architecture allows the language server to leverage the capabilities of the TypeScript language service for complex type inference and code analysis.
+
+## Related Packages
+
+- [`@vue/language-core`](../language-core) - Core module
+- [`@vue/language-service`](../language-service) - Language service plugins
+- [`@vue/typescript-plugin`](../typescript-plugin) - TypeScript plugin
+
+## License
+
+[MIT](https://github.com/vuejs/language-tools/blob/master/LICENSE) License

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@vue/language-server",
-	"version": "3.2.3",
+	"version": "3.2.5",
 	"license": "MIT",
 	"files": [
 		"**/*.js",
@@ -16,10 +16,10 @@
 		"directory": "packages/language-server"
 	},
 	"dependencies": {
-		"@volar/language-server": "2.4.27",
-		"@vue/language-core": "3.2.3",
-		"@vue/language-service": "3.2.3",
-		"@vue/typescript-plugin": "3.2.3",
+		"@volar/language-server": "2.4.28",
+		"@vue/language-core": "3.2.5",
+		"@vue/language-service": "3.2.5",
+		"@vue/typescript-plugin": "3.2.5",
 		"vscode-uri": "^3.0.8"
 	},
 	"peerDependencies": {
@@ -27,7 +27,7 @@
 	},
 	"devDependencies": {
 		"@typescript/server-harness": "latest",
-		"@volar/test-utils": "2.4.27"
+		"@volar/test-utils": "2.4.28"
 	},
-	"gitHead": "efc6882ab62a518b41ab5c8dc1d762c41c862ebc"
+	"gitHead": "ee5041d27940cf6f9a5150635d3b13140a9dff54"
 }