diff --git a/docs/users/configuration/settings.md b/docs/users/configuration/settings.md index 7df625a69..878c053b6 100644 --- a/docs/users/configuration/settings.md +++ b/docs/users/configuration/settings.md @@ -291,6 +291,15 @@ If you are experiencing performance issues with file searching (e.g., with `@` c > > **Security Note for MCP servers:** These settings use simple string matching on MCP server names, which can be modified. If you're a system administrator looking to prevent users from bypassing this, consider configuring the `mcpServers` at the system settings level such that the user will not be able to configure any MCP servers of their own. This should not be used as an airtight security mechanism. +#### lsp + +> [!warning] +> **Experimental Feature**: LSP support is currently experimental and disabled by default. Enable it using the `--experimental-lsp` command line flag. + +Language Server Protocol (LSP) provides code intelligence features like go-to-definition, find references, and diagnostics. + +LSP server configuration is done through `.lsp.json` files in your project root directory, not through `settings.json`. See the [LSP documentation](../features/lsp) for configuration details and examples. + #### security | Setting | Type | Description | Default | @@ -490,6 +499,7 @@ Arguments passed directly when running the CLI can override other configurations | `--checkpointing` | | Enables [checkpointing](../features/checkpointing). | | | | `--acp` | | Enables ACP mode (Agent Client Protocol). Useful for IDE/editor integrations like [Zed](../integration-zed). | | Stable. Replaces the deprecated `--experimental-acp` flag. | | `--experimental-skills` | | Enables experimental [Agent Skills](../features/skills) (registers the `skill` tool and loads Skills from `.qwen/skills/` and `~/.qwen/skills/`). | | Experimental. | +| `--experimental-lsp` | | Enables experimental [LSP (Language Server Protocol)](../features/lsp) feature for code intelligence (go-to-definition, find references, diagnostics, etc.). | | Experimental. Requires language servers to be installed. | | `--extensions` | `-e` | Specifies a list of extensions to use for the session. | Extension names | If not provided, all available extensions are used. Use the special term `qwen -e none` to disable all extensions. Example: `qwen -e my-extension -e my-other-extension` | | `--list-extensions` | `-l` | Lists all available extensions and exits. | | | | `--proxy` | | Sets the proxy for the CLI. | Proxy URL | Example: `--proxy http://localhost:7890`. | diff --git a/docs/users/features/_meta.ts b/docs/users/features/_meta.ts index 0cc6d63a8..0155b3ba4 100644 --- a/docs/users/features/_meta.ts +++ b/docs/users/features/_meta.ts @@ -8,6 +8,7 @@ export default { }, 'approval-mode': 'Approval Mode', mcp: 'MCP', + lsp: 'LSP (Language Server Protocol)', 'token-caching': 'Token Caching', sandbox: 'Sandboxing', language: 'i18n', diff --git a/docs/users/features/lsp.md b/docs/users/features/lsp.md new file mode 100644 index 000000000..c0ed7da9a --- /dev/null +++ b/docs/users/features/lsp.md @@ -0,0 +1,374 @@ +# Language Server Protocol (LSP) Support + +Qwen Code provides native Language Server Protocol (LSP) support, enabling advanced code intelligence features like go-to-definition, find references, diagnostics, and code actions. This integration allows the AI agent to understand your code more deeply and provide more accurate assistance. + +## Overview + +LSP support in Qwen Code works by connecting to language servers that understand your code. When you work with TypeScript, Python, Go, or other supported languages, Qwen Code can automatically start the appropriate language server and use it to: + +- Navigate to symbol definitions +- Find all references to a symbol +- Get hover information (documentation, type info) +- View diagnostic messages (errors, warnings) +- Access code actions (quick fixes, refactorings) +- Analyze call hierarchies + +## Quick Start + +LSP is an experimental feature in Qwen Code. To enable it, use the `--experimental-lsp` command line flag: + +```bash +qwen --experimental-lsp +``` + +For most common languages, Qwen Code will automatically detect and start the appropriate language server if it's installed on your system. + +### Prerequisites + +You need to have the language server for your programming language installed: + +| Language | Language Server | Install Command | +| --------------------- | -------------------------- | ------------------------------------------------------------------------------ | +| TypeScript/JavaScript | typescript-language-server | `npm install -g typescript-language-server typescript` | +| Python | pylsp | `pip install python-lsp-server` | +| Go | gopls | `go install golang.org/x/tools/gopls@latest` | +| Rust | rust-analyzer | [Installation guide](https://rust-analyzer.github.io/manual.html#installation) | + +## Configuration + +### .lsp.json File + +You can configure language servers using a `.lsp.json` file in your project root. This uses the language-keyed format described in the [Claude Code plugin LSP configuration reference](https://code.claude.com/docs/en/plugins-reference#lsp-servers). + +**Basic format:** + +```json +{ + "typescript": { + "command": "typescript-language-server", + "args": ["--stdio"], + "extensionToLanguage": { + ".ts": "typescript", + ".tsx": "typescriptreact", + ".js": "javascript", + ".jsx": "javascriptreact" + } + } +} +``` + +### Configuration Options + +#### Required Fields + +| Option | Type | Description | +| --------------------- | ------ | ------------------------------------------------- | +| `command` | string | Command to start the LSP server (must be in PATH) | +| `extensionToLanguage` | object | Maps file extensions to language identifiers | + +#### Optional Fields + +| Option | Type | Default | Description | +| ----------------------- | -------- | --------- | ------------------------------------------------------ | +| `args` | string[] | `[]` | Command line arguments | +| `transport` | string | `"stdio"` | Transport type: `stdio` or `socket` | +| `env` | object | - | Environment variables | +| `initializationOptions` | object | - | LSP initialization options | +| `settings` | object | - | Server settings via `workspace/didChangeConfiguration` | +| `workspaceFolder` | string | - | Override workspace folder | +| `startupTimeout` | number | `10000` | Startup timeout in milliseconds | +| `shutdownTimeout` | number | `5000` | Shutdown timeout in milliseconds | +| `restartOnCrash` | boolean | `false` | Auto-restart on crash | +| `maxRestarts` | number | `3` | Maximum restart attempts | +| `trustRequired` | boolean | `true` | Require trusted workspace | + +### TCP/Socket Transport + +For servers that use TCP or Unix socket transport: + +```json +{ + "remote-lsp": { + "transport": "tcp", + "socket": { + "host": "127.0.0.1", + "port": 9999 + }, + "extensionToLanguage": { + ".custom": "custom" + } + } +} +``` + +## Available LSP Operations + +Qwen Code exposes LSP functionality through the unified `lsp` tool. Here are the available operations: + +### Code Navigation + +#### Go to Definition + +Find where a symbol is defined. + +``` +Operation: goToDefinition +Parameters: + - filePath: Path to the file + - line: Line number (1-based) + - character: Column number (1-based) +``` + +#### Find References + +Find all references to a symbol. + +``` +Operation: findReferences +Parameters: + - filePath: Path to the file + - line: Line number (1-based) + - character: Column number (1-based) + - includeDeclaration: Include the declaration itself (optional) +``` + +#### Go to Implementation + +Find implementations of an interface or abstract method. + +``` +Operation: goToImplementation +Parameters: + - filePath: Path to the file + - line: Line number (1-based) + - character: Column number (1-based) +``` + +### Symbol Information + +#### Hover + +Get documentation and type information for a symbol. + +``` +Operation: hover +Parameters: + - filePath: Path to the file + - line: Line number (1-based) + - character: Column number (1-based) +``` + +#### Document Symbols + +Get all symbols in a document. + +``` +Operation: documentSymbol +Parameters: + - filePath: Path to the file +``` + +#### Workspace Symbol Search + +Search for symbols across the workspace. + +``` +Operation: workspaceSymbol +Parameters: + - query: Search query string + - limit: Maximum results (optional) +``` + +### Call Hierarchy + +#### Prepare Call Hierarchy + +Get the call hierarchy item at a position. + +``` +Operation: prepareCallHierarchy +Parameters: + - filePath: Path to the file + - line: Line number (1-based) + - character: Column number (1-based) +``` + +#### Incoming Calls + +Find all functions that call the given function. + +``` +Operation: incomingCalls +Parameters: + - callHierarchyItem: Item from prepareCallHierarchy +``` + +#### Outgoing Calls + +Find all functions called by the given function. + +``` +Operation: outgoingCalls +Parameters: + - callHierarchyItem: Item from prepareCallHierarchy +``` + +### Diagnostics + +#### File Diagnostics + +Get diagnostic messages (errors, warnings) for a file. + +``` +Operation: diagnostics +Parameters: + - filePath: Path to the file +``` + +#### Workspace Diagnostics + +Get all diagnostic messages across the workspace. + +``` +Operation: workspaceDiagnostics +Parameters: + - limit: Maximum results (optional) +``` + +### Code Actions + +#### Get Code Actions + +Get available code actions (quick fixes, refactorings) at a location. + +``` +Operation: codeActions +Parameters: + - filePath: Path to the file + - line: Start line number (1-based) + - character: Start column number (1-based) + - endLine: End line number (optional, defaults to line) + - endCharacter: End column (optional, defaults to character) + - diagnostics: Diagnostics to get actions for (optional) + - codeActionKinds: Filter by action kind (optional) +``` + +Code action kinds: + +- `quickfix` - Quick fixes for errors/warnings +- `refactor` - Refactoring operations +- `refactor.extract` - Extract to function/variable +- `refactor.inline` - Inline function/variable +- `source` - Source code actions +- `source.organizeImports` - Organize imports +- `source.fixAll` - Fix all auto-fixable issues + +## Security + +LSP servers are only started in trusted workspaces by default. This is because language servers run with your user permissions and can execute code. + +### Trust Controls + +- **Trusted Workspace**: LSP servers start automatically +- **Untrusted Workspace**: LSP servers won't start unless `trustRequired: false` is set in the server configuration + +To mark a workspace as trusted, use the `/trust` command or configure trusted folders in settings. + +### Per-Server Trust Override + +You can override trust requirements for specific servers in their configuration: + +```json +{ + "safe-server": { + "command": "safe-language-server", + "args": ["--stdio"], + "trustRequired": false, + "extensionToLanguage": { + ".safe": "safe" + } + } +} +``` + +## Troubleshooting + +### Server Not Starting + +1. **Check if the server is installed**: Run the command manually to verify +2. **Check the PATH**: Ensure the server binary is in your system PATH +3. **Check workspace trust**: The workspace must be trusted for LSP +4. **Check logs**: Look for error messages in the console output +5. **Verify --experimental-lsp flag**: Make sure you're using the flag when starting Qwen Code + +### Slow Performance + +1. **Large projects**: Consider excluding `node_modules` and other large directories +2. **Server timeout**: Increase `startupTimeout` in server configuration for slow servers + +### No Results + +1. **Server not ready**: The server may still be indexing +2. **File not saved**: Save your file for the server to pick up changes +3. **Wrong language**: Check if the correct server is running for your language + +### Debugging + +Enable debug logging to see LSP communication: + +```bash +DEBUG=lsp* qwen --experimental-lsp +``` + +Or check the LSP debugging guide at `packages/cli/LSP_DEBUGGING_GUIDE.md`. + +## Claude Code Compatibility + +Qwen Code supports Claude Code-style `.lsp.json` configuration files in the language-keyed format defined in the [Claude Code plugins reference](https://code.claude.com/docs/en/plugins-reference#lsp-servers). If you're migrating from Claude Code, use the language-as-key layout in your configuration. + +### Configuration Format + +The recommended format follows Claude Code's specification: + +```json +{ + "go": { + "command": "gopls", + "args": ["serve"], + "extensionToLanguage": { + ".go": "go" + } + } +} +``` + +Claude Code LSP plugins can also supply `lspServers` in `plugin.json` (or a referenced `.lsp.json`). Qwen Code loads those configs when the extension is enabled, and they must use the same language-keyed format. + +## Best Practices + +1. **Install language servers globally**: This ensures they're available in all projects +2. **Use project-specific settings**: Configure server options per project when needed via `.lsp.json` +3. **Keep servers updated**: Update your language servers regularly for best results +4. **Trust wisely**: Only trust workspaces from trusted sources + +## FAQ + +### Q: How do I enable LSP? + +Use the `--experimental-lsp` flag when starting Qwen Code: + +```bash +qwen --experimental-lsp +``` + +### Q: How do I know which language servers are running? + +Use the `/lsp status` command to see all configured and running language servers. + +### Q: Can I use multiple language servers for the same file type? + +Yes, but only one will be used for each operation. The first server that returns results wins. + +### Q: Does LSP work in sandbox mode? + +LSP servers run outside the sandbox to access your code. They're subject to workspace trust controls. diff --git a/package-lock.json b/package-lock.json index 36b34d377..590630a59 100644 --- a/package-lock.json +++ b/package-lock.json @@ -596,6 +596,7 @@ } ], "license": "MIT", + "peer": true, "engines": { "node": ">=18" }, @@ -619,6 +620,7 @@ } ], "license": "MIT", + "peer": true, "engines": { "node": ">=18" } @@ -1933,6 +1935,7 @@ "resolved": "https://registry.npmjs.org/@opentelemetry/api/-/api-1.9.0.tgz", "integrity": "sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg==", "license": "Apache-2.0", + "peer": true, "engines": { "node": ">=8.0.0" } @@ -2447,7 +2450,6 @@ "hasInstallScript": true, "license": "MIT", "optional": true, - "peer": true, "dependencies": { "detect-libc": "^1.0.3", "is-glob": "^4.0.3", @@ -2490,7 +2492,6 @@ "os": [ "android" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2512,7 +2513,6 @@ "os": [ "darwin" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2534,7 +2534,6 @@ "os": [ "darwin" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2556,7 +2555,6 @@ "os": [ "freebsd" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2578,7 +2576,6 @@ "os": [ "linux" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2600,7 +2597,6 @@ "os": [ "linux" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2622,7 +2618,6 @@ "os": [ "linux" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2644,7 +2639,6 @@ "os": [ "linux" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2666,7 +2660,6 @@ "os": [ "linux" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2688,7 +2681,6 @@ "os": [ "linux" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2710,7 +2702,6 @@ "os": [ "win32" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2732,7 +2723,6 @@ "os": [ "win32" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2754,7 +2744,6 @@ "os": [ "win32" ], - "peer": true, "engines": { "node": ">= 10.0.0" }, @@ -2770,7 +2759,6 @@ "dev": true, "license": "Apache-2.0", "optional": true, - "peer": true, "bin": { "detect-libc": "bin/detect-libc.js" }, @@ -2784,8 +2772,7 @@ "integrity": "sha512-5m3bsyrjFWE1xf7nz7YXdN4udnVtXK6/Yfgn5qnahL6bCkf2yKt4k3nuTKAtT4r3IG8JNR2ncsIMdZuAzJjHQQ==", "dev": true, "license": "MIT", - "optional": true, - "peer": true + "optional": true }, "node_modules/@pkgjs/parseargs": { "version": "0.11.0", @@ -3428,6 +3415,7 @@ "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-10.4.1.tgz", "integrity": "sha512-o4PXJQidqJl82ckFaXUeoAW+XysPLauYI43Abki5hABd853iMhitooc6znOnczgbTYmEP6U6/y1ZyKAIsvMKGg==", "license": "MIT", + "peer": true, "dependencies": { "@babel/code-frame": "^7.10.4", "@babel/runtime": "^7.12.5", @@ -3885,13 +3873,6 @@ "kleur": "^3.0.3" } }, - "node_modules/@types/prop-types": { - "version": "15.7.15", - "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.15.tgz", - "integrity": "sha512-F6bEyamV9jKGAFBEmlQnesRPGOQqS2+Uwi0Em15xenOxHaf2hv6L8YCVn3rPdPJOiJfPiCnLIRyvwVaqMY3MIw==", - "dev": true, - "license": "MIT" - }, "node_modules/@types/qrcode-terminal": { "version": "0.12.2", "resolved": "https://registry.npmjs.org/@types/qrcode-terminal/-/qrcode-terminal-0.12.2.tgz", @@ -3919,6 +3900,7 @@ "integrity": "sha512-AwAfQ2Wa5bCx9WP8nZL2uMZWod7J7/JSplxbTmBQ5ms6QpqNYm672H0Vu9ZVKVngQ+ii4R/byguVEUZQyeg44g==", "devOptional": true, "license": "MIT", + "peer": true, "dependencies": { "csstype": "^3.0.2" } @@ -3929,6 +3911,7 @@ "integrity": "sha512-4hOiT/dwO8Ko0gV1m/TJZYk3y0KBnY9vzDh7W+DH17b2HFSOGgdj33dhihPeuy3l0q23+4e+hoXHV6hCC4dCXw==", "dev": true, "license": "MIT", + "peer": true, "peerDependencies": { "@types/react": "^19.0.0" } @@ -4134,6 +4117,7 @@ "integrity": "sha512-6sMvZePQrnZH2/cJkwRpkT7DxoAWh+g6+GFRK6bV3YQo7ogi3SX5rgF6099r5Q53Ma5qeT7LGmOmuIutF4t3lA==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@typescript-eslint/scope-manager": "8.35.0", "@typescript-eslint/types": "8.35.0", @@ -4908,6 +4892,7 @@ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "license": "MIT", + "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -5315,8 +5300,7 @@ "version": "1.1.1", "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==", - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/array-includes": { "version": "3.1.9", @@ -5894,6 +5878,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "baseline-browser-mapping": "^2.8.25", "caniuse-lite": "^1.0.30001754", @@ -6646,7 +6631,6 @@ "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz", "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==", "license": "MIT", - "peer": true, "dependencies": { "safe-buffer": "5.2.1" }, @@ -7771,6 +7755,7 @@ "integrity": "sha512-GsGizj2Y1rCWDu6XoEekL3RLilp0voSePurjZIkxL3wlm5o5EC9VpgaP7lrCvjnkuLvzFBQWB3vWB3K5KQTveQ==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.12.1", @@ -8305,7 +8290,6 @@ "resolved": "https://registry.npmjs.org/express/-/express-4.21.2.tgz", "integrity": "sha512-28HqgMZAmih1Czt9ny7qr6ek2qddF4FclbMzwhCREB6OFfH+rXAnuNCwo1/wFvrtbgsQDb4kSbX9de9lFbrXnA==", "license": "MIT", - "peer": true, "dependencies": { "accepts": "~1.3.8", "array-flatten": "1.1.1", @@ -8367,7 +8351,6 @@ "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.1.tgz", "integrity": "sha512-6DnInpx7SJ2AK3+CTUE/ZM0vWTUboZCegxhC2xiIydHR9jNuTAASBrfEpHhiGOZw/nX51bHt6YQl8jsGo4y/0w==", "license": "MIT", - "peer": true, "engines": { "node": ">= 0.6" } @@ -8377,7 +8360,6 @@ "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", "license": "MIT", - "peer": true, "dependencies": { "ms": "2.0.0" } @@ -8387,7 +8369,6 @@ "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz", "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==", "license": "MIT", - "peer": true, "engines": { "node": ">= 0.8" } @@ -8578,7 +8559,6 @@ "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.3.1.tgz", "integrity": "sha512-6BN9trH7bp3qvnrRyzsBz+g3lZxTNZTbVO2EV1CS0WIcDbawYVdYvGflME/9QP0h0pYlCDBCTjYa9nZzMDpyxQ==", "license": "MIT", - "peer": true, "dependencies": { "debug": "2.6.9", "encodeurl": "~2.0.0", @@ -8597,7 +8577,6 @@ "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", "license": "MIT", - "peer": true, "dependencies": { "ms": "2.0.0" } @@ -8606,15 +8585,13 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/finalhandler/node_modules/statuses": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz", "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==", "license": "MIT", - "peer": true, "engines": { "node": ">= 0.8" } @@ -9603,8 +9580,7 @@ "integrity": "sha512-p6u1bG3YSnINT5RQmx/yRZBpenIl30kVxkTLDyHLIMk0gict704Q9n+thfDI7lTRm9vXdDYutVzXhzcThxTnXA==", "dev": true, "license": "MIT", - "optional": true, - "peer": true + "optional": true }, "node_modules/import-fresh": { "version": "3.3.1", @@ -9701,6 +9677,7 @@ "resolved": "https://registry.npmjs.org/ink/-/ink-6.2.3.tgz", "integrity": "sha512-fQkfEJjKbLXIcVWEE3MvpYSnwtbbmRsmeNDNz1pIuOFlwE+UF2gsy228J36OXKZGWJWZJKUigphBSqCNMcARtg==", "license": "MIT", + "peer": true, "dependencies": { "@alcalzone/ansi-tokenize": "^0.2.0", "ansi-escapes": "^7.0.0", @@ -10696,6 +10673,7 @@ "integrity": "sha512-/imKNG4EbWNrVjoNC/1H5/9GFy+tqjGBHCaSsN+P2RnPqjsLmv6UD3Ej+Kj8nBWaRAwyk7kK5ZUc+OEatnTR3A==", "dev": true, "license": "MIT", + "peer": true, "bin": { "jiti": "bin/jiti.js" } @@ -11680,7 +11658,6 @@ "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", "integrity": "sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==", "license": "MIT", - "peer": true, "engines": { "node": ">= 0.6" } @@ -12981,8 +12958,7 @@ "version": "0.1.12", "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.12.tgz", "integrity": "sha512-RA1GjUVMnvYFxuqovrEqZoxxW5NUZqbwKtYz/Tt7nXerk0LbLblQmrsgdeOxV5SFHf0UDggjS/bSeOZwt1pmEQ==", - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/path-type": { "version": "3.0.0", @@ -13142,6 +13118,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -13655,6 +13632,7 @@ "resolved": "https://registry.npmjs.org/react/-/react-19.1.0.tgz", "integrity": "sha512-FS+XFBNvn3GTAWq26joslQgWNoFu08F4kl0J4CgdNKADkdSGXQyTCnKteIAJy96Br6YbpEU1LSzV5dYtjMkMDg==", "license": "MIT", + "peer": true, "engines": { "node": ">=0.10.0" } @@ -13665,6 +13643,7 @@ "integrity": "sha512-cq/o30z9W2Wb4rzBefjv5fBalHU0rJGZCHAkf/RHSBWSSYwh8PlQTqqOJmgIIbBtpj27T6FIPXeomIjZtCNVqA==", "devOptional": true, "license": "MIT", + "peer": true, "dependencies": { "shell-quote": "^1.6.1", "ws": "^7" @@ -13698,6 +13677,7 @@ "integrity": "sha512-Xs1hdnE+DyKgeHJeJznQmYMIBG3TKIHJJT95Q58nHLSrElKlGQqDTR2HQ9fx5CN/Gk6Vh/kupBTDLU11/nDk/g==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "scheduler": "^0.26.0" }, @@ -14339,29 +14319,6 @@ "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", "license": "MIT" }, - "node_modules/sass": { - "version": "1.94.2", - "resolved": "https://registry.npmjs.org/sass/-/sass-1.94.2.tgz", - "integrity": "sha512-N+7WK20/wOr7CzA2snJcUSSNTCzeCGUTFY3OgeQP3mZ1aj9NMQ0mSTXwlrnd89j33zzQJGqIN52GIOmYrfq46A==", - "dev": true, - "license": "MIT", - "optional": true, - "peer": true, - "dependencies": { - "chokidar": "^4.0.0", - "immutable": "^5.0.2", - "source-map-js": ">=0.6.2 <2.0.0" - }, - "bin": { - "sass": "sass.js" - }, - "engines": { - "node": ">=14.0.0" - }, - "optionalDependencies": { - "@parcel/watcher": "^2.4.1" - } - }, "node_modules/sax": { "version": "1.4.1", "resolved": "https://registry.npmjs.org/sax/-/sax-1.4.1.tgz", @@ -15760,6 +15717,7 @@ "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -15939,7 +15897,8 @@ "version": "2.8.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", - "license": "0BSD" + "license": "0BSD", + "peer": true }, "node_modules/tsx": { "version": "4.20.3", @@ -15947,6 +15906,7 @@ "integrity": "sha512-qjbnuR9Tr+FJOMBqJCW5ehvIo/buZq7vH7qD7JziU98h6l3qGy0a/yPFjwO+y0/T7GFpNgNAvEcPPVfyT8rrPQ==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "esbuild": "~0.25.0", "get-tsconfig": "^4.7.5" @@ -16141,6 +16101,7 @@ "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==", "dev": true, "license": "Apache-2.0", + "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -16449,7 +16410,6 @@ "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", "integrity": "sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==", "license": "MIT", - "peer": true, "engines": { "node": ">= 0.4.0" } @@ -16505,6 +16465,7 @@ "integrity": "sha512-ixXJB1YRgDIw2OszKQS9WxGHKwLdCsbQNkpJN171udl6szi/rIySHL6/Os3s2+oE4P/FLD4dxg4mD7Wust+u5g==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "esbuild": "^0.25.0", "fdir": "^6.4.6", @@ -16618,6 +16579,7 @@ "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -16631,6 +16593,7 @@ "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@types/chai": "^5.2.2", "@vitest/expect": "3.2.4", @@ -17138,6 +17101,7 @@ "integrity": "sha512-lcYcMxX2PO9XMGvAJkJ3OsNMw+/7FKes7/hgerGUYWIoWu5j/+YQqcZr5JnPZWzOsEBgMbSbiSTn/dv/69Mkpw==", "dev": true, "license": "ISC", + "peer": true, "bin": { "yaml": "bin.mjs" }, @@ -17318,6 +17282,7 @@ "resolved": "https://registry.npmjs.org/zod/-/zod-3.25.76.tgz", "integrity": "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ==", "license": "MIT", + "peer": true, "funding": { "url": "https://github.com/sponsors/colinhacks" } @@ -17417,6 +17382,7 @@ "resolved": "https://registry.npmjs.org/@modelcontextprotocol/sdk/-/sdk-1.25.1.tgz", "integrity": "sha512-yO28oVFFC7EBoiKdAn+VqRm+plcfv4v0xp6osG/VsCB0NlPZWi87ajbCZZ8f/RvOFLEu7//rSRmuZZ7lMoe3gQ==", "license": "MIT", + "peer": true, "dependencies": { "@hono/node-server": "^1.19.7", "ajv": "^8.17.1", @@ -18063,6 +18029,7 @@ "resolved": "https://registry.npmjs.org/@modelcontextprotocol/sdk/-/sdk-1.25.1.tgz", "integrity": "sha512-yO28oVFFC7EBoiKdAn+VqRm+plcfv4v0xp6osG/VsCB0NlPZWi87ajbCZZ8f/RvOFLEu7//rSRmuZZ7lMoe3gQ==", "license": "MIT", + "peer": true, "dependencies": { "@hono/node-server": "^1.19.7", "ajv": "^8.17.1", @@ -18474,6 +18441,7 @@ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -19236,6 +19204,7 @@ "integrity": "sha512-4Z+L8I2OqhZV8qA132M4wNL30ypZGYOQVBfMgxDH/K5UX0PNqTu1c6za9ST5r9+tavvHiTWmBnKzpCJ/GlVFtg==", "dev": true, "license": "BSD-2-Clause", + "peer": true, "dependencies": { "@typescript-eslint/scope-manager": "7.18.0", "@typescript-eslint/types": "7.18.0", @@ -19733,6 +19702,7 @@ "deprecated": "This version is no longer supported. Please see https://eslint.org/version-support for other options.", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.6.1", @@ -20859,6 +20829,7 @@ "integrity": "sha512-Ljb1cnSJSivGN0LqXd/zmDbWEM0RNNg2t1QW/XUhYl/qPqyu7CsqeWtqQXHVaJsecLPuDoak2oJcZN2QoRIOag==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@vitest/expect": "1.6.1", "@vitest/runner": "1.6.1", @@ -21522,27 +21493,6 @@ "zod": "^3.25 || ^4" } }, - "packages/vscode-ide-companion/node_modules/@types/react": { - "version": "18.3.27", - "resolved": "https://registry.npmjs.org/@types/react/-/react-18.3.27.tgz", - "integrity": "sha512-cisd7gxkzjBKU2GgdYrTdtQx1SORymWyaAFhaxQPK9bYO9ot3Y5OikQRvY0VYQtvwjeQnizCINJAenh/V7MK2w==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/prop-types": "*", - "csstype": "^3.2.2" - } - }, - "packages/vscode-ide-companion/node_modules/@types/react-dom": { - "version": "18.3.7", - "resolved": "https://registry.npmjs.org/@types/react-dom/-/react-dom-18.3.7.tgz", - "integrity": "sha512-MEe3UeoENYVFXzoXEWsvcpg6ZvlrFNlOQ7EOsvhI3CfAXwzPfO8Qwuxd40nepsYKqyyVQnTdEfv68q91yLcKrQ==", - "dev": true, - "license": "MIT", - "peerDependencies": { - "@types/react": "^18.0.0" - } - }, "packages/vscode-ide-companion/node_modules/@types/semver": { "version": "7.7.1", "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.7.1.tgz", @@ -21585,13 +21535,6 @@ "node": ">= 0.6" } }, - "packages/vscode-ide-companion/node_modules/csstype": { - "version": "3.2.3", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", - "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", - "dev": true, - "license": "MIT" - }, "packages/vscode-ide-companion/node_modules/express": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/express/-/express-5.1.0.tgz", @@ -21672,40 +21615,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "packages/vscode-ide-companion/node_modules/react": { - "version": "18.3.1", - "resolved": "https://registry.npmjs.org/react/-/react-18.3.1.tgz", - "integrity": "sha512-wS+hAgJShR0KhEvPJArfuPVN1+Hz1t0Y6n5jLrGQbkb4urgPE/0Rve+1kMB1v/oWgHgm4WIcV+i7F2pTVj+2iQ==", - "license": "MIT", - "dependencies": { - "loose-envify": "^1.1.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "packages/vscode-ide-companion/node_modules/react-dom": { - "version": "18.3.1", - "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-18.3.1.tgz", - "integrity": "sha512-5m4nQKp+rZRb09LNH59GM4BxTh9251/ylbKIbpe7TpGxfJ+9kv6BLkLBXIjjspbgbnIBNqlI23tRnTWT0snUIw==", - "license": "MIT", - "dependencies": { - "loose-envify": "^1.1.0", - "scheduler": "^0.23.2" - }, - "peerDependencies": { - "react": "^18.3.1" - } - }, - "packages/vscode-ide-companion/node_modules/scheduler": { - "version": "0.23.2", - "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.2.tgz", - "integrity": "sha512-UOShsPwz7NrMUqhR6t0hWjFduvOzbtv7toDH1/hIrfRNIDBnnBWd0CwJTGvTpngVlmwGCdP9/Zl/tVrDqcuYzQ==", - "license": "MIT", - "dependencies": { - "loose-envify": "^1.1.0" - } - }, "packages/vscode-ide-companion/node_modules/send": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/send/-/send-1.2.0.tgz", diff --git a/packages/cli/src/config/config.test.ts b/packages/cli/src/config/config.test.ts index acc1fe54e..67d3b114b 100644 --- a/packages/cli/src/config/config.test.ts +++ b/packages/cli/src/config/config.test.ts @@ -13,18 +13,48 @@ import { WriteFileTool, DEFAULT_QWEN_MODEL, OutputFormat, + NativeLspService, } from '@qwen-code/qwen-code-core'; import { loadCliConfig, parseArguments, type CliArgs } from './config.js'; import type { Settings } from './settings.js'; import * as ServerConfig from '@qwen-code/qwen-code-core'; import { isWorkspaceTrusted } from './trustedFolders.js'; +const createNativeLspServiceInstance = () => ({ + discoverAndPrepare: vi.fn(), + start: vi.fn(), + definitions: vi.fn().mockResolvedValue([]), + references: vi.fn().mockResolvedValue([]), + workspaceSymbols: vi.fn().mockResolvedValue([]), + hover: vi.fn().mockResolvedValue(null), + documentSymbols: vi.fn().mockResolvedValue([]), + implementations: vi.fn().mockResolvedValue([]), + prepareCallHierarchy: vi.fn().mockResolvedValue([]), + incomingCalls: vi.fn().mockResolvedValue([]), + outgoingCalls: vi.fn().mockResolvedValue([]), + diagnostics: vi.fn().mockResolvedValue([]), + workspaceDiagnostics: vi.fn().mockResolvedValue([]), + codeActions: vi.fn().mockResolvedValue([]), + applyWorkspaceEdit: vi.fn().mockResolvedValue(false), +}); + vi.mock('./trustedFolders.js', () => ({ isWorkspaceTrusted: vi .fn() .mockReturnValue({ isTrusted: true, source: 'file' }), // Default to trusted })); +const nativeLspServiceMock = vi.mocked(NativeLspService); +const getLastLspInstance = () => { + const results = nativeLspServiceMock.mock.results; + if (results.length === 0) { + return undefined; + } + return results[results.length - 1]?.value as ReturnType< + typeof createNativeLspServiceInstance + >; +}; + vi.mock('fs', async (importOriginal) => { const actualFs = await importOriginal(); const pathMod = await import('node:path'); @@ -79,6 +109,9 @@ vi.mock('@qwen-code/qwen-code-core', async (importOriginal) => { const actualServer = await importOriginal(); return { ...actualServer, + NativeLspService: vi + .fn() + .mockImplementation(() => createNativeLspServiceInstance()), IdeClient: { getInstance: vi.fn().mockResolvedValue({ getConnectionStatus: vi.fn(), @@ -514,6 +547,10 @@ describe('loadCliConfig', () => { beforeEach(() => { vi.resetAllMocks(); + nativeLspServiceMock.mockReset(); + nativeLspServiceMock.mockImplementation( + () => createNativeLspServiceInstance() as unknown as NativeLspService, + ); vi.mocked(os.homedir).mockReturnValue('/mock/home/user'); vi.stubEnv('GEMINI_API_KEY', 'test-api-key'); }); @@ -543,6 +580,22 @@ describe('loadCliConfig', () => { expect(config.getIncludePartialMessages()).toBe(true); }); + it('should initialize native LSP service when enabled', async () => { + process.argv = ['node', 'script.js', '--experimental-lsp']; + const argv = await parseArguments({} as Settings); + const settings: Settings = {}; + + const config = await loadCliConfig(settings, argv); + + // LSP is enabled via --experimental-lsp flag + expect(config.isLspEnabled()).toBe(true); + expect(nativeLspServiceMock).toHaveBeenCalledTimes(1); + const lspInstance = getLastLspInstance(); + expect(lspInstance).toBeDefined(); + expect(lspInstance?.discoverAndPrepare).toHaveBeenCalledTimes(1); + expect(lspInstance?.start).toHaveBeenCalledTimes(1); + }); + describe('Proxy configuration', () => { const originalProxyEnv: { [key: string]: string | undefined } = {}; const proxyEnvVars = [ diff --git a/packages/cli/src/config/config.ts b/packages/cli/src/config/config.ts index eadc35c27..d4752d4be 100755 --- a/packages/cli/src/config/config.ts +++ b/packages/cli/src/config/config.ts @@ -20,11 +20,15 @@ import { OutputFormat, isToolEnabled, SessionService, + ideContextStore, type ResumedSessionData, + type LspClient, type ToolName, EditTool, ShellTool, WriteFileTool, + NativeLspClient, + NativeLspService, } from '@qwen-code/qwen-code-core'; import { extensionsCommand } from '../commands/extensions.js'; import type { Settings } from './settings.js'; @@ -113,6 +117,7 @@ export interface CliArgs { acp: boolean | undefined; experimentalAcp: boolean | undefined; experimentalSkills: boolean | undefined; + experimentalLsp: boolean | undefined; extensions: string[] | undefined; listExtensions: boolean | undefined; openaiLogging: boolean | undefined; @@ -331,6 +336,12 @@ export async function parseArguments(settings: Settings): Promise { return settings.experimental?.skills ?? legacySkills ?? false; })(), }) + .option('experimental-lsp', { + type: 'boolean', + description: + 'Enable experimental LSP (Language Server Protocol) feature for code intelligence', + default: false, + }) .option('channel', { type: 'string', choices: ['VSCode', 'ACP', 'SDK', 'CI'], @@ -713,6 +724,9 @@ export async function loadCliConfig( .map(resolvePath) .concat((argv.includeDirectories || []).map(resolvePath)); + // LSP configuration: enabled only via --experimental-lsp flag + const lspEnabled = argv.experimentalLsp === true; + let lspClient: LspClient | undefined; const question = argv.promptInteractive || argv.prompt || ''; const inputFormat: InputFormat = (argv.inputFormat as InputFormat | undefined) ?? InputFormat.TEXT; @@ -924,7 +938,7 @@ export async function loadCliConfig( const modelProvidersConfig = settings.modelProviders; - return new Config({ + const config = new Config({ sessionId, sessionData, embeddingModel: DEFAULT_QWEN_EMBEDDING_MODEL, @@ -1016,7 +1030,34 @@ export async function loadCliConfig( // always be true and the settings file can never disable recording. chatRecording: argv.chatRecording ?? settings.general?.chatRecording ?? true, + lsp: { + enabled: lspEnabled, + }, }); + + if (lspEnabled) { + try { + const lspService = new NativeLspService( + config, + config.getWorkspaceContext(), + appEvents, + fileService, + ideContextStore, + { + requireTrustedWorkspace: folderTrust, + }, + ); + + await lspService.discoverAndPrepare(); + await lspService.start(); + lspClient = new NativeLspClient(lspService); + config.setLspClient(lspClient); + } catch (err) { + logger.warn('Failed to initialize native LSP service:', err); + } + } + + return config; } function mergeExcludeTools( diff --git a/packages/cli/src/gemini.test.tsx b/packages/cli/src/gemini.test.tsx index 896a11865..25db908c4 100644 --- a/packages/cli/src/gemini.test.tsx +++ b/packages/cli/src/gemini.test.tsx @@ -488,6 +488,7 @@ describe('gemini.tsx main function kitty protocol', () => { excludeTools: undefined, authType: undefined, maxSessionTurns: undefined, + experimentalLsp: undefined, channel: undefined, chatRecording: undefined, }); diff --git a/packages/core/src/config/config.ts b/packages/core/src/config/config.ts index 1285635e7..63d3f57ba 100644 --- a/packages/core/src/config/config.ts +++ b/packages/core/src/config/config.ts @@ -61,6 +61,8 @@ import { ToolRegistry } from '../tools/tool-registry.js'; import { WebFetchTool } from '../tools/web-fetch.js'; import { WebSearchTool } from '../tools/web-search/index.js'; import { WriteFileTool } from '../tools/write-file.js'; +import { LspTool } from '../tools/lsp.js'; +import type { LspClient } from '../lsp/types.js'; // Other modules import { ideContextStore } from '../ide/ideContext.js'; @@ -288,6 +290,10 @@ export interface ConfigParameters { toolCallCommand?: string; mcpServerCommand?: string; mcpServers?: Record; + lsp?: { + enabled?: boolean; + }; + lspClient?: LspClient; userMemory?: string; geminiMdFileCount?: number; approvalMode?: ApprovalMode; @@ -431,6 +437,8 @@ export class Config { private readonly toolCallCommand: string | undefined; private readonly mcpServerCommand: string | undefined; private mcpServers: Record | undefined; + private readonly lspEnabled: boolean; + private lspClient?: LspClient; private readonly allowedMcpServers?: string[]; private readonly excludedMcpServers?: string[]; private sessionSubagents: SubagentConfig[]; @@ -534,6 +542,8 @@ export class Config { this.toolCallCommand = params.toolCallCommand; this.mcpServerCommand = params.mcpServerCommand; this.mcpServers = params.mcpServers; + this.lspEnabled = params.lsp?.enabled ?? false; + this.lspClient = params.lspClient; this.allowedMcpServers = params.allowedMcpServers; this.excludedMcpServers = params.excludedMcpServers; this.sessionSubagents = params.sessionSubagents ?? []; @@ -1095,6 +1105,24 @@ export class Config { this.mcpServers = { ...this.mcpServers, ...servers }; } + isLspEnabled(): boolean { + return this.lspEnabled; + } + + getLspClient(): LspClient | undefined { + return this.lspClient; + } + + /** + * Allows wiring an LSP client after Config construction but before initialize(). + */ + setLspClient(client: LspClient | undefined): void { + if (this.initialized) { + throw new Error('Cannot set LSP client after initialization'); + } + this.lspClient = client; + } + getSessionSubagents(): SubagentConfig[] { return this.sessionSubagents; } @@ -1642,6 +1670,10 @@ export class Config { if (this.getWebSearchConfig()) { registerCoreTool(WebSearchTool, this); } + if (this.isLspEnabled() && this.getLspClient()) { + // Register the unified LSP tool + registerCoreTool(LspTool, this); + } await registry.discoverAllTools(); console.debug('ToolRegistry created', registry.getAllToolNames()); diff --git a/packages/core/src/extension/claude-converter.test.ts b/packages/core/src/extension/claude-converter.test.ts index 079d46b19..b4d16c8f4 100644 --- a/packages/core/src/extension/claude-converter.test.ts +++ b/packages/core/src/extension/claude-converter.test.ts @@ -48,6 +48,26 @@ describe('convertClaudeToQwenConfig', () => { expect(result.mcpServers).toBeUndefined(); }); + it('should preserve lspServers configuration', () => { + const claudeConfig: ClaudePluginConfig = { + name: 'lsp-plugin', + version: '1.0.0', + lspServers: { + typescript: { + command: 'typescript-language-server', + args: ['--stdio'], + extensionToLanguage: { + '.ts': 'typescript', + }, + }, + }, + }; + + const result = convertClaudeToQwenConfig(claudeConfig); + + expect(result.lspServers).toEqual(claudeConfig.lspServers); + }); + it('should throw error for missing name', () => { const invalidConfig = { version: '1.0.0', diff --git a/packages/core/src/extension/claude-converter.ts b/packages/core/src/extension/claude-converter.ts index a27084ed7..84dab93cf 100644 --- a/packages/core/src/extension/claude-converter.ts +++ b/packages/core/src/extension/claude-converter.ts @@ -39,7 +39,7 @@ export interface ClaudePluginConfig { hooks?: string; mcpServers?: string | Record; outputStyles?: string | string[]; - lspServers?: string; + lspServers?: string | Record; } /** @@ -318,17 +318,12 @@ export function convertClaudeToQwenConfig( `[Claude Converter] Output styles are not yet supported in ${claudeConfig.name}`, ); } - if (claudeConfig.lspServers) { - console.warn( - `[Claude Converter] LSP servers are not yet supported in ${claudeConfig.name}`, - ); - } - // Direct field mapping - commands, skills, agents will be collected as folders return { name: claudeConfig.name, version: claudeConfig.version, mcpServers, + lspServers: claudeConfig.lspServers, }; } diff --git a/packages/core/src/extension/extensionManager.ts b/packages/core/src/extension/extensionManager.ts index 921d34739..72ffdb3df 100644 --- a/packages/core/src/extension/extensionManager.ts +++ b/packages/core/src/extension/extensionManager.ts @@ -100,6 +100,7 @@ export interface ExtensionConfig { name: string; version: string; mcpServers?: Record; + lspServers?: string | Record; contextFileName?: string | string[]; commands?: string | string[]; skills?: string | string[]; diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts index a1bf7e828..a9c091a08 100644 --- a/packages/core/src/index.ts +++ b/packages/core/src/index.ts @@ -139,6 +139,18 @@ export * from './tools/skill.js'; export * from './tools/todoWrite.js'; export * from './tools/exitPlanMode.js'; +// Export LSP types and tools +export * from './lsp/types.js'; +export * from './lsp/constants.js'; +export * from './lsp/LspConfigLoader.js'; +export * from './lsp/LspConnectionFactory.js'; +export * from './lsp/LspLanguageDetector.js'; +export * from './lsp/LspResponseNormalizer.js'; +export * from './lsp/LspServerManager.js'; +export * from './lsp/NativeLspClient.js'; +export * from './lsp/NativeLspService.js'; +export * from './tools/lsp.js'; + // MCP OAuth export { MCPOAuthProvider } from './mcp/oauth-provider.js'; export type { diff --git a/packages/core/src/lsp/LspConfigLoader.test.ts b/packages/core/src/lsp/LspConfigLoader.test.ts new file mode 100644 index 000000000..9f0ee8548 --- /dev/null +++ b/packages/core/src/lsp/LspConfigLoader.test.ts @@ -0,0 +1,90 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +import { describe, it, expect, afterEach } from 'vitest'; +import mock from 'mock-fs'; +import { LspConfigLoader } from './LspConfigLoader.js'; +import type { Extension } from '../extension/extensionManager.js'; + +describe('LspConfigLoader extension configs', () => { + const workspaceRoot = '/workspace'; + const extensionPath = '/extensions/ts-plugin'; + + afterEach(() => { + mock.restore(); + }); + + it('loads inline lspServers config from extension', async () => { + const loader = new LspConfigLoader(workspaceRoot); + const extension = { + id: 'ts-plugin', + name: 'ts-plugin', + version: '1.0.0', + isActive: true, + path: extensionPath, + contextFiles: [], + config: { + name: 'ts-plugin', + version: '1.0.0', + lspServers: { + typescript: { + command: 'typescript-language-server', + args: ['--stdio'], + extensionToLanguage: { + '.ts': 'typescript', + }, + }, + }, + }, + } as Extension; + + const configs = await loader.loadExtensionConfigs([extension]); + + expect(configs).toHaveLength(1); + expect(configs[0]?.languages).toEqual(['typescript']); + expect(configs[0]?.command).toBe('typescript-language-server'); + expect(configs[0]?.args).toEqual(['--stdio']); + }); + + it('loads lspServers config from referenced file and hydrates variables', async () => { + mock({ + [extensionPath]: { + '.lsp.json': JSON.stringify({ + typescript: { + command: 'typescript-language-server', + args: ['--stdio'], + env: { + EXT_ROOT: '${CLAUDE_PLUGIN_ROOT}', + }, + extensionToLanguage: { + '.ts': 'typescript', + }, + }, + }), + }, + }); + + const loader = new LspConfigLoader(workspaceRoot); + const extension = { + id: 'ts-plugin', + name: 'ts-plugin', + version: '1.0.0', + isActive: true, + path: extensionPath, + contextFiles: [], + config: { + name: 'ts-plugin', + version: '1.0.0', + lspServers: './.lsp.json', + }, + } as Extension; + + const configs = await loader.loadExtensionConfigs([extension]); + + expect(configs).toHaveLength(1); + expect(configs[0]?.env?.['EXT_ROOT']).toBe(extensionPath); + }); +}); diff --git a/packages/core/src/lsp/LspConfigLoader.ts b/packages/core/src/lsp/LspConfigLoader.ts new file mode 100644 index 000000000..b091a957a --- /dev/null +++ b/packages/core/src/lsp/LspConfigLoader.ts @@ -0,0 +1,493 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +import * as fs from 'node:fs'; +import * as path from 'path'; +import { pathToFileURL } from 'url'; +import { + recursivelyHydrateStrings, + type JsonValue, +} from '../extension/variables.js'; +import type { Extension } from '../extension/extensionManager.js'; +import type { + LspInitializationOptions, + LspServerConfig, + LspSocketOptions, +} from './types.js'; + +export class LspConfigLoader { + constructor(private readonly workspaceRoot: string) {} + + /** + * Load user .lsp.json configuration. + * Supports basic format: { "language": { "command": "...", "extensionToLanguage": {...} } } + */ + async loadUserConfigs(): Promise { + const lspConfigPath = path.join(this.workspaceRoot, '.lsp.json'); + if (!fs.existsSync(lspConfigPath)) { + return []; + } + + try { + const configContent = fs.readFileSync(lspConfigPath, 'utf-8'); + const data = JSON.parse(configContent); + return this.parseConfigSource(data, lspConfigPath); + } catch (error) { + console.warn('Failed to load user .lsp.json config:', error); + return []; + } + } + + /** + * Load LSP configurations declared by extensions (Claude plugins). + */ + async loadExtensionConfigs( + extensions: Extension[], + ): Promise { + const configs: LspServerConfig[] = []; + + for (const extension of extensions) { + const lspServers = extension.config?.lspServers; + if (!lspServers) { + continue; + } + + const originBase = `extension ${extension.name}`; + if (typeof lspServers === 'string') { + const configPath = this.resolveExtensionConfigPath( + extension.path, + lspServers, + ); + if (!fs.existsSync(configPath)) { + console.warn(`LSP config not found for ${originBase}: ${configPath}`); + continue; + } + + try { + const configContent = fs.readFileSync(configPath, 'utf-8'); + const data = JSON.parse(configContent) as JsonValue; + const hydrated = this.hydrateExtensionLspConfig(data, extension.path); + configs.push( + ...this.parseConfigSource( + hydrated, + `${originBase} (${configPath})`, + ), + ); + } catch (error) { + console.warn( + `Failed to load extension LSP config from ${configPath}:`, + error, + ); + } + } else if (this.isRecord(lspServers)) { + const hydrated = this.hydrateExtensionLspConfig( + lspServers as JsonValue, + extension.path, + ); + configs.push( + ...this.parseConfigSource(hydrated, `${originBase} (lspServers)`), + ); + } else { + console.warn( + `LSP config for ${originBase} must be an object or a JSON file path.`, + ); + } + } + + return configs; + } + + /** + * Merge configs: built-in presets + extension configs + user configs + */ + mergeConfigs( + detectedLanguages: string[], + extensionConfigs: LspServerConfig[], + userConfigs: LspServerConfig[], + ): LspServerConfig[] { + // Built-in preset configurations + const presets = this.getBuiltInPresets(detectedLanguages); + + // Merge configs, user configs take priority + const mergedConfigs = [...presets]; + + const applyConfigs = (configs: LspServerConfig[]) => { + for (const config of configs) { + // Find if there's a preset with the same name, if so replace it + const existingIndex = mergedConfigs.findIndex( + (c) => c.name === config.name, + ); + if (existingIndex !== -1) { + mergedConfigs[existingIndex] = config; + } else { + mergedConfigs.push(config); + } + } + }; + + applyConfigs(extensionConfigs); + applyConfigs(userConfigs); + + return mergedConfigs; + } + + collectExtensionToLanguageOverrides( + configs: LspServerConfig[], + ): Record { + const overrides: Record = {}; + for (const config of configs) { + if (!config.extensionToLanguage) { + continue; + } + for (const [key, value] of Object.entries(config.extensionToLanguage)) { + if (typeof value !== 'string') { + continue; + } + const normalized = key.startsWith('.') ? key.slice(1) : key; + if (!normalized) { + continue; + } + overrides[normalized.toLowerCase()] = value; + } + } + return overrides; + } + + /** + * Get built-in preset configurations + */ + private getBuiltInPresets(detectedLanguages: string[]): LspServerConfig[] { + const presets: LspServerConfig[] = []; + + // Convert directory path to file URI format + const rootUri = pathToFileURL(this.workspaceRoot).toString(); + + // Generate corresponding LSP server config based on detected languages + if ( + detectedLanguages.includes('typescript') || + detectedLanguages.includes('javascript') + ) { + presets.push({ + name: 'typescript-language-server', + languages: [ + 'typescript', + 'javascript', + 'typescriptreact', + 'javascriptreact', + ], + command: 'typescript-language-server', + args: ['--stdio'], + transport: 'stdio', + initializationOptions: {}, + rootUri, + workspaceFolder: this.workspaceRoot, + trustRequired: true, + }); + } + + if (detectedLanguages.includes('python')) { + presets.push({ + name: 'pylsp', + languages: ['python'], + command: 'pylsp', + args: [], + transport: 'stdio', + initializationOptions: {}, + rootUri, + workspaceFolder: this.workspaceRoot, + trustRequired: true, + }); + } + + if (detectedLanguages.includes('go')) { + presets.push({ + name: 'gopls', + languages: ['go'], + command: 'gopls', + args: [], + transport: 'stdio', + initializationOptions: {}, + rootUri, + workspaceFolder: this.workspaceRoot, + trustRequired: true, + }); + } + + // Additional language presets can be added as needed + + return presets; + } + + /** + * Parse configuration source and extract server configs. + * Expects basic format keyed by language identifier. + */ + private parseConfigSource( + source: unknown, + origin: string, + ): LspServerConfig[] { + if (!this.isRecord(source)) { + return []; + } + + const configs: LspServerConfig[] = []; + + for (const [key, spec] of Object.entries(source)) { + if (!this.isRecord(spec)) { + continue; + } + + // In basic format: key is language name, server name comes from command. + const languages = [key]; + const name = + typeof spec['command'] === 'string' ? (spec['command'] as string) : key; + + const config = this.buildServerConfig(name, languages, spec, origin); + if (config) { + configs.push(config); + } + } + + return configs; + } + + private resolveExtensionConfigPath( + extensionPath: string, + configPath: string, + ): string { + return path.isAbsolute(configPath) + ? path.resolve(configPath) + : path.resolve(extensionPath, configPath); + } + + private hydrateExtensionLspConfig( + source: JsonValue, + extensionPath: string, + ): JsonValue { + return recursivelyHydrateStrings(source, { + extensionPath, + CLAUDE_PLUGIN_ROOT: extensionPath, + workspacePath: this.workspaceRoot, + '/': path.sep, + pathSeparator: path.sep, + }); + } + + private buildServerConfig( + name: string, + languages: string[], + spec: Record, + origin: string, + ): LspServerConfig | null { + const transport = this.normalizeTransport(spec['transport']); + const command = + typeof spec['command'] === 'string' + ? (spec['command'] as string) + : undefined; + const args = this.normalizeStringArray(spec['args']) ?? []; + const env = this.normalizeEnv(spec['env']); + const initializationOptions = this.isRecord(spec['initializationOptions']) + ? (spec['initializationOptions'] as LspInitializationOptions) + : undefined; + const settings = this.isRecord(spec['settings']) + ? (spec['settings'] as Record) + : undefined; + const extensionToLanguage = this.normalizeExtensionToLanguage( + spec['extensionToLanguage'], + ); + const workspaceFolder = this.resolveWorkspaceFolder( + spec['workspaceFolder'], + ); + const rootUri = pathToFileURL(workspaceFolder).toString(); + const startupTimeout = this.normalizeTimeout(spec['startupTimeout']); + const shutdownTimeout = this.normalizeTimeout(spec['shutdownTimeout']); + const restartOnCrash = + typeof spec['restartOnCrash'] === 'boolean' + ? (spec['restartOnCrash'] as boolean) + : undefined; + const maxRestarts = this.normalizeMaxRestarts(spec['maxRestarts']); + const trustRequired = + typeof spec['trustRequired'] === 'boolean' + ? (spec['trustRequired'] as boolean) + : true; + const socket = this.normalizeSocketOptions(spec); + + if (transport === 'stdio' && !command) { + console.warn(`LSP config error in ${origin}: ${name} missing command`); + return null; + } + + if (transport !== 'stdio' && !socket) { + console.warn( + `LSP config error in ${origin}: ${name} missing socket info`, + ); + return null; + } + + return { + name, + languages, + command, + args, + transport, + env, + initializationOptions, + settings, + extensionToLanguage, + rootUri, + workspaceFolder, + startupTimeout, + shutdownTimeout, + restartOnCrash, + maxRestarts, + trustRequired, + socket, + }; + } + + private isRecord(value: unknown): value is Record { + return typeof value === 'object' && value !== null && !Array.isArray(value); + } + + private normalizeStringArray(value: unknown): string[] | undefined { + if (!Array.isArray(value)) { + return undefined; + } + return value.filter((item): item is string => typeof item === 'string'); + } + + private normalizeEnv(value: unknown): Record | undefined { + if (!this.isRecord(value)) { + return undefined; + } + const env: Record = {}; + for (const [key, val] of Object.entries(value)) { + if ( + typeof val === 'string' || + typeof val === 'number' || + typeof val === 'boolean' + ) { + env[key] = String(val); + } + } + return Object.keys(env).length > 0 ? env : undefined; + } + + private normalizeExtensionToLanguage( + value: unknown, + ): Record | undefined { + if (!this.isRecord(value)) { + return undefined; + } + const mapping: Record = {}; + for (const [key, lang] of Object.entries(value)) { + if (typeof lang !== 'string') { + continue; + } + const normalized = key.startsWith('.') ? key.slice(1) : key; + if (!normalized) { + continue; + } + mapping[normalized.toLowerCase()] = lang; + } + return Object.keys(mapping).length > 0 ? mapping : undefined; + } + + private normalizeTransport(value: unknown): 'stdio' | 'tcp' | 'socket' { + if (typeof value !== 'string') { + return 'stdio'; + } + const normalized = value.toLowerCase(); + if (normalized === 'tcp' || normalized === 'socket') { + return normalized; + } + return 'stdio'; + } + + private normalizeTimeout(value: unknown): number | undefined { + if (typeof value !== 'number') { + return undefined; + } + if (!Number.isFinite(value) || value <= 0) { + return undefined; + } + return value; + } + + private normalizeMaxRestarts(value: unknown): number | undefined { + if (typeof value !== 'number') { + return undefined; + } + if (!Number.isFinite(value) || value < 0) { + return undefined; + } + return value; + } + + private normalizeSocketOptions( + value: Record, + ): LspSocketOptions | undefined { + const socketValue = value['socket']; + if (typeof socketValue === 'string') { + return { path: socketValue }; + } + + const source = this.isRecord(socketValue) ? socketValue : value; + const host = + typeof source['host'] === 'string' + ? (source['host'] as string) + : undefined; + const pathValue = + typeof source['path'] === 'string' + ? (source['path'] as string) + : typeof source['socketPath'] === 'string' + ? (source['socketPath'] as string) + : undefined; + const portValue = source['port']; + const port = + typeof portValue === 'number' + ? portValue + : typeof portValue === 'string' + ? Number(portValue) + : undefined; + + const socket: LspSocketOptions = {}; + if (host) { + socket.host = host; + } + if (Number.isFinite(port) && (port as number) > 0) { + socket.port = port as number; + } + if (pathValue) { + socket.path = pathValue; + } + + if (!socket.path && !socket.port) { + return undefined; + } + return socket; + } + + private resolveWorkspaceFolder(value: unknown): string { + if (typeof value !== 'string' || value.trim() === '') { + return this.workspaceRoot; + } + + const resolved = path.isAbsolute(value) + ? path.resolve(value) + : path.resolve(this.workspaceRoot, value); + const root = path.resolve(this.workspaceRoot); + + if (resolved === root || resolved.startsWith(root + path.sep)) { + return resolved; + } + + console.warn( + `LSP workspaceFolder must be within ${this.workspaceRoot}; using workspace root instead.`, + ); + return this.workspaceRoot; + } +} diff --git a/packages/core/src/lsp/LspConnectionFactory.ts b/packages/core/src/lsp/LspConnectionFactory.ts new file mode 100644 index 000000000..dfcecd86d --- /dev/null +++ b/packages/core/src/lsp/LspConnectionFactory.ts @@ -0,0 +1,392 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +import * as cp from 'node:child_process'; +import * as net from 'node:net'; +import { DEFAULT_LSP_REQUEST_TIMEOUT_MS } from './constants.js'; +import type { JsonRpcMessage } from './types.js'; + +interface PendingRequest { + resolve: (value: unknown) => void; + reject: (reason?: unknown) => void; + timer: NodeJS.Timeout; +} + +class JsonRpcConnection { + private buffer = ''; + private nextId = 1; + private disposed = false; + private pendingRequests = new Map(); + private notificationHandlers: Array<(notification: JsonRpcMessage) => void> = + []; + private requestHandlers: Array< + (request: JsonRpcMessage) => Promise + > = []; + + constructor( + private readonly writer: (data: string) => void, + private readonly disposer?: () => void, + ) {} + + listen(readable: NodeJS.ReadableStream): void { + readable.on('data', (chunk: Buffer) => this.handleData(chunk)); + readable.on('error', (error) => + this.disposePending( + error instanceof Error ? error : new Error(String(error)), + ), + ); + } + + send(message: JsonRpcMessage): void { + this.writeMessage(message); + } + + onNotification(handler: (notification: JsonRpcMessage) => void): void { + this.notificationHandlers.push(handler); + } + + onRequest(handler: (request: JsonRpcMessage) => Promise): void { + this.requestHandlers.push(handler); + } + + async initialize(params: unknown): Promise { + return this.sendRequest('initialize', params); + } + + async shutdown(): Promise { + try { + await this.sendRequest('shutdown', {}); + } catch (_error) { + // Ignore shutdown errors – the server may already be gone. + } finally { + this.end(); + } + } + + request(method: string, params: unknown): Promise { + return this.sendRequest(method, params); + } + + end(): void { + if (this.disposed) { + return; + } + this.disposed = true; + this.disposePending(); + this.disposer?.(); + } + + private sendRequest(method: string, params: unknown): Promise { + if (this.disposed) { + return Promise.resolve(undefined); + } + + const id = this.nextId++; + const payload: JsonRpcMessage = { + jsonrpc: '2.0', + id, + method, + params, + }; + + const requestPromise = new Promise((resolve, reject) => { + const timer = setTimeout(() => { + this.pendingRequests.delete(id); + reject(new Error(`LSP request timeout: ${method}`)); + }, DEFAULT_LSP_REQUEST_TIMEOUT_MS); + + this.pendingRequests.set(id, { resolve, reject, timer }); + }); + + this.writeMessage(payload); + return requestPromise; + } + + private async handleServerRequest(message: JsonRpcMessage): Promise { + const handler = this.requestHandlers[this.requestHandlers.length - 1]; + if (!handler) { + this.writeMessage({ + jsonrpc: '2.0', + id: message.id, + error: { + code: -32601, + message: `Method not supported: ${message.method}`, + }, + }); + return; + } + + try { + const result = await handler(message); + this.writeMessage({ + jsonrpc: '2.0', + id: message.id, + result: result ?? null, + }); + } catch (error) { + this.writeMessage({ + jsonrpc: '2.0', + id: message.id, + error: { + code: -32603, + message: (error as Error).message ?? 'Internal error', + }, + }); + } + } + + private handleData(chunk: Buffer): void { + if (this.disposed) { + return; + } + + this.buffer += chunk.toString('utf8'); + + while (true) { + const headerEnd = this.buffer.indexOf('\r\n\r\n'); + if (headerEnd === -1) { + break; + } + + const header = this.buffer.slice(0, headerEnd); + const lengthMatch = /Content-Length:\s*(\d+)/i.exec(header); + if (!lengthMatch) { + this.buffer = this.buffer.slice(headerEnd + 4); + continue; + } + + const contentLength = Number(lengthMatch[1]); + const messageStart = headerEnd + 4; + const messageEnd = messageStart + contentLength; + + if (this.buffer.length < messageEnd) { + break; + } + + const body = this.buffer.slice(messageStart, messageEnd); + this.buffer = this.buffer.slice(messageEnd); + + try { + const message = JSON.parse(body); + this.routeMessage(message); + } catch { + // ignore malformed messages + } + } + } + + private routeMessage(message: JsonRpcMessage): void { + if (typeof message?.id !== 'undefined' && !message.method) { + const pending = this.pendingRequests.get(message.id); + if (!pending) { + return; + } + clearTimeout(pending.timer); + this.pendingRequests.delete(message.id); + if (message.error) { + pending.reject( + new Error(message.error.message || 'LSP request failed'), + ); + } else { + pending.resolve(message.result); + } + return; + } + + if (message?.method && typeof message.id !== 'undefined') { + void this.handleServerRequest(message); + return; + } + + if (message?.method) { + for (const handler of this.notificationHandlers) { + try { + handler(message); + } catch { + // ignore handler errors + } + } + } + } + + private writeMessage(message: JsonRpcMessage): void { + if (this.disposed) { + return; + } + const json = JSON.stringify(message); + const header = `Content-Length: ${Buffer.byteLength(json, 'utf8')}\r\n\r\n`; + this.writer(header + json); + } + + private disposePending(error?: Error): void { + for (const [, pending] of Array.from(this.pendingRequests)) { + clearTimeout(pending.timer); + pending.reject(error ?? new Error('LSP connection closed')); + } + this.pendingRequests.clear(); + } +} + +interface LspConnection { + connection: JsonRpcConnection; + process?: cp.ChildProcess; + socket?: net.Socket; +} + +interface SocketConnectionOptions { + host?: string; + port?: number; + path?: string; +} + +export class LspConnectionFactory { + /** + * 创建基于 stdio 的 LSP 连接 + */ + static async createStdioConnection( + command: string, + args: string[], + options?: cp.SpawnOptions, + timeoutMs = 10000, + ): Promise { + return new Promise((resolve, reject) => { + const spawnOptions: cp.SpawnOptions = { + stdio: 'pipe', + ...options, + }; + const processInstance = cp.spawn(command, args, spawnOptions); + + const timeoutId = setTimeout(() => { + reject(new Error('LSP server spawn timeout')); + if (!processInstance.killed) { + processInstance.kill(); + } + }, timeoutMs); + + processInstance.once('error', (error) => { + clearTimeout(timeoutId); + reject(new Error(`Failed to spawn LSP server: ${error.message}`)); + }); + + processInstance.once('spawn', () => { + clearTimeout(timeoutId); + + if (!processInstance.stdout || !processInstance.stdin) { + reject(new Error('LSP server stdio not available')); + return; + } + + const connection = new JsonRpcConnection( + (payload) => processInstance.stdin?.write(payload), + () => processInstance.stdin?.end(), + ); + + connection.listen(processInstance.stdout); + processInstance.once('exit', () => connection.end()); + processInstance.once('close', () => connection.end()); + + resolve({ + connection, + process: processInstance, + }); + }); + }); + } + + /** + * 创建基于 TCP 的 LSP 连接 + */ + static async createTcpConnection( + host: string, + port: number, + timeoutMs = 10000, + ): Promise { + return LspConnectionFactory.createSocketConnection( + { host, port }, + timeoutMs, + ); + } + + /** + * 创建基于 socket 的 LSP 连接(支持 TCP 或 unix socket) + */ + static async createSocketConnection( + options: SocketConnectionOptions, + timeoutMs = 10000, + ): Promise { + return new Promise((resolve, reject) => { + let socketOptions: { path: string } | { host: string; port: number }; + + if (options.path) { + socketOptions = { path: options.path }; + } else { + if (!options.port) { + reject(new Error('Socket transport requires port or path')); + return; + } + socketOptions = { + host: options.host ?? '127.0.0.1', + port: options.port, + }; + } + + const socket = net.createConnection(socketOptions); + + const timeoutId = setTimeout(() => { + reject(new Error('LSP server connection timeout')); + socket.destroy(); + }, timeoutMs); + + const onError = (error: Error) => { + clearTimeout(timeoutId); + reject(new Error(`Failed to connect to LSP server: ${error.message}`)); + }; + + socket.once('error', onError); + + socket.on('connect', () => { + clearTimeout(timeoutId); + socket.off('error', onError); + + const connection = new JsonRpcConnection( + (payload) => socket.write(payload), + () => socket.destroy(), + ); + connection.listen(socket); + socket.once('close', () => connection.end()); + socket.once('error', () => connection.end()); + + resolve({ + connection, + socket, + }); + }); + }); + } + + /** + * 关闭 LSP 连接 + */ + static async closeConnection(lspConnection: LspConnection): Promise { + if (lspConnection.connection) { + try { + await lspConnection.connection.shutdown(); + } catch (e) { + console.warn('LSP shutdown failed:', e); + } finally { + lspConnection.connection.end(); + } + } + + if (lspConnection.process && !lspConnection.process.killed) { + lspConnection.process.kill(); + } + + if (lspConnection.socket && !lspConnection.socket.destroyed) { + lspConnection.socket.destroy(); + } + } +} diff --git a/packages/core/src/lsp/LspLanguageDetector.ts b/packages/core/src/lsp/LspLanguageDetector.ts new file mode 100644 index 000000000..9c3f96e73 --- /dev/null +++ b/packages/core/src/lsp/LspLanguageDetector.ts @@ -0,0 +1,226 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +/** + * LSP Language Detector + * + * Detects programming languages in a workspace by analyzing file extensions + * and root marker files (e.g., package.json, tsconfig.json). + */ + +import * as fs from 'node:fs'; +import * as path from 'path'; +import { globSync } from 'glob'; +import type { FileDiscoveryService } from '../services/fileDiscoveryService.js'; +import type { WorkspaceContext } from '../utils/workspaceContext.js'; + +/** + * Extension to language ID mapping + */ +const DEFAULT_EXTENSION_TO_LANGUAGE: Record = { + js: 'javascript', + ts: 'typescript', + jsx: 'javascriptreact', + tsx: 'typescriptreact', + py: 'python', + go: 'go', + rs: 'rust', + java: 'java', + cpp: 'cpp', + c: 'c', + php: 'php', + rb: 'ruby', + cs: 'csharp', + vue: 'vue', + svelte: 'svelte', + html: 'html', + css: 'css', + json: 'json', + yaml: 'yaml', + yml: 'yaml', +}; + +/** + * Root marker file to language ID mapping + */ +const MARKER_TO_LANGUAGE: Record = { + 'package.json': 'javascript', + 'tsconfig.json': 'typescript', + 'pyproject.toml': 'python', + 'go.mod': 'go', + 'Cargo.toml': 'rust', + 'pom.xml': 'java', + 'build.gradle': 'java', + 'composer.json': 'php', + Gemfile: 'ruby', + '*.sln': 'csharp', + 'mix.exs': 'elixir', + 'deno.json': 'deno', +}; + +/** + * Common root marker files to look for + */ +const COMMON_MARKERS = [ + 'package.json', + 'tsconfig.json', + 'pyproject.toml', + 'go.mod', + 'Cargo.toml', + 'pom.xml', + 'build.gradle', + 'composer.json', + 'Gemfile', + 'mix.exs', + 'deno.json', +]; + +/** + * Default exclude patterns for file search + */ +const DEFAULT_EXCLUDE_PATTERNS = [ + '**/node_modules/**', + '**/.git/**', + '**/dist/**', + '**/build/**', +]; + +/** + * Detects programming languages in a workspace. + */ +export class LspLanguageDetector { + constructor( + private readonly workspaceContext: WorkspaceContext, + private readonly fileDiscoveryService: FileDiscoveryService, + ) {} + + /** + * Detect programming languages in workspace by analyzing files and markers. + * Returns languages sorted by frequency (most common first). + * + * @param extensionOverrides - Custom extension to language mappings + * @returns Array of detected language IDs + */ + async detectLanguages( + extensionOverrides: Record = {}, + ): Promise { + const extensionMap = this.getExtensionToLanguageMap(extensionOverrides); + const extensions = Object.keys(extensionMap); + const patterns = + extensions.length > 0 ? [`**/*.{${extensions.join(',')}}`] : ['**/*']; + + const files = new Set(); + const searchRoots = this.workspaceContext.getDirectories(); + + for (const root of searchRoots) { + for (const pattern of patterns) { + try { + const matches = globSync(pattern, { + cwd: root, + ignore: DEFAULT_EXCLUDE_PATTERNS, + absolute: true, + nodir: true, + }); + + for (const match of matches) { + if (this.fileDiscoveryService.shouldIgnoreFile(match)) { + continue; + } + files.add(match); + } + } catch { + // Ignore glob errors for missing/invalid directories + } + } + } + + // Count files per language + const languageCounts = new Map(); + for (const file of Array.from(files)) { + const ext = path.extname(file).slice(1).toLowerCase(); + if (ext) { + const lang = this.mapExtensionToLanguage(ext, extensionMap); + if (lang) { + languageCounts.set(lang, (languageCounts.get(lang) || 0) + 1); + } + } + } + + // Also detect languages via root marker files + const rootMarkers = await this.detectRootMarkers(); + for (const marker of rootMarkers) { + const lang = this.mapMarkerToLanguage(marker); + if (lang) { + // Give higher weight to config files + const currentCount = languageCounts.get(lang) || 0; + languageCounts.set(lang, currentCount + 100); + } + } + + // Return languages sorted by count (descending) + return Array.from(languageCounts.entries()) + .sort((a, b) => b[1] - a[1]) + .map(([lang]) => lang); + } + + /** + * Detect root marker files in workspace directories + */ + private async detectRootMarkers(): Promise { + const markers = new Set(); + + for (const root of this.workspaceContext.getDirectories()) { + for (const marker of COMMON_MARKERS) { + try { + const fullPath = path.join(root, marker); + if (fs.existsSync(fullPath)) { + markers.add(marker); + } + } catch { + // ignore missing files + } + } + } + + return Array.from(markers); + } + + /** + * Map file extension to programming language ID + */ + private mapExtensionToLanguage( + ext: string, + extensionMap: Record, + ): string | null { + return extensionMap[ext] || null; + } + + /** + * Get extension to language mapping with overrides applied + */ + private getExtensionToLanguageMap( + extensionOverrides: Record = {}, + ): Record { + const extToLang = { ...DEFAULT_EXTENSION_TO_LANGUAGE }; + + for (const [key, value] of Object.entries(extensionOverrides)) { + const normalized = key.startsWith('.') ? key.slice(1) : key; + if (!normalized) { + continue; + } + extToLang[normalized.toLowerCase()] = value; + } + + return extToLang; + } + + /** + * Map root marker file to programming language ID + */ + private mapMarkerToLanguage(marker: string): string | null { + return MARKER_TO_LANGUAGE[marker] || null; + } +} diff --git a/packages/core/src/lsp/LspResponseNormalizer.ts b/packages/core/src/lsp/LspResponseNormalizer.ts new file mode 100644 index 000000000..9a9a478c0 --- /dev/null +++ b/packages/core/src/lsp/LspResponseNormalizer.ts @@ -0,0 +1,917 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +/** + * LSP Response Normalizer + * + * Converts raw LSP protocol responses to normalized internal types. + * Handles various response formats from different language servers. + */ + +import type { + LspCallHierarchyIncomingCall, + LspCallHierarchyItem, + LspCallHierarchyOutgoingCall, + LspCodeAction, + LspCodeActionKind, + LspDiagnostic, + LspDiagnosticSeverity, + LspFileDiagnostics, + LspHoverResult, + LspLocation, + LspRange, + LspReference, + LspSymbolInformation, + LspTextEdit, + LspWorkspaceEdit, +} from './types.js'; +import { + CODE_ACTION_KIND_LABELS, + DIAGNOSTIC_SEVERITY_LABELS, + SYMBOL_KIND_LABELS, +} from './constants.js'; + +/** + * Normalizes LSP protocol responses to internal types. + */ +export class LspResponseNormalizer { + // ============================================================================ + // Diagnostic Normalization + // ============================================================================ + + /** + * Normalize diagnostic result from LSP response + */ + normalizeDiagnostic(item: unknown, serverName: string): LspDiagnostic | null { + if (!item || typeof item !== 'object') { + return null; + } + + const itemObj = item as Record; + const range = this.normalizeRange(itemObj['range']); + if (!range) { + return null; + } + + const message = + typeof itemObj['message'] === 'string' + ? (itemObj['message'] as string) + : ''; + if (!message) { + return null; + } + + const severityNum = + typeof itemObj['severity'] === 'number' + ? (itemObj['severity'] as number) + : undefined; + const severity = severityNum + ? DIAGNOSTIC_SEVERITY_LABELS[severityNum] + : undefined; + + const code = itemObj['code']; + const codeValue = + typeof code === 'string' || typeof code === 'number' ? code : undefined; + + const source = + typeof itemObj['source'] === 'string' + ? (itemObj['source'] as string) + : undefined; + + const tags = this.normalizeDiagnosticTags(itemObj['tags']); + const relatedInfo = this.normalizeDiagnosticRelatedInfo( + itemObj['relatedInformation'], + ); + + return { + range, + severity, + code: codeValue, + source, + message, + tags: tags.length > 0 ? tags : undefined, + relatedInformation: relatedInfo.length > 0 ? relatedInfo : undefined, + serverName, + }; + } + + /** + * Convert diagnostic back to LSP format for requests + */ + denormalizeDiagnostic(diagnostic: LspDiagnostic): Record { + const severityMap: Record = { + error: 1, + warning: 2, + information: 3, + hint: 4, + }; + + return { + range: diagnostic.range, + message: diagnostic.message, + severity: diagnostic.severity + ? severityMap[diagnostic.severity] + : undefined, + code: diagnostic.code, + source: diagnostic.source, + }; + } + + /** + * Normalize diagnostic tags + */ + normalizeDiagnosticTags(tags: unknown): Array<'unnecessary' | 'deprecated'> { + if (!Array.isArray(tags)) { + return []; + } + + const result: Array<'unnecessary' | 'deprecated'> = []; + for (const tag of tags) { + if (tag === 1) { + result.push('unnecessary'); + } else if (tag === 2) { + result.push('deprecated'); + } + } + return result; + } + + /** + * Normalize diagnostic related information + */ + normalizeDiagnosticRelatedInfo( + info: unknown, + ): Array<{ location: LspLocation; message: string }> { + if (!Array.isArray(info)) { + return []; + } + + const result: Array<{ location: LspLocation; message: string }> = []; + for (const item of info) { + if (!item || typeof item !== 'object') { + continue; + } + const itemObj = item as Record; + const location = itemObj['location']; + if (!location || typeof location !== 'object') { + continue; + } + const locObj = location as Record; + const uri = locObj['uri']; + const range = this.normalizeRange(locObj['range']); + const message = itemObj['message']; + + if (typeof uri === 'string' && range && typeof message === 'string') { + result.push({ + location: { uri, range }, + message, + }); + } + } + return result; + } + + /** + * Normalize file diagnostics result + */ + normalizeFileDiagnostics( + item: unknown, + serverName: string, + ): LspFileDiagnostics | null { + if (!item || typeof item !== 'object') { + return null; + } + + const itemObj = item as Record; + const uri = + typeof itemObj['uri'] === 'string' ? (itemObj['uri'] as string) : ''; + if (!uri) { + return null; + } + + const items = itemObj['items']; + if (!Array.isArray(items)) { + return null; + } + + const diagnostics: LspDiagnostic[] = []; + for (const diagItem of items) { + const normalized = this.normalizeDiagnostic(diagItem, serverName); + if (normalized) { + diagnostics.push(normalized); + } + } + + return { + uri, + diagnostics, + serverName, + }; + } + + // ============================================================================ + // Code Action Normalization + // ============================================================================ + + /** + * Normalize code action result + */ + normalizeCodeAction(item: unknown, serverName: string): LspCodeAction | null { + if (!item || typeof item !== 'object') { + return null; + } + + const itemObj = item as Record; + + // Check if this is a Command instead of CodeAction + if ( + itemObj['command'] && + typeof itemObj['title'] === 'string' && + !itemObj['kind'] + ) { + // This is a raw Command, wrap it + return { + title: itemObj['title'] as string, + command: { + title: itemObj['title'] as string, + command: (itemObj['command'] as string) ?? '', + arguments: itemObj['arguments'] as unknown[] | undefined, + }, + serverName, + }; + } + + const title = + typeof itemObj['title'] === 'string' ? (itemObj['title'] as string) : ''; + if (!title) { + return null; + } + + const kind = + typeof itemObj['kind'] === 'string' + ? (CODE_ACTION_KIND_LABELS[itemObj['kind'] as string] ?? + (itemObj['kind'] as LspCodeActionKind)) + : undefined; + + const isPreferred = + typeof itemObj['isPreferred'] === 'boolean' + ? (itemObj['isPreferred'] as boolean) + : undefined; + + const edit = this.normalizeWorkspaceEdit(itemObj['edit']); + const command = this.normalizeCommand(itemObj['command']); + + const diagnostics: LspDiagnostic[] = []; + if (Array.isArray(itemObj['diagnostics'])) { + for (const diag of itemObj['diagnostics']) { + const normalized = this.normalizeDiagnostic(diag, serverName); + if (normalized) { + diagnostics.push(normalized); + } + } + } + + return { + title, + kind, + diagnostics: diagnostics.length > 0 ? diagnostics : undefined, + isPreferred, + edit: edit ?? undefined, + command: command ?? undefined, + data: itemObj['data'], + serverName, + }; + } + + // ============================================================================ + // Workspace Edit Normalization + // ============================================================================ + + /** + * Normalize workspace edit + */ + normalizeWorkspaceEdit(edit: unknown): LspWorkspaceEdit | null { + if (!edit || typeof edit !== 'object') { + return null; + } + + const editObj = edit as Record; + const result: LspWorkspaceEdit = {}; + + // Handle changes (map of URI to TextEdit[]) + if (editObj['changes'] && typeof editObj['changes'] === 'object') { + const changes = editObj['changes'] as Record; + result.changes = {}; + for (const [uri, edits] of Object.entries(changes)) { + if (Array.isArray(edits)) { + const normalizedEdits: LspTextEdit[] = []; + for (const e of edits) { + const normalized = this.normalizeTextEdit(e); + if (normalized) { + normalizedEdits.push(normalized); + } + } + if (normalizedEdits.length > 0) { + result.changes[uri] = normalizedEdits; + } + } + } + } + + // Handle documentChanges + if (Array.isArray(editObj['documentChanges'])) { + result.documentChanges = []; + for (const docChange of editObj['documentChanges']) { + const normalized = this.normalizeTextDocumentEdit(docChange); + if (normalized) { + result.documentChanges.push(normalized); + } + } + } + + if ( + (!result.changes || Object.keys(result.changes).length === 0) && + (!result.documentChanges || result.documentChanges.length === 0) + ) { + return null; + } + + return result; + } + + /** + * Normalize text edit + */ + normalizeTextEdit(edit: unknown): LspTextEdit | null { + if (!edit || typeof edit !== 'object') { + return null; + } + + const editObj = edit as Record; + const range = this.normalizeRange(editObj['range']); + if (!range) { + return null; + } + + const newText = + typeof editObj['newText'] === 'string' + ? (editObj['newText'] as string) + : ''; + + return { range, newText }; + } + + /** + * Normalize text document edit + */ + normalizeTextDocumentEdit(docEdit: unknown): { + textDocument: { uri: string; version?: number | null }; + edits: LspTextEdit[]; + } | null { + if (!docEdit || typeof docEdit !== 'object') { + return null; + } + + const docEditObj = docEdit as Record; + const textDocument = docEditObj['textDocument']; + if (!textDocument || typeof textDocument !== 'object') { + return null; + } + + const textDocObj = textDocument as Record; + const uri = + typeof textDocObj['uri'] === 'string' + ? (textDocObj['uri'] as string) + : ''; + if (!uri) { + return null; + } + + const version = + typeof textDocObj['version'] === 'number' + ? (textDocObj['version'] as number) + : null; + + const edits = docEditObj['edits']; + if (!Array.isArray(edits)) { + return null; + } + + const normalizedEdits: LspTextEdit[] = []; + for (const e of edits) { + const normalized = this.normalizeTextEdit(e); + if (normalized) { + normalizedEdits.push(normalized); + } + } + + if (normalizedEdits.length === 0) { + return null; + } + + return { + textDocument: { uri, version }, + edits: normalizedEdits, + }; + } + + /** + * Normalize command + */ + normalizeCommand( + cmd: unknown, + ): { title: string; command: string; arguments?: unknown[] } | null { + if (!cmd || typeof cmd !== 'object') { + return null; + } + + const cmdObj = cmd as Record; + const title = + typeof cmdObj['title'] === 'string' ? (cmdObj['title'] as string) : ''; + const command = + typeof cmdObj['command'] === 'string' + ? (cmdObj['command'] as string) + : ''; + + if (!command) { + return null; + } + + const args = Array.isArray(cmdObj['arguments']) + ? (cmdObj['arguments'] as unknown[]) + : undefined; + + return { title, command, arguments: args }; + } + + // ============================================================================ + // Location and Symbol Normalization + // ============================================================================ + + /** + * Normalize location result (definitions, references, implementations) + */ + normalizeLocationResult( + item: unknown, + serverName: string, + ): LspReference | null { + if (!item || typeof item !== 'object') { + return null; + } + + const itemObj = item as Record; + const uri = (itemObj['uri'] ?? + itemObj['targetUri'] ?? + (itemObj['target'] as Record)?.['uri']) as + | string + | undefined; + + const range = (itemObj['range'] ?? + itemObj['targetSelectionRange'] ?? + itemObj['targetRange'] ?? + (itemObj['target'] as Record)?.['range']) as + | { start?: unknown; end?: unknown } + | undefined; + + if (!uri || !range?.start || !range?.end) { + return null; + } + + const start = range.start as { line?: number; character?: number }; + const end = range.end as { line?: number; character?: number }; + + return { + uri, + range: { + start: { + line: Number(start?.line ?? 0), + character: Number(start?.character ?? 0), + }, + end: { + line: Number(end?.line ?? 0), + character: Number(end?.character ?? 0), + }, + }, + serverName, + }; + } + + /** + * Normalize symbol result (workspace symbols, document symbols) + */ + normalizeSymbolResult( + item: unknown, + serverName: string, + ): LspSymbolInformation | null { + if (!item || typeof item !== 'object') { + return null; + } + + const itemObj = item as Record; + const location = itemObj['location'] ?? itemObj['target'] ?? item; + if (!location || typeof location !== 'object') { + return null; + } + + const locationObj = location as Record; + const range = (locationObj['range'] ?? + locationObj['targetRange'] ?? + itemObj['range'] ?? + undefined) as { start?: unknown; end?: unknown } | undefined; + + if (!locationObj['uri'] || !range?.start || !range?.end) { + return null; + } + + const start = range.start as { line?: number; character?: number }; + const end = range.end as { line?: number; character?: number }; + + return { + name: (itemObj['name'] ?? itemObj['label'] ?? 'symbol') as string, + kind: this.normalizeSymbolKind(itemObj['kind']), + containerName: (itemObj['containerName'] ?? itemObj['container']) as + | string + | undefined, + location: { + uri: locationObj['uri'] as string, + range: { + start: { + line: Number(start?.line ?? 0), + character: Number(start?.character ?? 0), + }, + end: { + line: Number(end?.line ?? 0), + character: Number(end?.character ?? 0), + }, + }, + }, + serverName, + }; + } + + // ============================================================================ + // Range Normalization + // ============================================================================ + + /** + * Normalize a single range + */ + normalizeRange(range: unknown): LspRange | null { + if (!range || typeof range !== 'object') { + return null; + } + + const rangeObj = range as Record; + const start = rangeObj['start']; + const end = rangeObj['end']; + + if ( + !start || + typeof start !== 'object' || + !end || + typeof end !== 'object' + ) { + return null; + } + + const startObj = start as Record; + const endObj = end as Record; + + return { + start: { + line: Number(startObj['line'] ?? 0), + character: Number(startObj['character'] ?? 0), + }, + end: { + line: Number(endObj['line'] ?? 0), + character: Number(endObj['character'] ?? 0), + }, + }; + } + + /** + * Normalize an array of ranges + */ + normalizeRanges(ranges: unknown): LspRange[] { + if (!Array.isArray(ranges)) { + return []; + } + + const results: LspRange[] = []; + for (const range of ranges) { + const normalized = this.normalizeRange(range); + if (normalized) { + results.push(normalized); + } + } + + return results; + } + + /** + * Normalize symbol kind from number to string label + */ + normalizeSymbolKind(kind: unknown): string | undefined { + if (typeof kind === 'number') { + return SYMBOL_KIND_LABELS[kind] ?? String(kind); + } + if (typeof kind === 'string') { + const trimmed = kind.trim(); + if (trimmed === '') { + return undefined; + } + const numeric = Number(trimmed); + if (Number.isFinite(numeric) && SYMBOL_KIND_LABELS[numeric]) { + return SYMBOL_KIND_LABELS[numeric]; + } + return trimmed; + } + return undefined; + } + + // ============================================================================ + // Hover Normalization + // ============================================================================ + + /** + * Normalize hover contents to string + */ + normalizeHoverContents(contents: unknown): string { + if (!contents) { + return ''; + } + if (typeof contents === 'string') { + return contents; + } + if (Array.isArray(contents)) { + const parts = contents + .map((item) => this.normalizeHoverContents(item)) + .map((item) => item.trim()) + .filter((item) => item.length > 0); + return parts.join('\n'); + } + if (typeof contents === 'object') { + const contentsObj = contents as Record; + const value = contentsObj['value']; + if (typeof value === 'string') { + const language = contentsObj['language']; + if (typeof language === 'string' && language.trim() !== '') { + return `\`\`\`${language}\n${value}\n\`\`\``; + } + return value; + } + } + return ''; + } + + /** + * Normalize hover result + */ + normalizeHoverResult( + response: unknown, + serverName: string, + ): LspHoverResult | null { + if (!response) { + return null; + } + if (typeof response !== 'object') { + const contents = this.normalizeHoverContents(response); + if (!contents.trim()) { + return null; + } + return { + contents, + serverName, + }; + } + + const responseObj = response as Record; + const contents = this.normalizeHoverContents(responseObj['contents']); + if (!contents.trim()) { + return null; + } + + const range = this.normalizeRange(responseObj['range']); + return { + contents, + range: range ?? undefined, + serverName, + }; + } + + // ============================================================================ + // Call Hierarchy Normalization + // ============================================================================ + + /** + * Normalize call hierarchy item + */ + normalizeCallHierarchyItem( + item: unknown, + serverName: string, + ): LspCallHierarchyItem | null { + if (!item || typeof item !== 'object') { + return null; + } + + const itemObj = item as Record; + const nameValue = itemObj['name'] ?? itemObj['label'] ?? 'symbol'; + const name = + typeof nameValue === 'string' ? nameValue : String(nameValue ?? ''); + const uri = itemObj['uri']; + + if (!name || typeof uri !== 'string') { + return null; + } + + const range = this.normalizeRange(itemObj['range']); + const selectionRange = + this.normalizeRange(itemObj['selectionRange']) ?? range; + + if (!range || !selectionRange) { + return null; + } + + const serverOverride = + typeof itemObj['serverName'] === 'string' + ? (itemObj['serverName'] as string) + : undefined; + + // Preserve raw numeric kind for server communication + let rawKind: number | undefined; + if (typeof itemObj['rawKind'] === 'number') { + rawKind = itemObj['rawKind']; + } else if (typeof itemObj['kind'] === 'number') { + rawKind = itemObj['kind']; + } else if (typeof itemObj['kind'] === 'string') { + const parsed = Number(itemObj['kind']); + if (Number.isFinite(parsed)) { + rawKind = parsed; + } + } + + return { + name, + kind: this.normalizeSymbolKind(itemObj['kind']), + rawKind, + detail: + typeof itemObj['detail'] === 'string' + ? (itemObj['detail'] as string) + : undefined, + uri, + range, + selectionRange, + data: itemObj['data'], + serverName: serverOverride ?? serverName, + }; + } + + /** + * Normalize incoming call + */ + normalizeIncomingCall( + item: unknown, + serverName: string, + ): LspCallHierarchyIncomingCall | null { + if (!item || typeof item !== 'object') { + return null; + } + const itemObj = item as Record; + const from = this.normalizeCallHierarchyItem(itemObj['from'], serverName); + if (!from) { + return null; + } + return { + from, + fromRanges: this.normalizeRanges(itemObj['fromRanges']), + }; + } + + /** + * Normalize outgoing call + */ + normalizeOutgoingCall( + item: unknown, + serverName: string, + ): LspCallHierarchyOutgoingCall | null { + if (!item || typeof item !== 'object') { + return null; + } + const itemObj = item as Record; + const to = this.normalizeCallHierarchyItem(itemObj['to'], serverName); + if (!to) { + return null; + } + return { + to, + fromRanges: this.normalizeRanges(itemObj['fromRanges']), + }; + } + + /** + * Convert call hierarchy item back to LSP params format + */ + toCallHierarchyItemParams( + item: LspCallHierarchyItem, + ): Record { + // Use rawKind (numeric) for server communication + let numericKind: number | undefined = item.rawKind; + if (numericKind === undefined && item.kind !== undefined) { + const parsed = Number(item.kind); + if (Number.isFinite(parsed)) { + numericKind = parsed; + } + } + + return { + name: item.name, + kind: numericKind, + detail: item.detail, + uri: item.uri, + range: item.range, + selectionRange: item.selectionRange, + data: item.data, + }; + } + + // ============================================================================ + // Document Symbol Helpers + // ============================================================================ + + /** + * Check if item is a DocumentSymbol (has range and selectionRange) + */ + isDocumentSymbol(item: Record): boolean { + const range = item['range']; + const selectionRange = item['selectionRange']; + return ( + typeof range === 'object' && + range !== null && + typeof selectionRange === 'object' && + selectionRange !== null + ); + } + + /** + * Recursively collect document symbols from a tree structure + */ + collectDocumentSymbol( + item: Record, + uri: string, + serverName: string, + results: LspSymbolInformation[], + limit: number, + containerName?: string, + ): void { + if (results.length >= limit) { + return; + } + + const nameValue = item['name'] ?? item['label'] ?? 'symbol'; + const name = typeof nameValue === 'string' ? nameValue : String(nameValue); + const selectionRange = + this.normalizeRange(item['selectionRange']) ?? + this.normalizeRange(item['range']); + + if (!selectionRange) { + return; + } + + results.push({ + name, + kind: this.normalizeSymbolKind(item['kind']), + containerName, + location: { + uri, + range: selectionRange, + }, + serverName, + }); + + if (results.length >= limit) { + return; + } + + const children = item['children']; + if (Array.isArray(children)) { + for (const child of children) { + if (results.length >= limit) { + break; + } + if (child && typeof child === 'object') { + this.collectDocumentSymbol( + child as Record, + uri, + serverName, + results, + limit, + name, + ); + } + } + } + } +} diff --git a/packages/core/src/lsp/LspServerManager.ts b/packages/core/src/lsp/LspServerManager.ts new file mode 100644 index 000000000..74b25f779 --- /dev/null +++ b/packages/core/src/lsp/LspServerManager.ts @@ -0,0 +1,717 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +import type { Config as CoreConfig } from '../config/config.js'; +import type { FileDiscoveryService } from '../services/fileDiscoveryService.js'; +import type { WorkspaceContext } from '../utils/workspaceContext.js'; +import { spawn, type ChildProcess } from 'node:child_process'; +import * as fs from 'node:fs'; +import * as path from 'path'; +import { pathToFileURL } from 'url'; +import { globSync } from 'glob'; +import { LspConnectionFactory } from './LspConnectionFactory.js'; +import { + DEFAULT_LSP_COMMAND_CHECK_TIMEOUT_MS, + DEFAULT_LSP_MAX_RESTARTS, + DEFAULT_LSP_SOCKET_MAX_RETRY_DELAY_MS, + DEFAULT_LSP_SOCKET_RETRY_DELAY_MS, + DEFAULT_LSP_STARTUP_TIMEOUT_MS, + DEFAULT_LSP_WARMUP_DELAY_MS, +} from './constants.js'; +import type { + LspConnectionResult, + LspServerConfig, + LspServerHandle, + LspServerStatus, + LspSocketOptions, +} from './types.js'; + +export interface LspServerManagerOptions { + requireTrustedWorkspace: boolean; + workspaceRoot: string; +} + +export class LspServerManager { + private serverHandles: Map = new Map(); + private requireTrustedWorkspace: boolean; + private workspaceRoot: string; + + constructor( + private readonly config: CoreConfig, + private readonly workspaceContext: WorkspaceContext, + private readonly fileDiscoveryService: FileDiscoveryService, + options: LspServerManagerOptions, + ) { + this.requireTrustedWorkspace = options.requireTrustedWorkspace; + this.workspaceRoot = options.workspaceRoot; + } + + setServerConfigs(configs: LspServerConfig[]): void { + this.serverHandles.clear(); + for (const config of configs) { + this.serverHandles.set(config.name, { + config, + status: 'NOT_STARTED', + }); + } + } + + clearServerHandles(): void { + this.serverHandles.clear(); + } + + getHandles(): ReadonlyMap { + return this.serverHandles; + } + + getStatus(): Map { + const statusMap = new Map(); + for (const [name, handle] of Array.from(this.serverHandles)) { + statusMap.set(name, handle.status); + } + return statusMap; + } + + async startAll(): Promise { + for (const [name, handle] of Array.from(this.serverHandles)) { + await this.startServer(name, handle); + } + } + + async stopAll(): Promise { + for (const [name, handle] of Array.from(this.serverHandles)) { + await this.stopServer(name, handle); + } + this.serverHandles.clear(); + } + + /** + * Ensure tsserver has at least one file open so navto/navtree requests succeed. + * Sets warmedUp flag only after successful warm-up to allow retry on failure. + */ + async warmupTypescriptServer( + handle: LspServerHandle, + force = false, + ): Promise { + if (!handle.connection || !this.isTypescriptServer(handle)) { + return; + } + if (handle.warmedUp && !force) { + return; + } + const tsFile = this.findFirstTypescriptFile(); + if (!tsFile) { + return; + } + + const uri = pathToFileURL(tsFile).toString(); + const languageId = tsFile.endsWith('.tsx') + ? 'typescriptreact' + : tsFile.endsWith('.jsx') + ? 'javascriptreact' + : tsFile.endsWith('.js') + ? 'javascript' + : 'typescript'; + try { + const text = fs.readFileSync(tsFile, 'utf-8'); + handle.connection.send({ + jsonrpc: '2.0', + method: 'textDocument/didOpen', + params: { + textDocument: { + uri, + languageId, + version: 1, + text, + }, + }, + }); + // Give tsserver a moment to build the project. + await new Promise((resolve) => + setTimeout(resolve, DEFAULT_LSP_WARMUP_DELAY_MS), + ); + // Only mark as warmed up after successful completion + handle.warmedUp = true; + } catch (error) { + // Do not set warmedUp to true on failure, allowing retry + console.warn('TypeScript server warm-up failed:', error); + } + } + + /** + * Check if the given handle is a TypeScript language server. + * + * @param handle - The LSP server handle + * @returns true if it's a TypeScript server + */ + isTypescriptServer(handle: LspServerHandle): boolean { + return ( + handle.config.name.includes('typescript') || + (handle.config.command?.includes('typescript') ?? false) + ); + } + + /** + * Start individual LSP server with lock to prevent concurrent startup attempts. + * + * @param name - The name of the LSP server + * @param handle - The LSP server handle + */ + private async startServer( + name: string, + handle: LspServerHandle, + ): Promise { + // If already starting, wait for the existing promise + if (handle.startingPromise) { + return handle.startingPromise; + } + + if (handle.status === 'IN_PROGRESS' || handle.status === 'READY') { + return; + } + handle.stopRequested = false; + + // Create a promise to lock concurrent calls + handle.startingPromise = this.doStartServer(name, handle).finally(() => { + handle.startingPromise = undefined; + }); + + return handle.startingPromise; + } + + /** + * Internal method that performs the actual server startup. + * + * @param name - The name of the LSP server + * @param handle - The LSP server handle + */ + private async doStartServer( + name: string, + handle: LspServerHandle, + ): Promise { + const workspaceTrusted = this.config.isTrustedFolder(); + if ( + (this.requireTrustedWorkspace || handle.config.trustRequired) && + !workspaceTrusted + ) { + console.log( + `LSP server ${name} requires trusted workspace, skipping startup`, + ); + handle.status = 'FAILED'; + return; + } + + // Request user confirmation + const consent = await this.requestUserConsent( + name, + handle.config, + workspaceTrusted, + ); + if (!consent) { + console.log(`User declined to start LSP server ${name}`); + handle.status = 'FAILED'; + return; + } + + // Check if command exists + if (handle.config.command) { + const commandCwd = handle.config.workspaceFolder ?? this.workspaceRoot; + if ( + !(await this.commandExists( + handle.config.command, + handle.config.env, + commandCwd, + )) + ) { + console.warn( + `LSP server ${name} command not found: ${handle.config.command}`, + ); + handle.status = 'FAILED'; + return; + } + + // Check path safety + if ( + !this.isPathSafe(handle.config.command, this.workspaceRoot, commandCwd) + ) { + console.warn( + `LSP server ${name} command path is unsafe: ${handle.config.command}`, + ); + handle.status = 'FAILED'; + return; + } + } + + try { + handle.error = undefined; + handle.warmedUp = false; + handle.status = 'IN_PROGRESS'; + + // Create LSP connection + const connection = await this.createLspConnection(handle.config); + handle.connection = connection.connection; + handle.process = connection.process; + + // Initialize LSP server + await this.initializeLspServer(connection, handle.config); + + handle.status = 'READY'; + this.attachRestartHandler(name, handle); + console.log(`LSP server ${name} started successfully`); + } catch (error) { + handle.status = 'FAILED'; + handle.error = error as Error; + console.error(`LSP server ${name} failed to start:`, error); + } + } + + /** + * Stop individual LSP server + */ + private async stopServer( + name: string, + handle: LspServerHandle, + ): Promise { + handle.stopRequested = true; + + if (handle.connection) { + try { + await this.shutdownConnection(handle); + } catch (error) { + console.error(`Error closing LSP server ${name}:`, error); + } + } else if (handle.process && handle.process.exitCode === null) { + handle.process.kill(); + } + handle.connection = undefined; + handle.process = undefined; + handle.status = 'NOT_STARTED'; + handle.warmedUp = false; + handle.restartAttempts = 0; + } + + private async shutdownConnection(handle: LspServerHandle): Promise { + if (!handle.connection) { + return; + } + try { + const shutdownPromise = handle.connection.shutdown(); + if (typeof handle.config.shutdownTimeout === 'number') { + await Promise.race([ + shutdownPromise, + new Promise((resolve) => + setTimeout(resolve, handle.config.shutdownTimeout), + ), + ]); + } else { + await shutdownPromise; + } + } finally { + handle.connection.end(); + } + } + + private attachRestartHandler(name: string, handle: LspServerHandle): void { + if (!handle.process) { + return; + } + handle.process.once('exit', (code) => { + if (handle.stopRequested) { + return; + } + if (!handle.config.restartOnCrash) { + handle.status = 'FAILED'; + return; + } + const maxRestarts = handle.config.maxRestarts ?? DEFAULT_LSP_MAX_RESTARTS; + if (maxRestarts <= 0) { + handle.status = 'FAILED'; + return; + } + const attempts = handle.restartAttempts ?? 0; + if (attempts >= maxRestarts) { + console.warn( + `LSP server ${name} reached max restart attempts (${maxRestarts}), stopping restarts`, + ); + handle.status = 'FAILED'; + return; + } + handle.restartAttempts = attempts + 1; + console.warn( + `LSP server ${name} exited (code ${code ?? 'unknown'}), restarting (${handle.restartAttempts}/${maxRestarts})`, + ); + this.resetHandle(handle); + void this.startServer(name, handle); + }); + } + + private resetHandle(handle: LspServerHandle): void { + if (handle.connection) { + handle.connection.end(); + } + if (handle.process && handle.process.exitCode === null) { + handle.process.kill(); + } + handle.connection = undefined; + handle.process = undefined; + handle.status = 'NOT_STARTED'; + handle.error = undefined; + handle.warmedUp = false; + handle.stopRequested = false; + } + + private buildProcessEnv( + env: Record | undefined, + ): NodeJS.ProcessEnv | undefined { + if (!env || Object.keys(env).length === 0) { + return undefined; + } + return { ...process.env, ...env }; + } + + private async connectSocketWithRetry( + socket: LspSocketOptions, + timeoutMs: number, + ): Promise< + Awaited> + > { + const deadline = Date.now() + timeoutMs; + let attempt = 0; + while (true) { + const remaining = deadline - Date.now(); + if (remaining <= 0) { + throw new Error('LSP server connection timeout'); + } + try { + return await LspConnectionFactory.createSocketConnection( + socket, + remaining, + ); + } catch (error) { + attempt += 1; + if (Date.now() >= deadline) { + throw error; + } + const delay = Math.min( + DEFAULT_LSP_SOCKET_RETRY_DELAY_MS * attempt, + DEFAULT_LSP_SOCKET_MAX_RETRY_DELAY_MS, + ); + await new Promise((resolve) => setTimeout(resolve, delay)); + } + } + } + + /** + * Create LSP connection + */ + private async createLspConnection( + config: LspServerConfig, + ): Promise { + const workspaceFolder = config.workspaceFolder ?? this.workspaceRoot; + const startupTimeout = + config.startupTimeout ?? DEFAULT_LSP_STARTUP_TIMEOUT_MS; + const env = this.buildProcessEnv(config.env); + + if (config.transport === 'stdio') { + if (!config.command) { + throw new Error('LSP stdio transport requires a command'); + } + + // Fix: use cwd as cwd instead of rootUri + const lspConnection = await LspConnectionFactory.createStdioConnection( + config.command, + config.args ?? [], + { cwd: workspaceFolder, env }, + startupTimeout, + ); + + return { + connection: lspConnection.connection, + process: lspConnection.process as ChildProcess, + shutdown: async () => { + await lspConnection.connection.shutdown(); + }, + exit: () => { + if (lspConnection.process && !lspConnection.process.killed) { + (lspConnection.process as ChildProcess).kill(); + } + lspConnection.connection.end(); + }, + initialize: async (params: unknown) => + lspConnection.connection.initialize(params), + }; + } else if (config.transport === 'tcp' || config.transport === 'socket') { + if (!config.socket) { + throw new Error('LSP socket transport requires host/port or path'); + } + + let process: ChildProcess | undefined; + if (config.command) { + process = spawn(config.command, config.args ?? [], { + cwd: workspaceFolder, + env, + stdio: 'ignore', + }); + await new Promise((resolve, reject) => { + process?.once('spawn', () => resolve()); + process?.once('error', (error) => { + reject(new Error(`Failed to spawn LSP server: ${error.message}`)); + }); + }); + } + + try { + const lspConnection = await this.connectSocketWithRetry( + config.socket, + startupTimeout, + ); + + return { + connection: lspConnection.connection, + process, + shutdown: async () => { + await lspConnection.connection.shutdown(); + }, + exit: () => { + lspConnection.connection.end(); + }, + initialize: async (params: unknown) => + lspConnection.connection.initialize(params), + }; + } catch (error) { + if (process && process.exitCode === null) { + process.kill(); + } + throw error; + } + } else { + throw new Error(`Unsupported transport: ${config.transport}`); + } + } + + /** + * Initialize LSP server + */ + private async initializeLspServer( + connection: LspConnectionResult, + config: LspServerConfig, + ): Promise { + const workspaceFolderPath = config.workspaceFolder ?? this.workspaceRoot; + const workspaceFolder = { + name: path.basename(workspaceFolderPath) || workspaceFolderPath, + uri: config.rootUri, + }; + + const initializeParams = { + processId: process.pid, + rootUri: config.rootUri, + rootPath: workspaceFolderPath, + workspaceFolders: [workspaceFolder], + capabilities: { + textDocument: { + completion: { dynamicRegistration: true }, + hover: { dynamicRegistration: true }, + definition: { dynamicRegistration: true }, + references: { dynamicRegistration: true }, + documentSymbol: { dynamicRegistration: true }, + codeAction: { dynamicRegistration: true }, + }, + workspace: { + workspaceFolders: { supported: true }, + }, + }, + initializationOptions: config.initializationOptions, + }; + + await connection.initialize(initializeParams); + + // Send initialized notification and workspace folders change to help servers (e.g. tsserver) + // create projects in the correct workspace. + connection.connection.send({ + jsonrpc: '2.0', + method: 'initialized', + params: {}, + }); + connection.connection.send({ + jsonrpc: '2.0', + method: 'workspace/didChangeWorkspaceFolders', + params: { + event: { + added: [workspaceFolder], + removed: [], + }, + }, + }); + + if (config.settings && Object.keys(config.settings).length > 0) { + connection.connection.send({ + jsonrpc: '2.0', + method: 'workspace/didChangeConfiguration', + params: { + settings: config.settings, + }, + }); + } + + // Warm up TypeScript server by opening a workspace file so it can create a project. + if ( + config.name.includes('typescript') || + (config.command?.includes('typescript') ?? false) + ) { + try { + const tsFile = this.findFirstTypescriptFile(); + if (tsFile) { + const uri = pathToFileURL(tsFile).toString(); + const languageId = tsFile.endsWith('.tsx') + ? 'typescriptreact' + : 'typescript'; + const text = fs.readFileSync(tsFile, 'utf-8'); + connection.connection.send({ + jsonrpc: '2.0', + method: 'textDocument/didOpen', + params: { + textDocument: { + uri, + languageId, + version: 1, + text, + }, + }, + }); + } + } catch (error) { + console.warn('TypeScript LSP warm-up failed:', error); + } + } + } + + /** + * Check if command exists + */ + private async commandExists( + command: string, + env?: Record, + cwd?: string, + ): Promise { + return new Promise((resolve) => { + let settled = false; + const child = spawn(command, ['--version'], { + stdio: ['ignore', 'ignore', 'ignore'], + cwd: cwd ?? this.workspaceRoot, + env: this.buildProcessEnv(env), + }); + + child.on('error', () => { + settled = true; + resolve(false); + }); + + child.on('exit', (code) => { + if (settled) { + return; + } + // If command exists, it typically returns 0 or other non-error codes + // Some commands with --version may return non-0, but won't throw error + resolve(code !== 127); // 127 typically indicates command not found + }); + + // Set timeout to avoid long waits + setTimeout(() => { + settled = true; + child.kill(); + resolve(false); + }, DEFAULT_LSP_COMMAND_CHECK_TIMEOUT_MS); + }); + } + + /** + * Check path safety + */ + private isPathSafe( + command: string, + workspacePath: string, + cwd?: string, + ): boolean { + // Allow commands without path separators (global PATH commands like 'typescript-language-server') + // These are resolved by the shell from PATH and are generally safe + if (!command.includes(path.sep) && !command.includes('/')) { + return true; + } + + // For explicit paths (absolute or relative), verify they're within workspace + const resolvedWorkspacePath = path.resolve(workspacePath); + const basePath = cwd ? path.resolve(cwd) : resolvedWorkspacePath; + const resolvedPath = path.isAbsolute(command) + ? path.resolve(command) + : path.resolve(basePath, command); + + return ( + resolvedPath.startsWith(resolvedWorkspacePath + path.sep) || + resolvedPath === resolvedWorkspacePath + ); + } + + /** + * 请求用户确认启动 LSP 服务器 + */ + private async requestUserConsent( + serverName: string, + serverConfig: LspServerConfig, + workspaceTrusted: boolean, + ): Promise { + if (workspaceTrusted) { + return true; // Auto-allow in trusted workspace + } + + if (this.requireTrustedWorkspace || serverConfig.trustRequired) { + console.log( + `Workspace not trusted, skipping LSP server ${serverName} (${serverConfig.command ?? serverConfig.transport})`, + ); + return false; + } + + console.log( + `Untrusted workspace, but LSP server ${serverName} has trustRequired=false, attempting cautious startup`, + ); + return true; + } + + /** + * Find a representative TypeScript/JavaScript file to warm up tsserver. + */ + private findFirstTypescriptFile(): string | undefined { + const patterns = ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx']; + const excludePatterns = [ + '**/node_modules/**', + '**/.git/**', + '**/dist/**', + '**/build/**', + ]; + + for (const root of this.workspaceContext.getDirectories()) { + for (const pattern of patterns) { + try { + const matches = globSync(pattern, { + cwd: root, + ignore: excludePatterns, + absolute: true, + nodir: true, + }); + for (const file of matches) { + if (this.fileDiscoveryService.shouldIgnoreFile(file)) { + continue; + } + return file; + } + } catch (_error) { + // ignore glob errors + } + } + } + + return undefined; + } +} diff --git a/packages/core/src/lsp/NativeLspClient.ts b/packages/core/src/lsp/NativeLspClient.ts new file mode 100644 index 000000000..8510ed876 --- /dev/null +++ b/packages/core/src/lsp/NativeLspClient.ts @@ -0,0 +1,259 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +/** + * NativeLspClient is an adapter that implements the LspClient interface + * by delegating all calls to NativeLspService. + * + * This class bridges the gap between the generic LspClient interface (defined in core) + * and the NativeLspService implementation. + */ + +import type { + LspCallHierarchyIncomingCall, + LspCallHierarchyItem, + LspCallHierarchyOutgoingCall, + LspClient, + LspCodeAction, + LspCodeActionContext, + LspDefinition, + LspDiagnostic, + LspFileDiagnostics, + LspHoverResult, + LspLocation, + LspRange, + LspReference, + LspSymbolInformation, + LspWorkspaceEdit, +} from './types.js'; + +import type { NativeLspService } from './NativeLspService.js'; + +/** + * Adapter class that implements LspClient by delegating to NativeLspService. + * + * @example + * ```typescript + * const lspService = new NativeLspService(config, workspaceContext, ...); + * await lspService.start(); + * const lspClient = new NativeLspClient(lspService); + * config.setLspClient(lspClient); + * ``` + */ +export class NativeLspClient implements LspClient { + /** + * Creates a new NativeLspClient instance. + * + * @param service - The NativeLspService instance to delegate calls to + */ + constructor(private readonly service: NativeLspService) {} + + /** + * Search for symbols across the workspace. + * + * @param query - The search query string + * @param limit - Maximum number of results to return + * @returns Promise resolving to array of symbol information + */ + workspaceSymbols( + query: string, + limit?: number, + ): Promise { + return this.service.workspaceSymbols(query, limit); + } + + /** + * Find where a symbol is defined. + * + * @param location - The source location to find definitions for + * @param serverName - Optional specific LSP server to query + * @param limit - Maximum number of results to return + * @returns Promise resolving to array of definition locations + */ + definitions( + location: LspLocation, + serverName?: string, + limit?: number, + ): Promise { + return this.service.definitions(location, serverName, limit); + } + + /** + * Find all references to a symbol. + * + * @param location - The source location to find references for + * @param serverName - Optional specific LSP server to query + * @param includeDeclaration - Whether to include the declaration in results + * @param limit - Maximum number of results to return + * @returns Promise resolving to array of reference locations + */ + references( + location: LspLocation, + serverName?: string, + includeDeclaration?: boolean, + limit?: number, + ): Promise { + return this.service.references( + location, + serverName, + includeDeclaration, + limit, + ); + } + + /** + * Get hover information (documentation, type info) for a symbol. + * + * @param location - The source location to get hover info for + * @param serverName - Optional specific LSP server to query + * @returns Promise resolving to hover result or null if not available + */ + hover( + location: LspLocation, + serverName?: string, + ): Promise { + return this.service.hover(location, serverName); + } + + /** + * Get all symbols in a document. + * + * @param uri - The document URI to get symbols for + * @param serverName - Optional specific LSP server to query + * @param limit - Maximum number of results to return + * @returns Promise resolving to array of symbol information + */ + documentSymbols( + uri: string, + serverName?: string, + limit?: number, + ): Promise { + return this.service.documentSymbols(uri, serverName, limit); + } + + /** + * Find implementations of an interface or abstract method. + * + * @param location - The source location to find implementations for + * @param serverName - Optional specific LSP server to query + * @param limit - Maximum number of results to return + * @returns Promise resolving to array of implementation locations + */ + implementations( + location: LspLocation, + serverName?: string, + limit?: number, + ): Promise { + return this.service.implementations(location, serverName, limit); + } + + /** + * Prepare call hierarchy item at a position (functions/methods). + * + * @param location - The source location to prepare call hierarchy for + * @param serverName - Optional specific LSP server to query + * @param limit - Maximum number of results to return + * @returns Promise resolving to array of call hierarchy items + */ + prepareCallHierarchy( + location: LspLocation, + serverName?: string, + limit?: number, + ): Promise { + return this.service.prepareCallHierarchy(location, serverName, limit); + } + + /** + * Find all functions/methods that call the given function. + * + * @param item - The call hierarchy item to find callers for + * @param serverName - Optional specific LSP server to query + * @param limit - Maximum number of results to return + * @returns Promise resolving to array of incoming calls + */ + incomingCalls( + item: LspCallHierarchyItem, + serverName?: string, + limit?: number, + ): Promise { + return this.service.incomingCalls(item, serverName, limit); + } + + /** + * Find all functions/methods called by the given function. + * + * @param item - The call hierarchy item to find callees for + * @param serverName - Optional specific LSP server to query + * @param limit - Maximum number of results to return + * @returns Promise resolving to array of outgoing calls + */ + outgoingCalls( + item: LspCallHierarchyItem, + serverName?: string, + limit?: number, + ): Promise { + return this.service.outgoingCalls(item, serverName, limit); + } + + /** + * Get diagnostics for a specific document. + * + * @param uri - The document URI to get diagnostics for + * @param serverName - Optional specific LSP server to query + * @returns Promise resolving to array of diagnostics + */ + diagnostics(uri: string, serverName?: string): Promise { + return this.service.diagnostics(uri, serverName); + } + + /** + * Get diagnostics for all open documents in the workspace. + * + * @param serverName - Optional specific LSP server to query + * @param limit - Maximum number of file diagnostics to return + * @returns Promise resolving to array of file diagnostics + */ + workspaceDiagnostics( + serverName?: string, + limit?: number, + ): Promise { + return this.service.workspaceDiagnostics(serverName, limit); + } + + /** + * Get code actions available at a specific location. + * + * @param uri - The document URI + * @param range - The range to get code actions for + * @param context - The code action context including diagnostics + * @param serverName - Optional specific LSP server to query + * @param limit - Maximum number of code actions to return + * @returns Promise resolving to array of code actions + */ + codeActions( + uri: string, + range: LspRange, + context: LspCodeActionContext, + serverName?: string, + limit?: number, + ): Promise { + return this.service.codeActions(uri, range, context, serverName, limit); + } + + /** + * Apply a workspace edit (from code action or other sources). + * + * @param edit - The workspace edit to apply + * @param serverName - Optional specific LSP server context + * @returns Promise resolving to true if edit was applied successfully + */ + applyWorkspaceEdit( + edit: LspWorkspaceEdit, + serverName?: string, + ): Promise { + return this.service.applyWorkspaceEdit(edit, serverName); + } +} diff --git a/packages/core/src/lsp/NativeLspService.integration.test.ts b/packages/core/src/lsp/NativeLspService.integration.test.ts new file mode 100644 index 000000000..cf737fbf7 --- /dev/null +++ b/packages/core/src/lsp/NativeLspService.integration.test.ts @@ -0,0 +1,769 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'; +import { EventEmitter } from 'events'; +import { NativeLspService } from './NativeLspService.js'; +import type { Config as CoreConfig } from '../config/config.js'; +import type { FileDiscoveryService } from '../services/fileDiscoveryService.js'; +import type { IdeContextStore } from '../ide/ideContext.js'; +import type { WorkspaceContext } from '../utils/workspaceContext.js'; +import type { LspDiagnostic, LspLocation } from './types.js'; + +/** + * Mock LSP server responses for integration testing. + * This simulates real LSP server behavior without requiring an actual server. + */ +const MOCK_LSP_RESPONSES = { + initialize: { + capabilities: { + textDocumentSync: 1, + completionProvider: {}, + hoverProvider: true, + definitionProvider: true, + referencesProvider: true, + documentSymbolProvider: true, + workspaceSymbolProvider: true, + codeActionProvider: true, + diagnosticProvider: { + interFileDependencies: true, + workspaceDiagnostics: true, + }, + }, + serverInfo: { + name: 'mock-lsp-server', + version: '1.0.0', + }, + }, + 'textDocument/definition': [ + { + uri: 'file:///test/workspace/src/types.ts', + range: { + start: { line: 10, character: 0 }, + end: { line: 10, character: 20 }, + }, + }, + ], + 'textDocument/references': [ + { + uri: 'file:///test/workspace/src/app.ts', + range: { + start: { line: 5, character: 10 }, + end: { line: 5, character: 20 }, + }, + }, + { + uri: 'file:///test/workspace/src/utils.ts', + range: { + start: { line: 15, character: 5 }, + end: { line: 15, character: 15 }, + }, + }, + ], + 'textDocument/hover': { + contents: { + kind: 'markdown', + value: + '```typescript\nfunction testFunc(): void\n```\n\nA test function.', + }, + range: { + start: { line: 10, character: 0 }, + end: { line: 10, character: 8 }, + }, + }, + 'textDocument/documentSymbol': [ + { + name: 'TestClass', + kind: 5, // Class + range: { + start: { line: 0, character: 0 }, + end: { line: 20, character: 1 }, + }, + selectionRange: { + start: { line: 0, character: 6 }, + end: { line: 0, character: 15 }, + }, + children: [ + { + name: 'constructor', + kind: 9, // Constructor + range: { + start: { line: 2, character: 2 }, + end: { line: 4, character: 3 }, + }, + selectionRange: { + start: { line: 2, character: 2 }, + end: { line: 2, character: 13 }, + }, + }, + ], + }, + ], + 'workspace/symbol': [ + { + name: 'TestClass', + kind: 5, // Class + location: { + uri: 'file:///test/workspace/src/test.ts', + range: { + start: { line: 0, character: 0 }, + end: { line: 20, character: 1 }, + }, + }, + }, + { + name: 'testFunction', + kind: 12, // Function + location: { + uri: 'file:///test/workspace/src/utils.ts', + range: { + start: { line: 5, character: 0 }, + end: { line: 10, character: 1 }, + }, + }, + containerName: 'utils', + }, + ], + 'textDocument/implementation': [ + { + uri: 'file:///test/workspace/src/impl.ts', + range: { + start: { line: 20, character: 0 }, + end: { line: 40, character: 1 }, + }, + }, + ], + 'textDocument/prepareCallHierarchy': [ + { + name: 'testFunction', + kind: 12, // Function + detail: '(param: string) => void', + uri: 'file:///test/workspace/src/utils.ts', + range: { + start: { line: 5, character: 0 }, + end: { line: 10, character: 1 }, + }, + selectionRange: { + start: { line: 5, character: 9 }, + end: { line: 5, character: 21 }, + }, + }, + ], + 'callHierarchy/incomingCalls': [ + { + from: { + name: 'callerFunction', + kind: 12, + uri: 'file:///test/workspace/src/caller.ts', + range: { + start: { line: 10, character: 0 }, + end: { line: 15, character: 1 }, + }, + selectionRange: { + start: { line: 10, character: 9 }, + end: { line: 10, character: 23 }, + }, + }, + fromRanges: [ + { + start: { line: 12, character: 2 }, + end: { line: 12, character: 16 }, + }, + ], + }, + ], + 'callHierarchy/outgoingCalls': [ + { + to: { + name: 'helperFunction', + kind: 12, + uri: 'file:///test/workspace/src/helper.ts', + range: { + start: { line: 0, character: 0 }, + end: { line: 5, character: 1 }, + }, + selectionRange: { + start: { line: 0, character: 9 }, + end: { line: 0, character: 23 }, + }, + }, + fromRanges: [ + { + start: { line: 7, character: 2 }, + end: { line: 7, character: 16 }, + }, + ], + }, + ], + 'textDocument/diagnostic': { + kind: 'full', + items: [ + { + range: { + start: { line: 5, character: 0 }, + end: { line: 5, character: 10 }, + }, + severity: 1, // Error + code: 'TS2304', + source: 'typescript', + message: "Cannot find name 'undeclaredVar'.", + }, + { + range: { + start: { line: 10, character: 0 }, + end: { line: 10, character: 15 }, + }, + severity: 2, // Warning + code: 'TS6133', + source: 'typescript', + message: "'unusedVar' is declared but its value is never read.", + tags: [1], // Unnecessary + }, + ], + }, + 'workspace/diagnostic': { + items: [ + { + kind: 'full', + uri: 'file:///test/workspace/src/app.ts', + items: [ + { + range: { + start: { line: 5, character: 0 }, + end: { line: 5, character: 10 }, + }, + severity: 1, + code: 'TS2304', + source: 'typescript', + message: "Cannot find name 'undeclaredVar'.", + }, + ], + }, + { + kind: 'full', + uri: 'file:///test/workspace/src/utils.ts', + items: [ + { + range: { + start: { line: 10, character: 0 }, + end: { line: 10, character: 15 }, + }, + severity: 2, + code: 'TS6133', + source: 'typescript', + message: "'unusedVar' is declared but its value is never read.", + }, + ], + }, + ], + }, + 'textDocument/codeAction': [ + { + title: "Add missing import 'React'", + kind: 'quickfix', + diagnostics: [ + { + range: { + start: { line: 0, character: 0 }, + end: { line: 0, character: 5 }, + }, + severity: 1, + message: "Cannot find name 'React'.", + }, + ], + edit: { + changes: { + 'file:///test/workspace/src/app.tsx': [ + { + range: { + start: { line: 0, character: 0 }, + end: { line: 0, character: 0 }, + }, + newText: "import React from 'react';\n", + }, + ], + }, + }, + isPreferred: true, + }, + { + title: 'Organize imports', + kind: 'source.organizeImports', + edit: { + changes: { + 'file:///test/workspace/src/app.tsx': [ + { + range: { + start: { line: 0, character: 0 }, + end: { line: 5, character: 0 }, + }, + newText: + "import { Component } from 'react';\nimport { helper } from './utils';\n", + }, + ], + }, + }, + }, + ], +}; + +/** + * Mock configuration for testing. + */ +class MockConfig { + rootPath = '/test/workspace'; + private trusted = true; + + isTrustedFolder(): boolean { + return this.trusted; + } + + setTrusted(trusted: boolean): void { + this.trusted = trusted; + } + + get(_key: string) { + return undefined; + } + + getProjectRoot(): string { + return this.rootPath; + } +} + +/** + * Mock workspace context for testing. + */ +class MockWorkspaceContext { + rootPath = '/test/workspace'; + + async fileExists(filePath: string): Promise { + return ( + filePath.endsWith('.json') || + filePath.includes('package.json') || + filePath.includes('.ts') + ); + } + + async readFile(filePath: string): Promise { + if (filePath.includes('.lsp.json')) { + return JSON.stringify({ + 'mock-lsp': { + languages: ['typescript', 'javascript'], + command: 'mock-lsp-server', + args: ['--stdio'], + transport: 'stdio', + }, + }); + } + return '{}'; + } + + resolvePath(relativePath: string): string { + return this.rootPath + '/' + relativePath; + } + + isPathWithinWorkspace(_path: string): boolean { + return true; + } + + getDirectories(): string[] { + return [this.rootPath]; + } +} + +/** + * Mock file discovery service for testing. + */ +class MockFileDiscoveryService { + async discoverFiles(_root: string, _options: unknown): Promise { + return [ + '/test/workspace/src/index.ts', + '/test/workspace/src/app.ts', + '/test/workspace/src/utils.ts', + '/test/workspace/src/types.ts', + ]; + } + + shouldIgnoreFile(file: string): boolean { + return file.includes('node_modules') || file.includes('.git'); + } +} + +/** + * Mock IDE context store for testing. + */ +class MockIdeContextStore {} + +describe('NativeLspService Integration Tests', () => { + let lspService: NativeLspService; + let mockConfig: MockConfig; + let mockWorkspace: MockWorkspaceContext; + let mockFileDiscovery: MockFileDiscoveryService; + let mockIdeStore: MockIdeContextStore; + let eventEmitter: EventEmitter; + + beforeEach(() => { + mockConfig = new MockConfig(); + mockWorkspace = new MockWorkspaceContext(); + mockFileDiscovery = new MockFileDiscoveryService(); + mockIdeStore = new MockIdeContextStore(); + eventEmitter = new EventEmitter(); + + lspService = new NativeLspService( + mockConfig as unknown as CoreConfig, + mockWorkspace as unknown as WorkspaceContext, + eventEmitter, + mockFileDiscovery as unknown as FileDiscoveryService, + mockIdeStore as unknown as IdeContextStore, + { + workspaceRoot: mockWorkspace.rootPath, + }, + ); + }); + + afterEach(() => { + vi.clearAllMocks(); + }); + + describe('Service Lifecycle', () => { + it('should initialize service correctly', () => { + expect(lspService).toBeDefined(); + }); + + it('should discover and prepare without errors', async () => { + await expect(lspService.discoverAndPrepare()).resolves.not.toThrow(); + }); + + it('should return status after discovery', async () => { + await lspService.discoverAndPrepare(); + const status = lspService.getStatus(); + expect(status).toBeDefined(); + expect(status instanceof Map).toBe(true); + }); + + it('should skip discovery for untrusted workspace', async () => { + mockConfig.setTrusted(false); + const untrustedService = new NativeLspService( + mockConfig as unknown as CoreConfig, + mockWorkspace as unknown as WorkspaceContext, + eventEmitter, + mockFileDiscovery as unknown as FileDiscoveryService, + mockIdeStore as unknown as IdeContextStore, + { + workspaceRoot: mockWorkspace.rootPath, + requireTrustedWorkspace: true, + }, + ); + + await untrustedService.discoverAndPrepare(); + const status = untrustedService.getStatus(); + expect(status.size).toBe(0); + }); + }); + + describe('Configuration Merging', () => { + it('should detect TypeScript/JavaScript in workspace', async () => { + await lspService.discoverAndPrepare(); + const status = lspService.getStatus(); + + // Should have detected TypeScript based on mock file discovery + // The exact server name depends on built-in presets + expect(status.size).toBeGreaterThanOrEqual(0); + }); + }); + + describe('LSP Operations - Mock Responses', () => { + // Note: These tests verify the structure of expected responses + // In a real integration test, you would mock the connection or use a real server + + it('should format definition response correctly', () => { + const response = MOCK_LSP_RESPONSES['textDocument/definition']; + expect(response).toHaveLength(1); + expect(response[0]).toHaveProperty('uri'); + expect(response[0]).toHaveProperty('range'); + expect(response[0].range.start).toHaveProperty('line'); + expect(response[0].range.start).toHaveProperty('character'); + }); + + it('should format references response correctly', () => { + const response = MOCK_LSP_RESPONSES['textDocument/references']; + expect(response).toHaveLength(2); + for (const ref of response) { + expect(ref).toHaveProperty('uri'); + expect(ref).toHaveProperty('range'); + } + }); + + it('should format hover response correctly', () => { + const response = MOCK_LSP_RESPONSES['textDocument/hover']; + expect(response).toHaveProperty('contents'); + expect(response.contents).toHaveProperty('value'); + expect(response.contents.value).toContain('testFunc'); + }); + + it('should format document symbols correctly', () => { + const response = MOCK_LSP_RESPONSES['textDocument/documentSymbol']; + expect(response).toHaveLength(1); + expect(response[0].name).toBe('TestClass'); + expect(response[0].kind).toBe(5); // Class + expect(response[0].children).toHaveLength(1); + }); + + it('should format workspace symbols correctly', () => { + const response = MOCK_LSP_RESPONSES['workspace/symbol']; + expect(response).toHaveLength(2); + expect(response[0].name).toBe('TestClass'); + expect(response[1].name).toBe('testFunction'); + expect(response[1].containerName).toBe('utils'); + }); + + it('should format call hierarchy items correctly', () => { + const response = MOCK_LSP_RESPONSES['textDocument/prepareCallHierarchy']; + expect(response).toHaveLength(1); + expect(response[0].name).toBe('testFunction'); + expect(response[0]).toHaveProperty('detail'); + expect(response[0]).toHaveProperty('range'); + expect(response[0]).toHaveProperty('selectionRange'); + }); + + it('should format incoming calls correctly', () => { + const response = MOCK_LSP_RESPONSES['callHierarchy/incomingCalls']; + expect(response).toHaveLength(1); + expect(response[0].from.name).toBe('callerFunction'); + expect(response[0].fromRanges).toHaveLength(1); + }); + + it('should format outgoing calls correctly', () => { + const response = MOCK_LSP_RESPONSES['callHierarchy/outgoingCalls']; + expect(response).toHaveLength(1); + expect(response[0].to.name).toBe('helperFunction'); + expect(response[0].fromRanges).toHaveLength(1); + }); + + it('should format diagnostics correctly', () => { + const response = MOCK_LSP_RESPONSES['textDocument/diagnostic']; + expect(response.items).toHaveLength(2); + expect(response.items[0].severity).toBe(1); // Error + expect(response.items[0].code).toBe('TS2304'); + expect(response.items[1].severity).toBe(2); // Warning + expect(response.items[1].tags).toContain(1); // Unnecessary + }); + + it('should format workspace diagnostics correctly', () => { + const response = MOCK_LSP_RESPONSES['workspace/diagnostic']; + expect(response.items).toHaveLength(2); + expect(response.items[0].uri).toContain('app.ts'); + expect(response.items[1].uri).toContain('utils.ts'); + }); + + it('should format code actions correctly', () => { + const response = MOCK_LSP_RESPONSES['textDocument/codeAction']; + expect(response).toHaveLength(2); + + const quickfix = response[0]; + expect(quickfix.title).toContain('import'); + expect(quickfix.kind).toBe('quickfix'); + expect(quickfix.isPreferred).toBe(true); + expect(quickfix.edit).toHaveProperty('changes'); + + const organizeImports = response[1]; + expect(organizeImports.kind).toBe('source.organizeImports'); + }); + }); + + describe('Diagnostic Normalization', () => { + it('should normalize severity levels correctly', () => { + const severityMap: Record = { + 1: 'error', + 2: 'warning', + 3: 'information', + 4: 'hint', + }; + + for (const [num, label] of Object.entries(severityMap)) { + expect(severityMap[Number(num)]).toBe(label); + } + }); + + it('should normalize diagnostic tags correctly', () => { + const tagMap: Record = { + 1: 'unnecessary', + 2: 'deprecated', + }; + + expect(tagMap[1]).toBe('unnecessary'); + expect(tagMap[2]).toBe('deprecated'); + }); + }); + + describe('Code Action Context', () => { + it('should support filtering by code action kind', () => { + const kinds = ['quickfix', 'refactor', 'source.organizeImports']; + const filteredActions = MOCK_LSP_RESPONSES[ + 'textDocument/codeAction' + ].filter((action) => kinds.includes(action.kind)); + expect(filteredActions).toHaveLength(2); + }); + + it('should support quick fix actions with diagnostics', () => { + const quickfix = MOCK_LSP_RESPONSES['textDocument/codeAction'][0]; + expect(quickfix.diagnostics).toBeDefined(); + expect(quickfix.diagnostics).toHaveLength(1); + expect(quickfix.edit).toBeDefined(); + }); + }); + + describe('Workspace Edit Application', () => { + it('should structure workspace edits correctly', () => { + const codeAction = MOCK_LSP_RESPONSES['textDocument/codeAction'][0]; + const edit = codeAction.edit; + + expect(edit).toHaveProperty('changes'); + expect(edit?.changes).toBeDefined(); + + const changes = edit?.changes as Record; + const uri = Object.keys(changes ?? {})[0]; + expect(uri).toContain('app.tsx'); + + const edits = changes?.[uri]; + expect(edits).toHaveLength(1); + expect(edits?.[0]).toHaveProperty('range'); + expect(edits?.[0]).toHaveProperty('newText'); + }); + }); + + describe('Error Handling', () => { + it('should handle missing workspace gracefully', async () => { + const emptyWorkspace = new MockWorkspaceContext(); + emptyWorkspace.getDirectories = () => []; + + const service = new NativeLspService( + mockConfig as unknown as CoreConfig, + emptyWorkspace as unknown as WorkspaceContext, + eventEmitter, + mockFileDiscovery as unknown as FileDiscoveryService, + mockIdeStore as unknown as IdeContextStore, + ); + + await expect(service.discoverAndPrepare()).resolves.not.toThrow(); + }); + + it('should return empty results when no server is ready', async () => { + // Before starting any servers, operations should return empty + const results = await lspService.workspaceSymbols('test'); + expect(results).toEqual([]); + }); + + it('should return empty diagnostics when no server is ready', async () => { + const uri = 'file:///test/workspace/src/app.ts'; + const results = await lspService.diagnostics(uri); + expect(results).toEqual([]); + }); + + it('should return empty code actions when no server is ready', async () => { + const uri = 'file:///test/workspace/src/app.ts'; + const range = { + start: { line: 0, character: 0 }, + end: { line: 0, character: 10 }, + }; + const context = { + diagnostics: [], + only: undefined, + triggerKind: 'invoked' as const, + }; + + const results = await lspService.codeActions(uri, range, context); + expect(results).toEqual([]); + }); + }); + + describe('Security Controls', () => { + it('should respect trust requirements', async () => { + mockConfig.setTrusted(false); + + const strictService = new NativeLspService( + mockConfig as unknown as CoreConfig, + mockWorkspace as unknown as WorkspaceContext, + eventEmitter, + mockFileDiscovery as unknown as FileDiscoveryService, + mockIdeStore as unknown as IdeContextStore, + { + requireTrustedWorkspace: true, + }, + ); + + await strictService.discoverAndPrepare(); + const status = strictService.getStatus(); + + // No servers should be discovered in untrusted workspace + expect(status.size).toBe(0); + }); + + it('should allow operations in trusted workspace', async () => { + mockConfig.setTrusted(true); + + await lspService.discoverAndPrepare(); + // Service should be ready to accept operations (even if no real server) + expect(lspService).toBeDefined(); + }); + }); +}); + +describe('LSP Response Type Validation', () => { + describe('LspDiagnostic', () => { + it('should have correct structure', () => { + const diagnostic: LspDiagnostic = { + range: { + start: { line: 0, character: 0 }, + end: { line: 0, character: 10 }, + }, + severity: 'error', + code: 'TS2304', + source: 'typescript', + message: 'Cannot find name.', + }; + + expect(diagnostic.range).toBeDefined(); + expect(diagnostic.severity).toBe('error'); + expect(diagnostic.code).toBe('TS2304'); + expect(diagnostic.source).toBe('typescript'); + expect(diagnostic.message).toBeDefined(); + }); + + it('should support optional fields', () => { + const minimalDiagnostic: LspDiagnostic = { + range: { + start: { line: 0, character: 0 }, + end: { line: 0, character: 10 }, + }, + message: 'Error message', + }; + + expect(minimalDiagnostic.severity).toBeUndefined(); + expect(minimalDiagnostic.code).toBeUndefined(); + expect(minimalDiagnostic.source).toBeUndefined(); + }); + }); + + describe('LspLocation', () => { + it('should have correct structure', () => { + const location: LspLocation = { + uri: 'file:///test/file.ts', + range: { + start: { line: 10, character: 5 }, + end: { line: 10, character: 15 }, + }, + }; + + expect(location.uri).toBe('file:///test/file.ts'); + expect(location.range.start.line).toBe(10); + expect(location.range.start.character).toBe(5); + expect(location.range.end.line).toBe(10); + expect(location.range.end.character).toBe(15); + }); + }); +}); diff --git a/packages/core/src/lsp/NativeLspService.test.ts b/packages/core/src/lsp/NativeLspService.test.ts new file mode 100644 index 000000000..218f2e3c7 --- /dev/null +++ b/packages/core/src/lsp/NativeLspService.test.ts @@ -0,0 +1,132 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +import { describe, beforeEach, expect, test } from 'vitest'; +import { NativeLspService } from './NativeLspService.js'; +import { EventEmitter } from 'events'; +import type { Config as CoreConfig } from '../config/config.js'; +import type { FileDiscoveryService } from '../services/fileDiscoveryService.js'; +import type { IdeContextStore } from '../ide/ideContext.js'; +import type { WorkspaceContext } from '../utils/workspaceContext.js'; + +// 模拟依赖项 +class MockConfig { + rootPath = '/test/workspace'; + + isTrustedFolder(): boolean { + return true; + } + + get(_key: string) { + return undefined; + } + + getProjectRoot(): string { + return this.rootPath; + } +} + +class MockWorkspaceContext { + rootPath = '/test/workspace'; + + async fileExists(_path: string): Promise { + return _path.endsWith('.json') || _path.includes('package.json'); + } + + async readFile(_path: string): Promise { + if (_path.includes('.lsp.json')) { + return JSON.stringify({ + typescript: { + command: 'typescript-language-server', + args: ['--stdio'], + transport: 'stdio', + }, + }); + } + return '{}'; + } + + resolvePath(_path: string): string { + return this.rootPath + '/' + _path; + } + + isPathWithinWorkspace(_path: string): boolean { + return true; + } + + getDirectories(): string[] { + return [this.rootPath]; + } +} + +class MockFileDiscoveryService { + async discoverFiles(_root: string, _options: unknown): Promise { + // 模拟发现一些文件 + return [ + '/test/workspace/src/index.ts', + '/test/workspace/src/utils.ts', + '/test/workspace/server.py', + '/test/workspace/main.go', + ]; + } + + shouldIgnoreFile(): boolean { + return false; + } +} + +class MockIdeContextStore { + // 模拟 IDE 上下文存储 +} + +describe('NativeLspService', () => { + let lspService: NativeLspService; + let mockConfig: MockConfig; + let mockWorkspace: MockWorkspaceContext; + let mockFileDiscovery: MockFileDiscoveryService; + let mockIdeStore: MockIdeContextStore; + let eventEmitter: EventEmitter; + + beforeEach(() => { + mockConfig = new MockConfig(); + mockWorkspace = new MockWorkspaceContext(); + mockFileDiscovery = new MockFileDiscoveryService(); + mockIdeStore = new MockIdeContextStore(); + eventEmitter = new EventEmitter(); + + lspService = new NativeLspService( + mockConfig as unknown as CoreConfig, + mockWorkspace as unknown as WorkspaceContext, + eventEmitter, + mockFileDiscovery as unknown as FileDiscoveryService, + mockIdeStore as unknown as IdeContextStore, + ); + }); + + test('should initialize correctly', () => { + expect(lspService).toBeDefined(); + }); + + test('should detect languages from workspace files', async () => { + // 这个测试需要修改,因为我们无法直接访问私有方法 + await lspService.discoverAndPrepare(); + const status = lspService.getStatus(); + + // 检查服务是否已准备就绪 + expect(status).toBeDefined(); + }); + + test('should merge built-in presets with user configs', async () => { + await lspService.discoverAndPrepare(); + + const status = lspService.getStatus(); + // 检查服务是否已准备就绪 + expect(status).toBeDefined(); + }); +}); + +// 注意:实际的单元测试需要适当的测试框架配置 +// 这里只是一个结构示例 diff --git a/packages/core/src/lsp/NativeLspService.ts b/packages/core/src/lsp/NativeLspService.ts new file mode 100644 index 000000000..23447ad70 --- /dev/null +++ b/packages/core/src/lsp/NativeLspService.ts @@ -0,0 +1,874 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +import type { Config as CoreConfig } from '../config/config.js'; +import type { Extension } from '../extension/extensionManager.js'; +import type { IdeContextStore } from '../ide/ideContext.js'; +import type { FileDiscoveryService } from '../services/fileDiscoveryService.js'; +import type { WorkspaceContext } from '../utils/workspaceContext.js'; +import type { + LspCallHierarchyIncomingCall, + LspCallHierarchyItem, + LspCallHierarchyOutgoingCall, + LspCodeAction, + LspCodeActionContext, + LspDefinition, + LspDiagnostic, + LspFileDiagnostics, + LspHoverResult, + LspLocation, + LspRange, + LspReference, + LspSymbolInformation, + LspTextEdit, + LspWorkspaceEdit, +} from './types.js'; +import type { EventEmitter } from 'events'; +import { LspConfigLoader } from './LspConfigLoader.js'; +import { LspLanguageDetector } from './LspLanguageDetector.js'; +import { LspResponseNormalizer } from './LspResponseNormalizer.js'; +import { LspServerManager } from './LspServerManager.js'; +import type { + LspConnectionInterface, + LspServerHandle, + LspServerStatus, + NativeLspServiceOptions, +} from './types.js'; +import * as path from 'path'; +import { fileURLToPath } from 'url'; +import * as fs from 'node:fs'; + +export class NativeLspService { + private config: CoreConfig; + private workspaceContext: WorkspaceContext; + private fileDiscoveryService: FileDiscoveryService; + private requireTrustedWorkspace: boolean; + private workspaceRoot: string; + private configLoader: LspConfigLoader; + private serverManager: LspServerManager; + private languageDetector: LspLanguageDetector; + private normalizer: LspResponseNormalizer; + + constructor( + config: CoreConfig, + workspaceContext: WorkspaceContext, + _eventEmitter: EventEmitter, + fileDiscoveryService: FileDiscoveryService, + _ideContextStore: IdeContextStore, + options: NativeLspServiceOptions = {}, + ) { + this.config = config; + this.workspaceContext = workspaceContext; + this.fileDiscoveryService = fileDiscoveryService; + this.requireTrustedWorkspace = options.requireTrustedWorkspace ?? true; + this.workspaceRoot = + options.workspaceRoot ?? + (config as { getProjectRoot: () => string }).getProjectRoot(); + this.configLoader = new LspConfigLoader(this.workspaceRoot); + this.languageDetector = new LspLanguageDetector( + this.workspaceContext, + this.fileDiscoveryService, + ); + this.normalizer = new LspResponseNormalizer(); + this.serverManager = new LspServerManager( + this.config, + this.workspaceContext, + this.fileDiscoveryService, + { + requireTrustedWorkspace: this.requireTrustedWorkspace, + workspaceRoot: this.workspaceRoot, + }, + ); + } + + /** + * Discover and prepare LSP servers + */ + async discoverAndPrepare(): Promise { + const workspaceTrusted = this.config.isTrustedFolder(); + this.serverManager.clearServerHandles(); + + // Check if workspace is trusted + if (this.requireTrustedWorkspace && !workspaceTrusted) { + console.log('Workspace is not trusted, skipping LSP server discovery'); + return; + } + + // Detect languages in workspace + const userConfigs = await this.configLoader.loadUserConfigs(); + const extensionConfigs = await this.configLoader.loadExtensionConfigs( + this.getActiveExtensions(), + ); + const extensionOverrides = + this.configLoader.collectExtensionToLanguageOverrides([ + ...extensionConfigs, + ...userConfigs, + ]); + const detectedLanguages = + await this.languageDetector.detectLanguages(extensionOverrides); + + // Merge configs: built-in presets + extension LSP configs + user .lsp.json + const serverConfigs = this.configLoader.mergeConfigs( + detectedLanguages, + extensionConfigs, + userConfigs, + ); + this.serverManager.setServerConfigs(serverConfigs); + } + + private getActiveExtensions(): Extension[] { + const configWithExtensions = this.config as unknown as { + getActiveExtensions?: () => Extension[]; + }; + return typeof configWithExtensions.getActiveExtensions === 'function' + ? configWithExtensions.getActiveExtensions() + : []; + } + + /** + * Start all LSP servers + */ + async start(): Promise { + await this.serverManager.startAll(); + } + + /** + * Stop all LSP servers + */ + async stop(): Promise { + await this.serverManager.stopAll(); + } + + /** + * Get LSP server status + */ + getStatus(): Map { + return this.serverManager.getStatus(); + } + + /** + * Get ready server handles filtered by optional server name. + * Each handle is guaranteed to have a valid connection. + * + * @param serverName - Optional server name to filter by + * @returns Array of [serverName, handle] tuples with active connections + */ + private getReadyHandles( + serverName?: string, + ): Array<[string, LspServerHandle & { connection: LspConnectionInterface }]> { + return Array.from(this.serverManager.getHandles().entries()).filter( + ( + entry, + ): entry is [ + string, + LspServerHandle & { connection: LspConnectionInterface }, + ] => + entry[1].status === 'READY' && + entry[1].connection !== undefined && + (!serverName || entry[0] === serverName), + ); + } + + /** + * Workspace symbol search across all ready LSP servers. + */ + async workspaceSymbols( + query: string, + limit = 50, + ): Promise { + const results: LspSymbolInformation[] = []; + + for (const [serverName, handle] of Array.from( + this.serverManager.getHandles(), + )) { + if (handle.status !== 'READY' || !handle.connection) { + continue; + } + try { + await this.serverManager.warmupTypescriptServer(handle); + let response = await handle.connection.request('workspace/symbol', { + query, + }); + if ( + this.serverManager.isTypescriptServer(handle) && + this.isNoProjectErrorResponse(response) + ) { + await this.serverManager.warmupTypescriptServer(handle, true); + response = await handle.connection.request('workspace/symbol', { + query, + }); + } + if (!Array.isArray(response)) { + continue; + } + for (const item of response) { + const symbol = this.normalizer.normalizeSymbolResult( + item, + serverName, + ); + if (symbol) { + results.push(symbol); + } + if (results.length >= limit) { + return results.slice(0, limit); + } + } + } catch (error) { + console.warn(`LSP workspace/symbol failed for ${serverName}:`, error); + } + } + + return results.slice(0, limit); + } + + /** + * Go to definition + */ + async definitions( + location: LspLocation, + serverName?: string, + limit = 50, + ): Promise { + const handles = this.getReadyHandles(serverName); + + for (const [name, handle] of handles) { + try { + await this.serverManager.warmupTypescriptServer(handle); + const response = await handle.connection.request( + 'textDocument/definition', + { + textDocument: { uri: location.uri }, + position: location.range.start, + }, + ); + const candidates = Array.isArray(response) + ? response + : response + ? [response] + : []; + const definitions: LspDefinition[] = []; + for (const def of candidates) { + const normalized = this.normalizer.normalizeLocationResult(def, name); + if (normalized) { + definitions.push(normalized); + if (definitions.length >= limit) { + return definitions.slice(0, limit); + } + } + } + if (definitions.length > 0) { + return definitions.slice(0, limit); + } + } catch (error) { + console.warn(`LSP textDocument/definition failed for ${name}:`, error); + } + } + + return []; + } + + /** + * Find references + */ + async references( + location: LspLocation, + serverName?: string, + includeDeclaration = false, + limit = 200, + ): Promise { + const handles = this.getReadyHandles(serverName); + + for (const [name, handle] of handles) { + try { + await this.serverManager.warmupTypescriptServer(handle); + const response = await handle.connection.request( + 'textDocument/references', + { + textDocument: { uri: location.uri }, + position: location.range.start, + context: { includeDeclaration }, + }, + ); + if (!Array.isArray(response)) { + continue; + } + const refs: LspReference[] = []; + for (const ref of response) { + const normalized = this.normalizer.normalizeLocationResult(ref, name); + if (normalized) { + refs.push(normalized); + } + if (refs.length >= limit) { + return refs.slice(0, limit); + } + } + if (refs.length > 0) { + return refs.slice(0, limit); + } + } catch (error) { + console.warn(`LSP textDocument/references failed for ${name}:`, error); + } + } + + return []; + } + + /** + * Get hover information + */ + async hover( + location: LspLocation, + serverName?: string, + ): Promise { + const handles = this.getReadyHandles(serverName); + + for (const [name, handle] of handles) { + try { + await this.serverManager.warmupTypescriptServer(handle); + const response = await handle.connection.request('textDocument/hover', { + textDocument: { uri: location.uri }, + position: location.range.start, + }); + const normalized = this.normalizer.normalizeHoverResult(response, name); + if (normalized) { + return normalized; + } + } catch (error) { + console.warn(`LSP textDocument/hover failed for ${name}:`, error); + } + } + + return null; + } + + /** + * Get document symbols + */ + async documentSymbols( + uri: string, + serverName?: string, + limit = 200, + ): Promise { + const handles = this.getReadyHandles(serverName); + + for (const [name, handle] of handles) { + try { + await this.serverManager.warmupTypescriptServer(handle); + const response = await handle.connection.request( + 'textDocument/documentSymbol', + { + textDocument: { uri }, + }, + ); + if (!Array.isArray(response)) { + continue; + } + const symbols: LspSymbolInformation[] = []; + for (const item of response) { + if (!item || typeof item !== 'object') { + continue; + } + const itemObj = item as Record; + if (this.normalizer.isDocumentSymbol(itemObj)) { + this.normalizer.collectDocumentSymbol( + itemObj, + uri, + name, + symbols, + limit, + ); + } else { + const normalized = this.normalizer.normalizeSymbolResult( + itemObj, + name, + ); + if (normalized) { + symbols.push(normalized); + } + } + if (symbols.length >= limit) { + return symbols.slice(0, limit); + } + } + if (symbols.length > 0) { + return symbols.slice(0, limit); + } + } catch (error) { + console.warn( + `LSP textDocument/documentSymbol failed for ${name}:`, + error, + ); + } + } + + return []; + } + + /** + * Find implementations + */ + async implementations( + location: LspLocation, + serverName?: string, + limit = 50, + ): Promise { + const handles = this.getReadyHandles(serverName); + + for (const [name, handle] of handles) { + try { + await this.serverManager.warmupTypescriptServer(handle); + const response = await handle.connection.request( + 'textDocument/implementation', + { + textDocument: { uri: location.uri }, + position: location.range.start, + }, + ); + const candidates = Array.isArray(response) + ? response + : response + ? [response] + : []; + const implementations: LspDefinition[] = []; + for (const item of candidates) { + const normalized = this.normalizer.normalizeLocationResult( + item, + name, + ); + if (normalized) { + implementations.push(normalized); + if (implementations.length >= limit) { + return implementations.slice(0, limit); + } + } + } + if (implementations.length > 0) { + return implementations.slice(0, limit); + } + } catch (error) { + console.warn( + `LSP textDocument/implementation failed for ${name}:`, + error, + ); + } + } + + return []; + } + + /** + * Prepare call hierarchy + */ + async prepareCallHierarchy( + location: LspLocation, + serverName?: string, + limit = 50, + ): Promise { + const handles = this.getReadyHandles(serverName); + + for (const [name, handle] of handles) { + try { + await this.serverManager.warmupTypescriptServer(handle); + const response = await handle.connection.request( + 'textDocument/prepareCallHierarchy', + { + textDocument: { uri: location.uri }, + position: location.range.start, + }, + ); + const candidates = Array.isArray(response) + ? response + : response + ? [response] + : []; + const items: LspCallHierarchyItem[] = []; + for (const item of candidates) { + const normalized = this.normalizer.normalizeCallHierarchyItem( + item, + name, + ); + if (normalized) { + items.push(normalized); + if (items.length >= limit) { + return items.slice(0, limit); + } + } + } + if (items.length > 0) { + return items.slice(0, limit); + } + } catch (error) { + console.warn( + `LSP textDocument/prepareCallHierarchy failed for ${name}:`, + error, + ); + } + } + + return []; + } + + /** + * Find callers of the current function + */ + async incomingCalls( + item: LspCallHierarchyItem, + serverName?: string, + limit = 50, + ): Promise { + const targetServer = serverName ?? item.serverName; + const handles = this.getReadyHandles(targetServer); + + for (const [name, handle] of handles) { + try { + await this.serverManager.warmupTypescriptServer(handle); + const response = await handle.connection.request( + 'callHierarchy/incomingCalls', + { + item: this.normalizer.toCallHierarchyItemParams(item), + }, + ); + if (!Array.isArray(response)) { + continue; + } + const calls: LspCallHierarchyIncomingCall[] = []; + for (const call of response) { + const normalized = this.normalizer.normalizeIncomingCall(call, name); + if (normalized) { + calls.push(normalized); + if (calls.length >= limit) { + return calls.slice(0, limit); + } + } + } + if (calls.length > 0) { + return calls.slice(0, limit); + } + } catch (error) { + console.warn( + `LSP callHierarchy/incomingCalls failed for ${name}:`, + error, + ); + } + } + + return []; + } + + /** + * Find functions called by the current function + */ + async outgoingCalls( + item: LspCallHierarchyItem, + serverName?: string, + limit = 50, + ): Promise { + const targetServer = serverName ?? item.serverName; + const handles = this.getReadyHandles(targetServer); + + for (const [name, handle] of handles) { + try { + await this.serverManager.warmupTypescriptServer(handle); + const response = await handle.connection.request( + 'callHierarchy/outgoingCalls', + { + item: this.normalizer.toCallHierarchyItemParams(item), + }, + ); + if (!Array.isArray(response)) { + continue; + } + const calls: LspCallHierarchyOutgoingCall[] = []; + for (const call of response) { + const normalized = this.normalizer.normalizeOutgoingCall(call, name); + if (normalized) { + calls.push(normalized); + if (calls.length >= limit) { + return calls.slice(0, limit); + } + } + } + if (calls.length > 0) { + return calls.slice(0, limit); + } + } catch (error) { + console.warn( + `LSP callHierarchy/outgoingCalls failed for ${name}:`, + error, + ); + } + } + + return []; + } + + /** + * Get diagnostics for a document + */ + async diagnostics( + uri: string, + serverName?: string, + ): Promise { + const handles = this.getReadyHandles(serverName); + const allDiagnostics: LspDiagnostic[] = []; + + for (const [name, handle] of handles) { + try { + await this.serverManager.warmupTypescriptServer(handle); + + // Request pull diagnostics if the server supports it + const response = await handle.connection.request( + 'textDocument/diagnostic', + { + textDocument: { uri }, + }, + ); + + if (response && typeof response === 'object') { + const responseObj = response as Record; + const items = responseObj['items']; + if (Array.isArray(items)) { + for (const item of items) { + const normalized = this.normalizer.normalizeDiagnostic( + item, + name, + ); + if (normalized) { + allDiagnostics.push(normalized); + } + } + } + } + } catch (error) { + // Fall back to cached diagnostics from publishDiagnostics notifications + // This is handled by the notification handler if implemented + console.warn(`LSP textDocument/diagnostic failed for ${name}:`, error); + } + } + + return allDiagnostics; + } + + /** + * Get diagnostics for all documents in the workspace + */ + async workspaceDiagnostics( + serverName?: string, + limit = 100, + ): Promise { + const handles = this.getReadyHandles(serverName); + const results: LspFileDiagnostics[] = []; + + for (const [name, handle] of handles) { + try { + await this.serverManager.warmupTypescriptServer(handle); + + // Request workspace diagnostics if supported + const response = await handle.connection.request( + 'workspace/diagnostic', + { + previousResultIds: [], + }, + ); + + if (response && typeof response === 'object') { + const responseObj = response as Record; + const items = responseObj['items']; + if (Array.isArray(items)) { + for (const item of items) { + if (results.length >= limit) { + break; + } + const normalized = this.normalizer.normalizeFileDiagnostics( + item, + name, + ); + if (normalized && normalized.diagnostics.length > 0) { + results.push(normalized); + } + } + } + } + } catch (error) { + console.warn(`LSP workspace/diagnostic failed for ${name}:`, error); + } + + if (results.length >= limit) { + break; + } + } + + return results.slice(0, limit); + } + + /** + * Get code actions at the specified position + */ + async codeActions( + uri: string, + range: LspRange, + context: LspCodeActionContext, + serverName?: string, + limit = 20, + ): Promise { + const handles = this.getReadyHandles(serverName); + + for (const [name, handle] of handles) { + try { + await this.serverManager.warmupTypescriptServer(handle); + + // Convert context diagnostics to LSP format + const lspDiagnostics = context.diagnostics.map((d: LspDiagnostic) => + this.normalizer.denormalizeDiagnostic(d), + ); + + const response = await handle.connection.request( + 'textDocument/codeAction', + { + textDocument: { uri }, + range, + context: { + diagnostics: lspDiagnostics, + only: context.only, + triggerKind: + context.triggerKind === 'automatic' + ? 2 // CodeActionTriggerKind.Automatic + : 1, // CodeActionTriggerKind.Invoked + }, + }, + ); + + if (!Array.isArray(response)) { + continue; + } + + const actions: LspCodeAction[] = []; + for (const item of response) { + const normalized = this.normalizer.normalizeCodeAction(item, name); + if (normalized) { + actions.push(normalized); + if (actions.length >= limit) { + break; + } + } + } + + if (actions.length > 0) { + return actions.slice(0, limit); + } + } catch (error) { + console.warn(`LSP textDocument/codeAction failed for ${name}:`, error); + } + } + + return []; + } + + /** + * Apply workspace edit + */ + async applyWorkspaceEdit( + edit: LspWorkspaceEdit, + _serverName?: string, + ): Promise { + // Apply edits locally - this doesn't go through LSP server + // Instead, it applies the edits to the file system + try { + if (edit.changes) { + for (const [uri, edits] of Object.entries(edit.changes)) { + await this.applyTextEdits(uri, edits as LspTextEdit[]); + } + } + + if (edit.documentChanges) { + for (const docChange of edit.documentChanges) { + await this.applyTextEdits( + docChange.textDocument.uri, + docChange.edits, + ); + } + } + + return true; + } catch (error) { + console.error('Failed to apply workspace edit:', error); + return false; + } + } + + /** + * Apply text edits to a file + */ + private async applyTextEdits( + uri: string, + edits: LspTextEdit[], + ): Promise { + let filePath = uri.startsWith('file://') ? fileURLToPath(uri) : uri; + if (!path.isAbsolute(filePath)) { + filePath = path.resolve(this.workspaceRoot, filePath); + } + if (!this.workspaceContext.isPathWithinWorkspace(filePath)) { + throw new Error(`Refusing to apply edits outside workspace: ${filePath}`); + } + + // Read the current file content + let content: string; + try { + content = fs.readFileSync(filePath, 'utf-8'); + } catch { + // File doesn't exist, treat as empty + content = ''; + } + + // Sort edits in reverse order to apply from end to start + const sortedEdits = [...edits].sort((a, b) => { + if (a.range.start.line !== b.range.start.line) { + return b.range.start.line - a.range.start.line; + } + return b.range.start.character - a.range.start.character; + }); + + const lines = content.split('\n'); + + for (const edit of sortedEdits) { + const { range, newText } = edit; + const startLine = range.start.line; + const endLine = range.end.line; + const startChar = range.start.character; + const endChar = range.end.character; + + // Get the affected lines + const startLineText = lines[startLine] ?? ''; + const endLineText = lines[endLine] ?? ''; + + // Build the new content + const before = startLineText.slice(0, startChar); + const after = endLineText.slice(endChar); + + // Replace the range with new text + const newLines = (before + newText + after).split('\n'); + + // Replace affected lines + lines.splice(startLine, endLine - startLine + 1, ...newLines); + } + + // Write back to file + fs.writeFileSync(filePath, lines.join('\n'), 'utf-8'); + } + + private isNoProjectErrorResponse(response: unknown): boolean { + if (!response) { + return false; + } + const message = + typeof response === 'string' + ? response + : typeof (response as Record)['message'] === 'string' + ? ((response as Record)['message'] as string) + : ''; + return message.includes('No Project'); + } +} diff --git a/packages/core/src/lsp/constants.ts b/packages/core/src/lsp/constants.ts new file mode 100644 index 000000000..04fa4bb31 --- /dev/null +++ b/packages/core/src/lsp/constants.ts @@ -0,0 +1,101 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +import type { LspCodeActionKind, LspDiagnosticSeverity } from './types.js'; + +// ============================================================================ +// Timeout Constants +// ============================================================================ + +/** Default timeout for LSP server startup in milliseconds */ +export const DEFAULT_LSP_STARTUP_TIMEOUT_MS = 10000; + +/** Default timeout for LSP requests in milliseconds */ +export const DEFAULT_LSP_REQUEST_TIMEOUT_MS = 15000; + +/** Default delay for TypeScript server warm-up in milliseconds */ +export const DEFAULT_LSP_WARMUP_DELAY_MS = 150; + +/** Default timeout for command existence check in milliseconds */ +export const DEFAULT_LSP_COMMAND_CHECK_TIMEOUT_MS = 2000; + +// ============================================================================ +// Retry Constants +// ============================================================================ + +/** Default maximum number of server restart attempts */ +export const DEFAULT_LSP_MAX_RESTARTS = 3; + +/** Default initial delay between socket connection retries in milliseconds */ +export const DEFAULT_LSP_SOCKET_RETRY_DELAY_MS = 250; + +/** Default maximum delay between socket connection retries in milliseconds */ +export const DEFAULT_LSP_SOCKET_MAX_RETRY_DELAY_MS = 1000; + +// ============================================================================ +// LSP Protocol Labels +// ============================================================================ + +/** + * Symbol kind labels for converting numeric LSP SymbolKind to readable strings. + * Based on the LSP specification: + * https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#symbolKind + */ +export const SYMBOL_KIND_LABELS: Record = { + 1: 'File', + 2: 'Module', + 3: 'Namespace', + 4: 'Package', + 5: 'Class', + 6: 'Method', + 7: 'Property', + 8: 'Field', + 9: 'Constructor', + 10: 'Enum', + 11: 'Interface', + 12: 'Function', + 13: 'Variable', + 14: 'Constant', + 15: 'String', + 16: 'Number', + 17: 'Boolean', + 18: 'Array', + 19: 'Object', + 20: 'Key', + 21: 'Null', + 22: 'EnumMember', + 23: 'Struct', + 24: 'Event', + 25: 'Operator', + 26: 'TypeParameter', +}; + +/** + * Diagnostic severity labels for converting numeric LSP DiagnosticSeverity to readable strings. + * Based on the LSP specification. + */ +export const DIAGNOSTIC_SEVERITY_LABELS: Record = + { + 1: 'error', + 2: 'warning', + 3: 'information', + 4: 'hint', + }; + +/** + * Code action kind labels from LSP specification. + */ +export const CODE_ACTION_KIND_LABELS: Record = { + '': 'quickfix', + quickfix: 'quickfix', + refactor: 'refactor', + 'refactor.extract': 'refactor.extract', + 'refactor.inline': 'refactor.inline', + 'refactor.rewrite': 'refactor.rewrite', + source: 'source', + 'source.organizeImports': 'source.organizeImports', + 'source.fixAll': 'source.fixAll', +}; diff --git a/packages/core/src/lsp/types.ts b/packages/core/src/lsp/types.ts new file mode 100644 index 000000000..f7806fe12 --- /dev/null +++ b/packages/core/src/lsp/types.ts @@ -0,0 +1,523 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +export interface LspPosition { + line: number; + character: number; +} + +export interface LspRange { + start: LspPosition; + end: LspPosition; +} + +export interface LspLocation { + uri: string; + range: LspRange; +} + +export interface LspLocationWithServer extends LspLocation { + serverName?: string; +} + +export interface LspSymbolInformation { + name: string; + kind?: string; + location: LspLocation; + containerName?: string; + serverName?: string; +} + +export interface LspReference extends LspLocationWithServer { + readonly serverName?: string; +} + +export interface LspDefinition extends LspLocationWithServer { + readonly serverName?: string; +} + +/** + * Hover result containing documentation or type information. + */ +export interface LspHoverResult { + /** The hover content as a string (normalized from MarkupContent/MarkedString). */ + contents: string; + /** Optional range that the hover applies to. */ + range?: LspRange; + /** The LSP server that provided this result. */ + serverName?: string; +} + +/** + * Call hierarchy item representing a function, method, or callable. + */ +export interface LspCallHierarchyItem { + /** The name of this item. */ + name: string; + /** The kind of this item (function, method, constructor, etc.) as readable string. */ + kind?: string; + /** The raw numeric SymbolKind from LSP, preserved for server communication. */ + rawKind?: number; + /** Additional details like signature or file path. */ + detail?: string; + /** The URI of the document containing this item. */ + uri: string; + /** The full range of this item. */ + range: LspRange; + /** The range that should be selected when navigating to this item. */ + selectionRange: LspRange; + /** Opaque data used by the server for subsequent calls. */ + data?: unknown; + /** The LSP server that provided this item. */ + serverName?: string; +} + +/** + * Incoming call representing a function that calls the target. + */ +export interface LspCallHierarchyIncomingCall { + /** The caller item. */ + from: LspCallHierarchyItem; + /** The ranges where the call occurs within the caller. */ + fromRanges: LspRange[]; +} + +/** + * Outgoing call representing a function called by the target. + */ +export interface LspCallHierarchyOutgoingCall { + /** The callee item. */ + to: LspCallHierarchyItem; + /** The ranges where the call occurs within the caller. */ + fromRanges: LspRange[]; +} + +/** + * Diagnostic severity levels from LSP specification. + */ +export type LspDiagnosticSeverity = + | 'error' + | 'warning' + | 'information' + | 'hint'; + +/** + * A diagnostic message from a language server. + */ +export interface LspDiagnostic { + /** The range at which the diagnostic applies. */ + range: LspRange; + /** The diagnostic's severity (error, warning, information, hint). */ + severity?: LspDiagnosticSeverity; + /** The diagnostic's code (string or number). */ + code?: string | number; + /** A human-readable string describing the source (e.g., 'typescript'). */ + source?: string; + /** The diagnostic's message. */ + message: string; + /** Additional metadata about the diagnostic. */ + tags?: LspDiagnosticTag[]; + /** Related diagnostic information. */ + relatedInformation?: LspDiagnosticRelatedInformation[]; + /** The LSP server that provided this diagnostic. */ + serverName?: string; +} + +/** + * Diagnostic tags from LSP specification. + */ +export type LspDiagnosticTag = 'unnecessary' | 'deprecated'; + +/** + * Related diagnostic information. + */ +export interface LspDiagnosticRelatedInformation { + /** The location of the related diagnostic. */ + location: LspLocation; + /** The message of the related diagnostic. */ + message: string; +} + +/** + * A file's diagnostics grouped by URI. + */ +export interface LspFileDiagnostics { + /** The document URI. */ + uri: string; + /** The diagnostics for this document. */ + diagnostics: LspDiagnostic[]; + /** The LSP server that provided these diagnostics. */ + serverName?: string; +} + +/** + * A code action represents a change that can be performed in code. + */ +export interface LspCodeAction { + /** A short, human-readable title for this code action. */ + title: string; + /** The kind of the code action (quickfix, refactor, etc.). */ + kind?: LspCodeActionKind; + /** The diagnostics that this code action resolves. */ + diagnostics?: LspDiagnostic[]; + /** Marks this as a preferred action. */ + isPreferred?: boolean; + /** The workspace edit this code action performs. */ + edit?: LspWorkspaceEdit; + /** A command this code action executes. */ + command?: LspCommand; + /** Opaque data used by the server for subsequent resolve calls. */ + data?: unknown; + /** The LSP server that provided this code action. */ + serverName?: string; +} + +/** + * Code action kinds from LSP specification. + */ +export type LspCodeActionKind = + | 'quickfix' + | 'refactor' + | 'refactor.extract' + | 'refactor.inline' + | 'refactor.rewrite' + | 'source' + | 'source.organizeImports' + | 'source.fixAll' + | string; + +/** + * A workspace edit represents changes to many resources managed in the workspace. + */ +export interface LspWorkspaceEdit { + /** Holds changes to existing documents. */ + changes?: Record; + /** Versioned document changes (more precise control). */ + documentChanges?: LspTextDocumentEdit[]; +} + +/** + * A text edit applicable to a document. + */ +export interface LspTextEdit { + /** The range of the text document to be manipulated. */ + range: LspRange; + /** The string to be inserted (empty string for delete). */ + newText: string; +} + +/** + * Describes textual changes on a single text document. + */ +export interface LspTextDocumentEdit { + /** The text document to change. */ + textDocument: { + uri: string; + version?: number | null; + }; + /** The edits to be applied. */ + edits: LspTextEdit[]; +} + +/** + * A command represents a reference to a command. + */ +export interface LspCommand { + /** Title of the command. */ + title: string; + /** The identifier of the actual command handler. */ + command: string; + /** Arguments to the command handler. */ + arguments?: unknown[]; +} + +/** + * Context for code action requests. + */ +export interface LspCodeActionContext { + /** The diagnostics for which code actions are requested. */ + diagnostics: LspDiagnostic[]; + /** Requested kinds of code actions to return. */ + only?: LspCodeActionKind[]; + /** The reason why code actions were requested. */ + triggerKind?: 'invoked' | 'automatic'; +} + +export interface LspClient { + /** + * Search for symbols across the workspace. + */ + workspaceSymbols( + query: string, + limit?: number, + ): Promise; + + /** + * Get hover information (documentation, type info) for a symbol. + */ + hover( + location: LspLocation, + serverName?: string, + ): Promise; + + /** + * Get all symbols in a document. + */ + documentSymbols( + uri: string, + serverName?: string, + limit?: number, + ): Promise; + + /** + * Find where a symbol is defined. + */ + definitions( + location: LspLocation, + serverName?: string, + limit?: number, + ): Promise; + + /** + * Find implementations of an interface or abstract method. + */ + implementations( + location: LspLocation, + serverName?: string, + limit?: number, + ): Promise; + + /** + * Find all references to a symbol. + */ + references( + location: LspLocation, + serverName?: string, + includeDeclaration?: boolean, + limit?: number, + ): Promise; + + /** + * Prepare call hierarchy item at a position (functions/methods). + */ + prepareCallHierarchy( + location: LspLocation, + serverName?: string, + limit?: number, + ): Promise; + + /** + * Find all functions/methods that call the given function. + */ + incomingCalls( + item: LspCallHierarchyItem, + serverName?: string, + limit?: number, + ): Promise; + + /** + * Find all functions/methods called by the given function. + */ + outgoingCalls( + item: LspCallHierarchyItem, + serverName?: string, + limit?: number, + ): Promise; + + /** + * Get diagnostics for a specific document. + */ + diagnostics(uri: string, serverName?: string): Promise; + + /** + * Get diagnostics for all open documents in the workspace. + */ + workspaceDiagnostics( + serverName?: string, + limit?: number, + ): Promise; + + /** + * Get code actions available at a specific location. + */ + codeActions( + uri: string, + range: LspRange, + context: LspCodeActionContext, + serverName?: string, + limit?: number, + ): Promise; + + /** + * Apply a workspace edit (from code action or other sources). + */ + applyWorkspaceEdit( + edit: LspWorkspaceEdit, + serverName?: string, + ): Promise; +} + +// ============================================================================ +// LSP Service Types (migrated from cli) +// ============================================================================ + +import type { ChildProcess } from 'node:child_process'; + +/** + * LSP server initialization options passed during the initialize request. + */ +export interface LspInitializationOptions { + [key: string]: unknown; +} + +/** + * Socket connection options for TCP or Unix socket transport. + */ +export interface LspSocketOptions { + /** Host address for TCP connections */ + host?: string; + /** Port number for TCP connections */ + port?: number; + /** Path for Unix socket connections */ + path?: string; +} + +/** + * Configuration for an LSP server instance. + */ +export interface LspServerConfig { + /** Unique name identifier for the server */ + name: string; + /** List of languages this server handles */ + languages: string[]; + /** Command to start the server (required for stdio transport) */ + command?: string; + /** Command line arguments */ + args?: string[]; + /** Transport type: stdio, tcp, or socket */ + transport: 'stdio' | 'tcp' | 'socket'; + /** Environment variables for the server process */ + env?: Record; + /** LSP initialization options */ + initializationOptions?: LspInitializationOptions; + /** Server-specific settings */ + settings?: Record; + /** Custom file extension to language mappings */ + extensionToLanguage?: Record; + /** Root URI for the workspace */ + rootUri: string; + /** Workspace folder path */ + workspaceFolder?: string; + /** Startup timeout in milliseconds */ + startupTimeout?: number; + /** Shutdown timeout in milliseconds */ + shutdownTimeout?: number; + /** Whether to restart on crash */ + restartOnCrash?: boolean; + /** Maximum number of restart attempts */ + maxRestarts?: number; + /** Whether trusted workspace is required */ + trustRequired?: boolean; + /** Socket connection options */ + socket?: LspSocketOptions; +} + +/** + * JSON-RPC message format for LSP communication. + */ +export interface JsonRpcMessage { + jsonrpc: string; + id?: number | string; + method?: string; + params?: unknown; + result?: unknown; + error?: { + code: number; + message: string; + data?: unknown; + }; +} + +/** + * Interface for LSP JSON-RPC connection. + */ +export interface LspConnectionInterface { + /** Start listening on a readable stream */ + listen: (readable: NodeJS.ReadableStream) => void; + /** Send a message to the server */ + send: (message: JsonRpcMessage) => void; + /** Register a notification handler */ + onNotification: (handler: (notification: JsonRpcMessage) => void) => void; + /** Register a request handler */ + onRequest: (handler: (request: JsonRpcMessage) => Promise) => void; + /** Send a request and wait for response */ + request: (method: string, params: unknown) => Promise; + /** Send initialize request */ + initialize: (params: unknown) => Promise; + /** Send shutdown request */ + shutdown: () => Promise; + /** End the connection */ + end: () => void; +} + +/** + * Status of an LSP server instance. + */ +export type LspServerStatus = + | 'NOT_STARTED' + | 'IN_PROGRESS' + | 'READY' + | 'FAILED'; + +/** + * Handle for managing an LSP server instance. + */ +export interface LspServerHandle { + /** Server configuration */ + config: LspServerConfig; + /** Current status */ + status: LspServerStatus; + /** Active connection to the server */ + connection?: LspConnectionInterface; + /** Server process (for stdio transport) */ + process?: ChildProcess; + /** Error that caused failure */ + error?: Error; + /** Whether TypeScript server has been warmed up */ + warmedUp?: boolean; + /** Whether stop was explicitly requested */ + stopRequested?: boolean; + /** Number of restart attempts */ + restartAttempts?: number; + /** Lock to prevent concurrent startup attempts */ + startingPromise?: Promise; +} + +/** + * Options for NativeLspService constructor. + */ +export interface NativeLspServiceOptions { + /** Whether to require trusted workspace */ + requireTrustedWorkspace?: boolean; + /** Override workspace root path */ + workspaceRoot?: string; +} + +/** + * Result from creating an LSP connection. + */ +export interface LspConnectionResult { + /** The JSON-RPC connection */ + connection: LspConnectionInterface; + /** Server process (for stdio transport) */ + process?: ChildProcess; + /** Shutdown the connection gracefully */ + shutdown: () => Promise; + /** Force exit the connection */ + exit: () => void; + /** Send initialize request */ + initialize: (params: unknown) => Promise; +} diff --git a/packages/core/src/tools/lsp.test.ts b/packages/core/src/tools/lsp.test.ts new file mode 100644 index 000000000..a74f5453c --- /dev/null +++ b/packages/core/src/tools/lsp.test.ts @@ -0,0 +1,1233 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +import { describe, it, expect, vi, beforeEach, type Mock } from 'vitest'; +import path from 'node:path'; +import { pathToFileURL } from 'node:url'; +import type { Config } from '../config/config.js'; +import type { + LspCallHierarchyIncomingCall, + LspCallHierarchyItem, + LspCallHierarchyOutgoingCall, + LspClient, + LspDefinition, + LspHoverResult, + LspLocation, + LspReference, + LspSymbolInformation, +} from '../lsp/types.js'; +import { LspTool, type LspToolParams, type LspOperation } from './lsp.js'; + +const abortSignal = new AbortController().signal; +const workspaceRoot = '/test/workspace'; + +/** + * Helper to resolve a path relative to workspace root. + */ +const resolvePath = (...segments: string[]) => + path.join(workspaceRoot, ...segments); + +/** + * Helper to convert file path to URI. + */ +const toUri = (filePath: string) => pathToFileURL(filePath).toString(); + +/** + * Helper to create a mock LspLocation. + */ +const createLocation = ( + filePath: string, + line: number, + character: number, +): LspLocation => ({ + uri: toUri(filePath), + range: { + start: { line, character }, + end: { line, character }, + }, +}); + +/** + * Create a mock LspClient with all methods mocked. + */ +const createMockClient = (): LspClient => + ({ + workspaceSymbols: vi.fn().mockResolvedValue([]), + hover: vi.fn().mockResolvedValue(null), + documentSymbols: vi.fn().mockResolvedValue([]), + definitions: vi.fn().mockResolvedValue([]), + implementations: vi.fn().mockResolvedValue([]), + references: vi.fn().mockResolvedValue([]), + prepareCallHierarchy: vi.fn().mockResolvedValue([]), + incomingCalls: vi.fn().mockResolvedValue([]), + outgoingCalls: vi.fn().mockResolvedValue([]), + }) as unknown as LspClient; + +/** + * Create a mock Config for testing. + */ +const createMockConfig = (client?: LspClient, enabled = true): Config => + ({ + getLspClient: () => client, + isLspEnabled: () => enabled, + getProjectRoot: () => workspaceRoot, + }) as unknown as Config; + +/** + * Create a LspTool with mock config. + */ +const createTool = (client?: LspClient, enabled = true) => + new LspTool(createMockConfig(client, enabled)); + +describe('LspTool', () => { + describe('validateToolParams', () => { + let tool: LspTool; + + beforeEach(() => { + tool = createTool(); + }); + + describe('location-based operations', () => { + const locationOperations: LspOperation[] = [ + 'goToDefinition', + 'findReferences', + 'hover', + 'goToImplementation', + 'prepareCallHierarchy', + ]; + + it.each(locationOperations)( + 'requires filePath for %s operation', + (operation) => { + const result = tool.validateToolParams({ + operation, + } as LspToolParams); + expect(result).toBe(`filePath is required for ${operation}.`); + }, + ); + + it.each(locationOperations)( + 'requires line for %s operation', + (operation) => { + const result = tool.validateToolParams({ + operation, + filePath: 'src/app.ts', + } as LspToolParams); + expect(result).toBe(`line is required for ${operation}.`); + }, + ); + + it.each(locationOperations)( + 'passes validation with valid params for %s', + (operation) => { + const result = tool.validateToolParams({ + operation, + filePath: 'src/app.ts', + line: 10, + character: 5, + } as LspToolParams); + expect(result).toBeNull(); + }, + ); + }); + + describe('documentSymbol operation', () => { + it('requires filePath for documentSymbol', () => { + const result = tool.validateToolParams({ + operation: 'documentSymbol', + } as LspToolParams); + expect(result).toBe('filePath is required for documentSymbol.'); + }); + + it('passes validation with filePath', () => { + const result = tool.validateToolParams({ + operation: 'documentSymbol', + filePath: 'src/app.ts', + } as LspToolParams); + expect(result).toBeNull(); + }); + }); + + describe('workspaceSymbol operation', () => { + it('requires query for workspaceSymbol', () => { + const result = tool.validateToolParams({ + operation: 'workspaceSymbol', + } as LspToolParams); + expect(result).toBe('query is required for workspaceSymbol.'); + }); + + it('rejects empty query', () => { + const result = tool.validateToolParams({ + operation: 'workspaceSymbol', + query: ' ', + } as LspToolParams); + expect(result).toBe('query is required for workspaceSymbol.'); + }); + + it('passes validation with query', () => { + const result = tool.validateToolParams({ + operation: 'workspaceSymbol', + query: 'Widget', + } as LspToolParams); + expect(result).toBeNull(); + }); + }); + + describe('call hierarchy operations', () => { + it('requires callHierarchyItem for incomingCalls', () => { + const result = tool.validateToolParams({ + operation: 'incomingCalls', + } as LspToolParams); + expect(result).toBe('callHierarchyItem is required for incomingCalls.'); + }); + + it('requires callHierarchyItem for outgoingCalls', () => { + const result = tool.validateToolParams({ + operation: 'outgoingCalls', + } as LspToolParams); + expect(result).toBe('callHierarchyItem is required for outgoingCalls.'); + }); + + it('passes validation with callHierarchyItem', () => { + const item: LspCallHierarchyItem = { + name: 'testFunc', + uri: 'file:///test.ts', + range: { + start: { line: 0, character: 0 }, + end: { line: 0, character: 10 }, + }, + selectionRange: { + start: { line: 0, character: 0 }, + end: { line: 0, character: 10 }, + }, + }; + const result = tool.validateToolParams({ + operation: 'incomingCalls', + callHierarchyItem: item, + } as LspToolParams); + expect(result).toBeNull(); + }); + }); + + describe('numeric parameter validation', () => { + it('rejects non-positive line', () => { + const result = tool.validateToolParams({ + operation: 'goToDefinition', + filePath: 'src/app.ts', + line: 0, + } as LspToolParams); + expect(result).toBe('line must be a positive number.'); + }); + + it('rejects negative line', () => { + const result = tool.validateToolParams({ + operation: 'goToDefinition', + filePath: 'src/app.ts', + line: -1, + } as LspToolParams); + expect(result).toBe('line must be a positive number.'); + }); + + it('rejects non-positive character', () => { + const result = tool.validateToolParams({ + operation: 'goToDefinition', + filePath: 'src/app.ts', + line: 1, + character: 0, + } as LspToolParams); + expect(result).toBe('character must be a positive number.'); + }); + + it('rejects non-positive limit', () => { + const result = tool.validateToolParams({ + operation: 'documentSymbol', + filePath: 'src/app.ts', + limit: 0, + } as LspToolParams); + expect(result).toBe('limit must be a positive number.'); + }); + }); + + describe('edge case validation', () => { + it('rejects empty filePath', () => { + const result = tool.validateToolParams({ + operation: 'goToDefinition', + filePath: '', + line: 1, + } as LspToolParams); + expect(result).toBe('filePath is required for goToDefinition.'); + }); + + it('rejects whitespace-only filePath', () => { + const result = tool.validateToolParams({ + operation: 'goToDefinition', + filePath: ' ', + line: 1, + } as LspToolParams); + expect(result).toBe('filePath is required for goToDefinition.'); + }); + + it('rejects whitespace-only query', () => { + const result = tool.validateToolParams({ + operation: 'workspaceSymbol', + query: ' \t\n ', + } as LspToolParams); + expect(result).toBe('query is required for workspaceSymbol.'); + }); + }); + }); + + describe('execute', () => { + describe('LSP disabled or unavailable', () => { + it('returns unavailable message when LSP is disabled', async () => { + const tool = createTool(undefined, false); + const invocation = tool.build({ + operation: 'hover', + filePath: 'src/app.ts', + line: 1, + character: 1, + }); + const result = await invocation.execute(abortSignal); + expect(result.llmContent).toContain('LSP hover is unavailable'); + expect(result.llmContent).toContain('LSP disabled or not initialized'); + }); + + it('returns unavailable message when no LSP client', async () => { + const tool = createTool(undefined, true); + const invocation = tool.build({ + operation: 'goToDefinition', + filePath: 'src/app.ts', + line: 1, + character: 1, + }); + const result = await invocation.execute(abortSignal); + // Note: operation labels are formatted (e.g., "go-to-definition") + expect(result.llmContent).toContain( + 'LSP go-to-definition is unavailable', + ); + }); + }); + + describe('goToDefinition operation', () => { + it('dispatches to definitions and formats results', async () => { + const client = createMockClient(); + const tool = createTool(client); + const filePath = resolvePath('src', 'app.ts'); + const definition: LspDefinition = { + ...createLocation(filePath, 10, 5), + serverName: 'tsserver', + }; + (client.definitions as Mock).mockResolvedValue([definition]); + + const invocation = tool.build({ + operation: 'goToDefinition', + filePath: 'src/app.ts', + line: 5, + character: 10, + }); + const result = await invocation.execute(abortSignal); + + expect(client.definitions).toHaveBeenCalledWith( + expect.objectContaining({ + uri: toUri(filePath), + range: expect.objectContaining({ + start: { line: 4, character: 9 }, // 1-based to 0-based conversion + }), + }), + undefined, + 20, + ); + expect(result.llmContent).toContain('Definitions for'); + expect(result.llmContent).toContain('1.'); + }); + + it('handles empty results', async () => { + const client = createMockClient(); + const tool = createTool(client); + (client.definitions as Mock).mockResolvedValue([]); + + const invocation = tool.build({ + operation: 'goToDefinition', + filePath: 'src/app.ts', + line: 5, + character: 10, + }); + const result = await invocation.execute(abortSignal); + + expect(result.llmContent).toContain('No definitions found'); + }); + }); + + describe('findReferences operation', () => { + it('dispatches to references and formats results', async () => { + const client = createMockClient(); + const tool = createTool(client); + const filePath = resolvePath('src', 'app.ts'); + const refs: LspReference[] = [ + { ...createLocation(filePath, 10, 5), serverName: 'tsserver' }, + { ...createLocation(filePath, 20, 8) }, + ]; + (client.references as Mock).mockResolvedValue(refs); + + const invocation = tool.build({ + operation: 'findReferences', + filePath: 'src/app.ts', + line: 5, + character: 10, + includeDeclaration: true, + }); + const result = await invocation.execute(abortSignal); + + // Default limit for references is 50 + expect(client.references).toHaveBeenCalledWith( + expect.objectContaining({ uri: toUri(filePath) }), + undefined, + true, + 50, + ); + expect(result.llmContent).toContain('References for'); + expect(result.llmContent).toContain('1.'); + expect(result.llmContent).toContain('2.'); + }); + }); + + describe('hover operation', () => { + it('dispatches to hover and formats results', async () => { + const client = createMockClient(); + const tool = createTool(client); + const hoverResult: LspHoverResult = { + contents: '**Type**: string\n\nA sample variable.', + }; + (client.hover as Mock).mockResolvedValue(hoverResult); + + const invocation = tool.build({ + operation: 'hover', + filePath: 'src/app.ts', + line: 10, + character: 5, + }); + const result = await invocation.execute(abortSignal); + + expect(client.hover).toHaveBeenCalled(); + expect(result.llmContent).toContain('Hover for'); + expect(result.llmContent).toContain('Type'); + }); + + it('handles null hover result', async () => { + const client = createMockClient(); + const tool = createTool(client); + (client.hover as Mock).mockResolvedValue(null); + + const invocation = tool.build({ + operation: 'hover', + filePath: 'src/app.ts', + line: 10, + character: 5, + }); + const result = await invocation.execute(abortSignal); + + expect(result.llmContent).toContain('No hover information found'); + }); + }); + + describe('documentSymbol operation', () => { + it('dispatches to documentSymbols and formats results', async () => { + const client = createMockClient(); + const tool = createTool(client); + const filePath = resolvePath('src', 'app.ts'); + const symbols: LspSymbolInformation[] = [ + { + name: 'MyClass', + kind: 'Class', + containerName: 'app', + location: createLocation(filePath, 5, 0), + serverName: 'tsserver', + }, + { + name: 'myFunction', + kind: 'Function', + location: createLocation(filePath, 20, 0), + }, + ]; + (client.documentSymbols as Mock).mockResolvedValue(symbols); + + const invocation = tool.build({ + operation: 'documentSymbol', + filePath: 'src/app.ts', + }); + const result = await invocation.execute(abortSignal); + + // Default limit for documentSymbols is 50 + expect(client.documentSymbols).toHaveBeenCalledWith( + toUri(filePath), + undefined, + 50, + ); + expect(result.llmContent).toContain('Document symbols for'); + expect(result.llmContent).toContain('MyClass'); + expect(result.llmContent).toContain('myFunction'); + }); + }); + + describe('workspaceSymbol operation', () => { + it('dispatches to workspaceSymbols and formats results', async () => { + const client = createMockClient(); + const tool = createTool(client); + const filePath = resolvePath('src', 'app.ts'); + const symbols: LspSymbolInformation[] = [ + { + name: 'Widget', + kind: 'Class', + location: createLocation(filePath, 10, 0), + }, + ]; + (client.workspaceSymbols as Mock).mockResolvedValue(symbols); + (client.references as Mock).mockResolvedValue([]); + + const invocation = tool.build({ + operation: 'workspaceSymbol', + query: 'Widget', + limit: 10, + }); + const result = await invocation.execute(abortSignal); + + expect(client.workspaceSymbols).toHaveBeenCalledWith('Widget', 10); + expect(result.llmContent).toContain('symbols for query "Widget"'); + expect(result.llmContent).toContain('Widget'); + }); + }); + + describe('goToImplementation operation', () => { + it('dispatches to implementations and formats results', async () => { + const client = createMockClient(); + const tool = createTool(client); + const filePath = resolvePath('src', 'impl.ts'); + const impl: LspDefinition = { + ...createLocation(filePath, 15, 2), + serverName: 'tsserver', + }; + (client.implementations as Mock).mockResolvedValue([impl]); + + const invocation = tool.build({ + operation: 'goToImplementation', + filePath: 'src/interface.ts', + line: 5, + character: 10, + }); + const result = await invocation.execute(abortSignal); + + expect(client.implementations).toHaveBeenCalled(); + expect(result.llmContent).toContain('Implementations for'); + }); + }); + + describe('prepareCallHierarchy operation', () => { + it('dispatches to prepareCallHierarchy and formats results with JSON', async () => { + const client = createMockClient(); + const tool = createTool(client); + const filePath = resolvePath('src', 'app.ts'); + const item: LspCallHierarchyItem = { + name: 'myFunction', + kind: 'Function', + detail: '(param: string)', + uri: toUri(filePath), + range: { + start: { line: 10, character: 0 }, + end: { line: 20, character: 1 }, + }, + selectionRange: { + start: { line: 10, character: 9 }, + end: { line: 10, character: 19 }, + }, + serverName: 'tsserver', + }; + (client.prepareCallHierarchy as Mock).mockResolvedValue([item]); + + const invocation = tool.build({ + operation: 'prepareCallHierarchy', + filePath: 'src/app.ts', + line: 11, + character: 15, + }); + const result = await invocation.execute(abortSignal); + + expect(client.prepareCallHierarchy).toHaveBeenCalled(); + expect(result.llmContent).toContain('Call hierarchy items for'); + expect(result.llmContent).toContain('myFunction'); + expect(result.llmContent).toContain('Call hierarchy items (JSON):'); + expect(result.llmContent).toContain('"name": "myFunction"'); + }); + }); + + describe('incomingCalls operation', () => { + it('dispatches to incomingCalls and formats results', async () => { + const client = createMockClient(); + const tool = createTool(client); + const targetPath = resolvePath('src', 'target.ts'); + const callerPath = resolvePath('src', 'caller.ts'); + + const targetItem: LspCallHierarchyItem = { + name: 'targetFunc', + uri: toUri(targetPath), + range: { + start: { line: 5, character: 0 }, + end: { line: 10, character: 1 }, + }, + selectionRange: { + start: { line: 5, character: 9 }, + end: { line: 5, character: 19 }, + }, + serverName: 'tsserver', + }; + + const callerItem: LspCallHierarchyItem = { + name: 'callerFunc', + kind: 'Function', + uri: toUri(callerPath), + range: { + start: { line: 20, character: 0 }, + end: { line: 30, character: 1 }, + }, + selectionRange: { + start: { line: 20, character: 9 }, + end: { line: 20, character: 19 }, + }, + }; + + const incomingCall: LspCallHierarchyIncomingCall = { + from: callerItem, + fromRanges: [ + { + start: { line: 25, character: 4 }, + end: { line: 25, character: 14 }, + }, + ], + }; + (client.incomingCalls as Mock).mockResolvedValue([incomingCall]); + + const invocation = tool.build({ + operation: 'incomingCalls', + callHierarchyItem: targetItem, + }); + const result = await invocation.execute(abortSignal); + + expect(client.incomingCalls).toHaveBeenCalledWith( + targetItem, + 'tsserver', + 20, + ); + expect(result.llmContent).toContain('Incoming calls for targetFunc'); + expect(result.llmContent).toContain('callerFunc'); + expect(result.llmContent).toContain('Incoming calls (JSON):'); + }); + }); + + describe('outgoingCalls operation', () => { + it('dispatches to outgoingCalls and formats results', async () => { + const client = createMockClient(); + const tool = createTool(client); + const sourcePath = resolvePath('src', 'source.ts'); + const targetPath = resolvePath('src', 'target.ts'); + + const sourceItem: LspCallHierarchyItem = { + name: 'sourceFunc', + uri: toUri(sourcePath), + range: { + start: { line: 5, character: 0 }, + end: { line: 15, character: 1 }, + }, + selectionRange: { + start: { line: 5, character: 9 }, + end: { line: 5, character: 19 }, + }, + }; + + const targetItem: LspCallHierarchyItem = { + name: 'targetFunc', + kind: 'Function', + uri: toUri(targetPath), + range: { + start: { line: 20, character: 0 }, + end: { line: 30, character: 1 }, + }, + selectionRange: { + start: { line: 20, character: 9 }, + end: { line: 20, character: 19 }, + }, + serverName: 'tsserver', + }; + + const outgoingCall: LspCallHierarchyOutgoingCall = { + to: targetItem, + fromRanges: [ + { + start: { line: 10, character: 4 }, + end: { line: 10, character: 14 }, + }, + ], + }; + (client.outgoingCalls as Mock).mockResolvedValue([outgoingCall]); + + const invocation = tool.build({ + operation: 'outgoingCalls', + callHierarchyItem: sourceItem, + }); + const result = await invocation.execute(abortSignal); + + expect(client.outgoingCalls).toHaveBeenCalled(); + expect(result.llmContent).toContain('Outgoing calls for sourceFunc'); + expect(result.llmContent).toContain('targetFunc'); + expect(result.llmContent).toContain('Outgoing calls (JSON):'); + }); + }); + + describe('error handling', () => { + it('handles LSP client errors gracefully', async () => { + const client = createMockClient(); + const tool = createTool(client); + (client.definitions as Mock).mockRejectedValue( + new Error('Connection refused'), + ); + + const invocation = tool.build({ + operation: 'goToDefinition', + filePath: 'src/app.ts', + line: 5, + character: 10, + }); + const result = await invocation.execute(abortSignal); + + expect(result.llmContent).toContain('failed'); + expect(result.llmContent).toContain('Connection refused'); + }); + + it('handles hover operation errors', async () => { + const client = createMockClient(); + const tool = createTool(client); + (client.hover as Mock).mockRejectedValue(new Error('Server timeout')); + + const invocation = tool.build({ + operation: 'hover', + filePath: 'src/app.ts', + line: 5, + character: 10, + }); + const result = await invocation.execute(abortSignal); + + expect(result.llmContent).toContain('failed'); + expect(result.llmContent).toContain('Server timeout'); + }); + + it('handles call hierarchy errors', async () => { + const client = createMockClient(); + const tool = createTool(client); + (client.prepareCallHierarchy as Mock).mockRejectedValue( + new Error('Not supported'), + ); + + const invocation = tool.build({ + operation: 'prepareCallHierarchy', + filePath: 'src/app.ts', + line: 5, + character: 10, + }); + const result = await invocation.execute(abortSignal); + + expect(result.llmContent).toContain('failed'); + expect(result.llmContent).toContain('Not supported'); + }); + }); + + describe('workspaceSymbol with references', () => { + it('fetches references for top match when available', async () => { + const client = createMockClient(); + const tool = createTool(client); + const filePath = resolvePath('src', 'app.ts'); + const refPath = resolvePath('src', 'other.ts'); + const symbols: LspSymbolInformation[] = [ + { + name: 'TopWidget', + kind: 'Class', + location: createLocation(filePath, 10, 0), + serverName: 'tsserver', + }, + ]; + const references: LspReference[] = [ + { ...createLocation(refPath, 5, 10), serverName: 'tsserver' }, + { ...createLocation(refPath, 20, 5) }, + ]; + (client.workspaceSymbols as Mock).mockResolvedValue(symbols); + (client.references as Mock).mockResolvedValue(references); + + const invocation = tool.build({ + operation: 'workspaceSymbol', + query: 'TopWidget', + }); + const result = await invocation.execute(abortSignal); + + // Should fetch references for top match + expect(client.references).toHaveBeenCalledWith( + symbols[0].location, + 'tsserver', + false, + expect.any(Number), + ); + expect(result.llmContent).toContain('References for top match'); + expect(result.llmContent).toContain('TopWidget'); + }); + + it('handles reference lookup failure gracefully', async () => { + const client = createMockClient(); + const tool = createTool(client); + const filePath = resolvePath('src', 'app.ts'); + const symbols: LspSymbolInformation[] = [ + { + name: 'Widget', + kind: 'Class', + location: createLocation(filePath, 10, 0), + }, + ]; + (client.workspaceSymbols as Mock).mockResolvedValue(symbols); + (client.references as Mock).mockRejectedValue( + new Error('References not supported'), + ); + + const invocation = tool.build({ + operation: 'workspaceSymbol', + query: 'Widget', + }); + const result = await invocation.execute(abortSignal); + + // Should still return symbols even if references fail + expect(result.llmContent).toContain('Widget'); + expect(result.llmContent).toContain('References lookup failed'); + }); + }); + + describe('returnDisplay verification', () => { + it('returns formatted display for definitions', async () => { + const client = createMockClient(); + const tool = createTool(client); + const filePath = resolvePath('src', 'app.ts'); + const definition: LspDefinition = { + ...createLocation(filePath, 10, 5), + serverName: 'tsserver', + }; + (client.definitions as Mock).mockResolvedValue([definition]); + + const invocation = tool.build({ + operation: 'goToDefinition', + filePath: 'src/app.ts', + line: 5, + character: 10, + }); + const result = await invocation.execute(abortSignal); + + // returnDisplay should be concise (without heading) + expect(result.returnDisplay).toBeDefined(); + expect(result.returnDisplay).toContain('1.'); + expect(result.returnDisplay).toContain('[tsserver]'); + }); + + it('returns formatted display for hover with trimmed content', async () => { + const client = createMockClient(); + const tool = createTool(client); + const hoverResult: LspHoverResult = { + contents: ' \n Type: string \n ', + }; + (client.hover as Mock).mockResolvedValue(hoverResult); + + const invocation = tool.build({ + operation: 'hover', + filePath: 'src/app.ts', + line: 10, + character: 5, + }); + const result = await invocation.execute(abortSignal); + + // returnDisplay should be trimmed + expect(result.returnDisplay).toBe('Type: string'); + }); + }); + + describe('serverName and limit parameter passing', () => { + it('passes serverName to client methods', async () => { + const client = createMockClient(); + const tool = createTool(client); + (client.definitions as Mock).mockResolvedValue([]); + + const invocation = tool.build({ + operation: 'goToDefinition', + filePath: 'src/app.ts', + line: 5, + character: 10, + serverName: 'pylsp', + }); + await invocation.execute(abortSignal); + + expect(client.definitions).toHaveBeenCalledWith( + expect.anything(), + 'pylsp', + expect.any(Number), + ); + }); + + it('passes custom limit to client methods', async () => { + const client = createMockClient(); + const tool = createTool(client); + (client.definitions as Mock).mockResolvedValue([]); + + const invocation = tool.build({ + operation: 'goToDefinition', + filePath: 'src/app.ts', + line: 5, + character: 10, + limit: 5, + }); + await invocation.execute(abortSignal); + + expect(client.definitions).toHaveBeenCalledWith( + expect.anything(), + undefined, + 5, + ); + }); + }); + }); + + describe('schema compatibility with Claude Code', () => { + /** + * Claude Code LSP tool schema reference: + * { + * "name": "lsp", + * "input_schema": { + * "type": "object", + * "properties": { + * "operation": { "type": "string", "enum": [...] }, + * "filePath": { "type": "string" }, + * "line": { "type": "number" }, + * "character": { "type": "number" }, + * "includeDeclaration": { "type": "boolean" }, + * "query": { "type": "string" }, + * "callHierarchyItem": { ... } + * }, + * "required": ["operation"] + * } + * } + */ + + it('has correct tool name', () => { + const tool = createTool(); + expect(tool.schema.name).toBe('lsp'); + }); + + it('has operation as only required field', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + required?: string[]; + }; + expect(schema.required).toEqual(['operation']); + }); + + it('operation enum matches Claude Code exactly', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + properties?: { + operation?: { + enum?: string[]; + }; + }; + }; + const expectedOperations = [ + 'goToDefinition', + 'findReferences', + 'hover', + 'documentSymbol', + 'workspaceSymbol', + 'goToImplementation', + 'prepareCallHierarchy', + 'incomingCalls', + 'outgoingCalls', + 'diagnostics', + 'workspaceDiagnostics', + 'codeActions', + ]; + expect(schema.properties?.operation?.enum).toEqual(expectedOperations); + }); + + it('has all Claude Code core properties', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + properties?: Record; + }; + const properties = Object.keys(schema.properties ?? {}); + + // Core properties that must match Claude Code + const coreProperties = [ + 'operation', + 'filePath', + 'line', + 'character', + 'includeDeclaration', + 'query', + 'callHierarchyItem', + ]; + + for (const prop of coreProperties) { + expect(properties).toContain(prop); + } + }); + + it('extension properties are documented', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + properties?: Record; + }; + const properties = Object.keys(schema.properties ?? {}); + + // Our extensions beyond Claude Code + const extensionProperties = [ + 'serverName', + 'limit', + 'endLine', + 'endCharacter', + 'diagnostics', + 'codeActionKinds', + ]; + + // All properties should be either core or documented extensions + const knownProperties = [ + 'operation', + 'filePath', + 'line', + 'character', + 'includeDeclaration', + 'query', + 'callHierarchyItem', + ...extensionProperties, + ]; + + for (const prop of properties) { + expect(knownProperties).toContain(prop); + } + }); + + it('filePath property has correct type', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + properties?: { + filePath?: { type?: string }; + }; + }; + expect(schema.properties?.filePath?.type).toBe('string'); + }); + + it('line and character properties have correct type', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + properties?: { + line?: { type?: string }; + character?: { type?: string }; + }; + }; + expect(schema.properties?.line?.type).toBe('number'); + expect(schema.properties?.character?.type).toBe('number'); + }); + + it('includeDeclaration property has correct type', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + properties?: { + includeDeclaration?: { type?: string }; + }; + }; + expect(schema.properties?.includeDeclaration?.type).toBe('boolean'); + }); + + it('callHierarchyItem has required structure', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + definitions?: { + LspCallHierarchyItem?: { + type?: string; + properties?: Record; + required?: string[]; + }; + }; + }; + const itemDef = schema.definitions?.LspCallHierarchyItem; + expect(itemDef?.type).toBe('object'); + expect(itemDef?.required).toEqual([ + 'name', + 'uri', + 'range', + 'selectionRange', + ]); + expect(itemDef?.properties).toHaveProperty('name'); + expect(itemDef?.properties).toHaveProperty('kind'); + expect(itemDef?.properties).toHaveProperty('uri'); + expect(itemDef?.properties).toHaveProperty('range'); + expect(itemDef?.properties).toHaveProperty('selectionRange'); + }); + + it('supports rawKind for SymbolKind numeric preservation', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + definitions?: { + LspCallHierarchyItem?: { + properties?: { + rawKind?: { type?: string }; + }; + }; + }; + }; + const itemDef = schema.definitions?.LspCallHierarchyItem; + expect(itemDef?.properties?.rawKind?.type).toBe('number'); + }); + + describe('schema definitions deep validation', () => { + it('has LspPosition definition with correct structure', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + definitions?: { + LspPosition?: { + type?: string; + properties?: { + line?: { type?: string }; + character?: { type?: string }; + }; + required?: string[]; + }; + }; + }; + const posDef = schema.definitions?.LspPosition; + expect(posDef).toBeDefined(); + expect(posDef?.type).toBe('object'); + expect(posDef?.properties?.line?.type).toBe('number'); + expect(posDef?.properties?.character?.type).toBe('number'); + expect(posDef?.required).toEqual(['line', 'character']); + }); + + it('has LspRange definition with correct structure', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + definitions?: { + LspRange?: { + type?: string; + properties?: { + start?: { $ref?: string }; + end?: { $ref?: string }; + }; + required?: string[]; + }; + }; + }; + const rangeDef = schema.definitions?.LspRange; + expect(rangeDef).toBeDefined(); + expect(rangeDef?.type).toBe('object'); + expect(rangeDef?.properties?.start?.$ref).toBe( + '#/definitions/LspPosition', + ); + expect(rangeDef?.properties?.end?.$ref).toBe( + '#/definitions/LspPosition', + ); + expect(rangeDef?.required).toEqual(['start', 'end']); + }); + + it('callHierarchyItem uses $ref for range fields', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + properties?: { + callHierarchyItem?: { $ref?: string }; + }; + definitions?: { + LspCallHierarchyItem?: { + properties?: { + range?: { $ref?: string }; + selectionRange?: { $ref?: string }; + }; + }; + }; + }; + // callHierarchyItem property should reference the definition + expect(schema.properties?.callHierarchyItem?.$ref).toBe( + '#/definitions/LspCallHierarchyItem', + ); + // range and selectionRange should use LspRange $ref + const itemDef = schema.definitions?.LspCallHierarchyItem; + expect(itemDef?.properties?.range?.$ref).toBe('#/definitions/LspRange'); + expect(itemDef?.properties?.selectionRange?.$ref).toBe( + '#/definitions/LspRange', + ); + }); + + it('all definitions are present and accounted for', () => { + const tool = createTool(); + const schema = tool.schema.parametersJsonSchema as { + definitions?: Record; + }; + const definitionNames = Object.keys(schema.definitions ?? {}); + // Should include at least these definitions + expect(definitionNames).toEqual( + expect.arrayContaining([ + 'LspCallHierarchyItem', + 'LspDiagnostic', + 'LspPosition', + 'LspRange', + ]), + ); + }); + }); + }); + + describe('invocation description', () => { + it('describes goToDefinition correctly', () => { + const tool = createTool(); + const invocation = tool.build({ + operation: 'goToDefinition', + filePath: 'src/app.ts', + line: 10, + character: 5, + }); + // Uses formatted label "go-to-definition" + expect(invocation.getDescription()).toContain('go-to-definition'); + expect(invocation.getDescription()).toContain('src/app.ts:10:5'); + }); + + it('describes workspaceSymbol correctly', () => { + const tool = createTool(); + const invocation = tool.build({ + operation: 'workspaceSymbol', + query: 'Widget', + }); + // Uses formatted label "workspace symbol search" + expect(invocation.getDescription()).toContain('workspace symbol search'); + expect(invocation.getDescription()).toContain('Widget'); + }); + + it('describes incomingCalls correctly', () => { + const tool = createTool(); + const invocation = tool.build({ + operation: 'incomingCalls', + callHierarchyItem: { + name: 'testFunc', + uri: 'file:///test.ts', + range: { + start: { line: 0, character: 0 }, + end: { line: 0, character: 10 }, + }, + selectionRange: { + start: { line: 0, character: 0 }, + end: { line: 0, character: 10 }, + }, + }, + }); + // Uses formatted label "incoming calls" + expect(invocation.getDescription()).toContain('incoming calls'); + expect(invocation.getDescription()).toContain('testFunc'); + }); + }); +}); diff --git a/packages/core/src/tools/lsp.ts b/packages/core/src/tools/lsp.ts new file mode 100644 index 000000000..27711a080 --- /dev/null +++ b/packages/core/src/tools/lsp.ts @@ -0,0 +1,1218 @@ +/** + * @license + * Copyright 2025 Qwen Team + * SPDX-License-Identifier: Apache-2.0 + */ + +import path from 'node:path'; +import { fileURLToPath, pathToFileURL } from 'node:url'; +import type { ToolInvocation, ToolResult } from './tools.js'; +import { BaseDeclarativeTool, BaseToolInvocation, Kind } from './tools.js'; +import { ToolDisplayNames, ToolNames } from './tool-names.js'; +import type { Config } from '../config/config.js'; +import type { + LspCallHierarchyIncomingCall, + LspCallHierarchyItem, + LspCallHierarchyOutgoingCall, + LspClient, + LspCodeAction, + LspCodeActionContext, + LspCodeActionKind, + LspDefinition, + LspDiagnostic, + LspFileDiagnostics, + LspLocation, + LspRange, + LspReference, + LspSymbolInformation, +} from '../lsp/types.js'; + +/** + * Supported LSP operations. + */ +export type LspOperation = + | 'goToDefinition' + | 'findReferences' + | 'hover' + | 'documentSymbol' + | 'workspaceSymbol' + | 'goToImplementation' + | 'prepareCallHierarchy' + | 'incomingCalls' + | 'outgoingCalls' + | 'diagnostics' + | 'workspaceDiagnostics' + | 'codeActions'; + +/** + * Parameters for the unified LSP tool. + */ +export interface LspToolParams { + /** Operation to perform. */ + operation: LspOperation; + /** File path (absolute or workspace-relative). */ + filePath?: string; + /** 1-based line number when targeting a specific file location. */ + line?: number; + /** 1-based character/column number when targeting a specific file location. */ + character?: number; + /** End line for range-based operations (1-based). */ + endLine?: number; + /** End character for range-based operations (1-based). */ + endCharacter?: number; + /** Whether to include the declaration in reference results. */ + includeDeclaration?: boolean; + /** Query string for workspace symbol search. */ + query?: string; + /** Call hierarchy item from a previous call hierarchy operation. */ + callHierarchyItem?: LspCallHierarchyItem; + /** Optional server name override. */ + serverName?: string; + /** Optional maximum number of results. */ + limit?: number; + /** Diagnostics for code action context. */ + diagnostics?: LspDiagnostic[]; + /** Code action kinds to filter by. */ + codeActionKinds?: LspCodeActionKind[]; +} + +type ResolvedTarget = + | { + location: LspLocation; + description: string; + } + | { error: string }; + +/** Operations that require filePath and line. */ +const LOCATION_REQUIRED_OPERATIONS = new Set([ + 'goToDefinition', + 'findReferences', + 'hover', + 'goToImplementation', + 'prepareCallHierarchy', +]); + +/** Operations that only require filePath. */ +const FILE_REQUIRED_OPERATIONS = new Set([ + 'documentSymbol', + 'diagnostics', +]); + +/** Operations that require query. */ +const QUERY_REQUIRED_OPERATIONS = new Set(['workspaceSymbol']); + +/** Operations that require callHierarchyItem. */ +const ITEM_REQUIRED_OPERATIONS = new Set([ + 'incomingCalls', + 'outgoingCalls', +]); + +/** Operations that require filePath and range for code actions. */ +const RANGE_REQUIRED_OPERATIONS = new Set(['codeActions']); + +class LspToolInvocation extends BaseToolInvocation { + constructor( + private readonly config: Config, + params: LspToolParams, + ) { + super(params); + } + + getDescription(): string { + const operationLabel = this.getOperationLabel(); + if (this.params.operation === 'workspaceSymbol') { + return `LSP ${operationLabel} for "${this.params.query ?? ''}"`; + } + if (this.params.operation === 'documentSymbol') { + return this.params.filePath + ? `LSP ${operationLabel} for ${this.params.filePath}` + : `LSP ${operationLabel}`; + } + if ( + this.params.operation === 'incomingCalls' || + this.params.operation === 'outgoingCalls' + ) { + return `LSP ${operationLabel} for ${this.describeCallHierarchyItemShort()}`; + } + if (this.params.filePath && this.params.line !== undefined) { + return `LSP ${operationLabel} at ${this.params.filePath}:${this.params.line}:${this.params.character ?? 1}`; + } + if (this.params.filePath) { + return `LSP ${operationLabel} for ${this.params.filePath}`; + } + return `LSP ${operationLabel}`; + } + + async execute(_signal: AbortSignal): Promise { + const client = this.config.getLspClient(); + if (!client || !this.config.isLspEnabled()) { + const message = `LSP ${this.getOperationLabel()} is unavailable (LSP disabled or not initialized).`; + return { llmContent: message, returnDisplay: message }; + } + + switch (this.params.operation) { + case 'goToDefinition': + return this.executeDefinitions(client); + case 'findReferences': + return this.executeReferences(client); + case 'hover': + return this.executeHover(client); + case 'documentSymbol': + return this.executeDocumentSymbols(client); + case 'workspaceSymbol': + return this.executeWorkspaceSymbols(client); + case 'goToImplementation': + return this.executeImplementations(client); + case 'prepareCallHierarchy': + return this.executePrepareCallHierarchy(client); + case 'incomingCalls': + return this.executeIncomingCalls(client); + case 'outgoingCalls': + return this.executeOutgoingCalls(client); + case 'diagnostics': + return this.executeDiagnostics(client); + case 'workspaceDiagnostics': + return this.executeWorkspaceDiagnostics(client); + case 'codeActions': + return this.executeCodeActions(client); + default: { + const message = `Unsupported LSP operation: ${this.params.operation}`; + return { llmContent: message, returnDisplay: message }; + } + } + } + + private async executeDefinitions(client: LspClient): Promise { + const target = this.resolveLocationTarget(); + if ('error' in target) { + return { llmContent: target.error, returnDisplay: target.error }; + } + + const limit = this.params.limit ?? 20; + let definitions: LspDefinition[] = []; + try { + definitions = await client.definitions( + target.location, + this.params.serverName, + limit, + ); + } catch (error) { + const message = `LSP go-to-definition failed: ${ + (error as Error)?.message || String(error) + }`; + return { llmContent: message, returnDisplay: message }; + } + + if (!definitions.length) { + const message = `No definitions found for ${target.description}.`; + return { llmContent: message, returnDisplay: message }; + } + + const workspaceRoot = this.config.getProjectRoot(); + const lines = definitions + .slice(0, limit) + .map( + (definition, index) => + `${index + 1}. ${this.formatLocationWithServer(definition, workspaceRoot)}`, + ); + + const heading = `Definitions for ${target.description}:`; + return { + llmContent: [heading, ...lines].join('\n'), + returnDisplay: lines.join('\n'), + }; + } + + private async executeImplementations(client: LspClient): Promise { + const target = this.resolveLocationTarget(); + if ('error' in target) { + return { llmContent: target.error, returnDisplay: target.error }; + } + + const limit = this.params.limit ?? 20; + let implementations: LspDefinition[] = []; + try { + implementations = await client.implementations( + target.location, + this.params.serverName, + limit, + ); + } catch (error) { + const message = `LSP go-to-implementation failed: ${ + (error as Error)?.message || String(error) + }`; + return { llmContent: message, returnDisplay: message }; + } + + if (!implementations.length) { + const message = `No implementations found for ${target.description}.`; + return { llmContent: message, returnDisplay: message }; + } + + const workspaceRoot = this.config.getProjectRoot(); + const lines = implementations + .slice(0, limit) + .map( + (implementation, index) => + `${index + 1}. ${this.formatLocationWithServer(implementation, workspaceRoot)}`, + ); + + const heading = `Implementations for ${target.description}:`; + return { + llmContent: [heading, ...lines].join('\n'), + returnDisplay: lines.join('\n'), + }; + } + + private async executeReferences(client: LspClient): Promise { + const target = this.resolveLocationTarget(); + if ('error' in target) { + return { llmContent: target.error, returnDisplay: target.error }; + } + + const limit = this.params.limit ?? 50; + let references: LspReference[] = []; + try { + references = await client.references( + target.location, + this.params.serverName, + this.params.includeDeclaration ?? false, + limit, + ); + } catch (error) { + const message = `LSP find-references failed: ${ + (error as Error)?.message || String(error) + }`; + return { llmContent: message, returnDisplay: message }; + } + + if (!references.length) { + const message = `No references found for ${target.description}.`; + return { llmContent: message, returnDisplay: message }; + } + + const workspaceRoot = this.config.getProjectRoot(); + const lines = references + .slice(0, limit) + .map( + (reference, index) => + `${index + 1}. ${this.formatLocationWithServer(reference, workspaceRoot)}`, + ); + + const heading = `References for ${target.description}:`; + return { + llmContent: [heading, ...lines].join('\n'), + returnDisplay: lines.join('\n'), + }; + } + + private async executeHover(client: LspClient): Promise { + const target = this.resolveLocationTarget(); + if ('error' in target) { + return { llmContent: target.error, returnDisplay: target.error }; + } + + let hoverText = ''; + try { + const result = await client.hover( + target.location, + this.params.serverName, + ); + if (result) { + hoverText = result.contents ?? ''; + } + } catch (error) { + const message = `LSP hover failed: ${ + (error as Error)?.message || String(error) + }`; + return { llmContent: message, returnDisplay: message }; + } + + if (!hoverText || hoverText.trim().length === 0) { + const message = `No hover information found for ${target.description}.`; + return { llmContent: message, returnDisplay: message }; + } + + const heading = `Hover for ${target.description}:`; + const content = hoverText.trim(); + return { + llmContent: `${heading}\n${content}`, + returnDisplay: content, + }; + } + + private async executeDocumentSymbols(client: LspClient): Promise { + const workspaceRoot = this.config.getProjectRoot(); + const filePath = this.params.filePath ?? ''; + const uri = this.resolveUri(filePath, workspaceRoot); + if (!uri) { + const message = 'A valid filePath is required for document symbols.'; + return { llmContent: message, returnDisplay: message }; + } + + const limit = this.params.limit ?? 50; + let symbols: LspSymbolInformation[] = []; + try { + symbols = await client.documentSymbols( + uri, + this.params.serverName, + limit, + ); + } catch (error) { + const message = `LSP document symbols failed: ${ + (error as Error)?.message || String(error) + }`; + return { llmContent: message, returnDisplay: message }; + } + + if (!symbols.length) { + const fileLabel = this.formatUriForDisplay(uri, workspaceRoot); + const message = `No document symbols found for ${fileLabel}.`; + return { llmContent: message, returnDisplay: message }; + } + + const lines = symbols.slice(0, limit).map((symbol, index) => { + const location = this.formatLocationWithoutServer( + symbol.location, + workspaceRoot, + ); + const serverSuffix = symbol.serverName ? ` [${symbol.serverName}]` : ''; + const kind = symbol.kind ? ` (${symbol.kind})` : ''; + const container = symbol.containerName + ? ` in ${symbol.containerName}` + : ''; + return `${index + 1}. ${symbol.name}${kind}${container} - ${location}${serverSuffix}`; + }); + + const fileLabel = this.formatUriForDisplay(uri, workspaceRoot); + const heading = `Document symbols for ${fileLabel}:`; + return { + llmContent: [heading, ...lines].join('\n'), + returnDisplay: lines.join('\n'), + }; + } + + private async executeWorkspaceSymbols( + client: LspClient, + ): Promise { + const limit = this.params.limit ?? 20; + const query = this.params.query ?? ''; + let symbols: LspSymbolInformation[] = []; + try { + symbols = await client.workspaceSymbols(query, limit); + } catch (error) { + const message = `LSP workspace symbol search failed: ${ + (error as Error)?.message || String(error) + }`; + return { llmContent: message, returnDisplay: message }; + } + + if (!symbols.length) { + const message = `No symbols found for query "${query}".`; + return { llmContent: message, returnDisplay: message }; + } + + const workspaceRoot = this.config.getProjectRoot(); + const lines = symbols.slice(0, limit).map((symbol, index) => { + const location = this.formatLocationWithoutServer( + symbol.location, + workspaceRoot, + ); + const serverSuffix = symbol.serverName ? ` [${symbol.serverName}]` : ''; + const kind = symbol.kind ? ` (${symbol.kind})` : ''; + const container = symbol.containerName + ? ` in ${symbol.containerName}` + : ''; + return `${index + 1}. ${symbol.name}${kind}${container} - ${location}${serverSuffix}`; + }); + + const heading = `Found ${Math.min(symbols.length, limit)} of ${ + symbols.length + } symbols for query "${query}":`; + + // Also fetch references for the top match to provide additional context. + let referenceSection = ''; + const topSymbol = symbols[0]; + if (topSymbol) { + try { + const referenceLimit = Math.min(20, Math.max(limit, 5)); + const references = await client.references( + topSymbol.location, + topSymbol.serverName, + false, + referenceLimit, + ); + if (references.length > 0) { + const refLines = references.map((ref, index) => { + const location = this.formatLocationWithoutServer( + ref, + workspaceRoot, + ); + const serverSuffix = ref.serverName ? ` [${ref.serverName}]` : ''; + return `${index + 1}. ${location}${serverSuffix}`; + }); + referenceSection = [ + '', + `References for top match (${topSymbol.name}):`, + ...refLines, + ].join('\n'); + } + } catch (error) { + referenceSection = `\nReferences lookup failed: ${ + (error as Error)?.message || String(error) + }`; + } + } + + const llmParts = referenceSection + ? [heading, ...lines, referenceSection] + : [heading, ...lines]; + const displayParts = referenceSection + ? [...lines, referenceSection] + : [...lines]; + + return { + llmContent: llmParts.join('\n'), + returnDisplay: displayParts.join('\n'), + }; + } + + private async executePrepareCallHierarchy( + client: LspClient, + ): Promise { + const target = this.resolveLocationTarget(); + if ('error' in target) { + return { llmContent: target.error, returnDisplay: target.error }; + } + + const limit = this.params.limit ?? 20; + let items: LspCallHierarchyItem[] = []; + try { + items = await client.prepareCallHierarchy( + target.location, + this.params.serverName, + limit, + ); + } catch (error) { + const message = `LSP call hierarchy prepare failed: ${ + (error as Error)?.message || String(error) + }`; + return { llmContent: message, returnDisplay: message }; + } + + if (!items.length) { + const message = `No call hierarchy items found for ${target.description}.`; + return { llmContent: message, returnDisplay: message }; + } + + const workspaceRoot = this.config.getProjectRoot(); + const slicedItems = items.slice(0, limit); + const lines = slicedItems.map((item, index) => + this.formatCallHierarchyItemLine(item, index, workspaceRoot), + ); + + const heading = `Call hierarchy items for ${target.description}:`; + const jsonSection = this.formatJsonSection( + 'Call hierarchy items (JSON)', + slicedItems, + ); + return { + llmContent: [heading, ...lines].join('\n') + jsonSection, + returnDisplay: lines.join('\n'), + }; + } + + private async executeIncomingCalls(client: LspClient): Promise { + const item = this.params.callHierarchyItem; + if (!item) { + const message = 'callHierarchyItem is required for incomingCalls.'; + return { llmContent: message, returnDisplay: message }; + } + + const limit = this.params.limit ?? 20; + const serverName = this.params.serverName ?? item.serverName; + let calls: LspCallHierarchyIncomingCall[] = []; + try { + calls = await client.incomingCalls(item, serverName, limit); + } catch (error) { + const message = `LSP incoming calls failed: ${ + (error as Error)?.message || String(error) + }`; + return { llmContent: message, returnDisplay: message }; + } + + if (!calls.length) { + const message = `No incoming calls found for ${this.describeCallHierarchyItemFull( + item, + )}.`; + return { llmContent: message, returnDisplay: message }; + } + + const workspaceRoot = this.config.getProjectRoot(); + const slicedCalls = calls.slice(0, limit); + const lines = slicedCalls.map((call, index) => { + const targetItem = call.from; + const location = this.formatLocationWithServer( + { + uri: targetItem.uri, + range: targetItem.selectionRange, + serverName: targetItem.serverName, + }, + workspaceRoot, + ); + const kind = targetItem.kind ? ` (${targetItem.kind})` : ''; + const detail = targetItem.detail ? ` ${targetItem.detail}` : ''; + const rangeSuffix = this.formatCallRanges(call.fromRanges); + return `${index + 1}. ${targetItem.name}${kind}${detail} - ${location}${rangeSuffix}`; + }); + + const heading = `Incoming calls for ${this.describeCallHierarchyItemFull( + item, + )}:`; + const jsonSection = this.formatJsonSection( + 'Incoming calls (JSON)', + slicedCalls, + ); + return { + llmContent: [heading, ...lines].join('\n') + jsonSection, + returnDisplay: lines.join('\n'), + }; + } + + private async executeOutgoingCalls(client: LspClient): Promise { + const item = this.params.callHierarchyItem; + if (!item) { + const message = 'callHierarchyItem is required for outgoingCalls.'; + return { llmContent: message, returnDisplay: message }; + } + + const limit = this.params.limit ?? 20; + const serverName = this.params.serverName ?? item.serverName; + let calls: LspCallHierarchyOutgoingCall[] = []; + try { + calls = await client.outgoingCalls(item, serverName, limit); + } catch (error) { + const message = `LSP outgoing calls failed: ${ + (error as Error)?.message || String(error) + }`; + return { llmContent: message, returnDisplay: message }; + } + + if (!calls.length) { + const message = `No outgoing calls found for ${this.describeCallHierarchyItemFull( + item, + )}.`; + return { llmContent: message, returnDisplay: message }; + } + + const workspaceRoot = this.config.getProjectRoot(); + const slicedCalls = calls.slice(0, limit); + const lines = slicedCalls.map((call, index) => { + const targetItem = call.to; + const location = this.formatLocationWithServer( + { + uri: targetItem.uri, + range: targetItem.selectionRange, + serverName: targetItem.serverName, + }, + workspaceRoot, + ); + const kind = targetItem.kind ? ` (${targetItem.kind})` : ''; + const detail = targetItem.detail ? ` ${targetItem.detail}` : ''; + const rangeSuffix = this.formatCallRanges(call.fromRanges); + return `${index + 1}. ${targetItem.name}${kind}${detail} - ${location}${rangeSuffix}`; + }); + + const heading = `Outgoing calls for ${this.describeCallHierarchyItemFull( + item, + )}:`; + const jsonSection = this.formatJsonSection( + 'Outgoing calls (JSON)', + slicedCalls, + ); + return { + llmContent: [heading, ...lines].join('\n') + jsonSection, + returnDisplay: lines.join('\n'), + }; + } + + private async executeDiagnostics(client: LspClient): Promise { + const workspaceRoot = this.config.getProjectRoot(); + const filePath = this.params.filePath ?? ''; + const uri = this.resolveUri(filePath, workspaceRoot); + if (!uri) { + const message = 'A valid filePath is required for diagnostics.'; + return { llmContent: message, returnDisplay: message }; + } + + let diagnostics: LspDiagnostic[] = []; + try { + diagnostics = await client.diagnostics(uri, this.params.serverName); + } catch (error) { + const message = `LSP diagnostics failed: ${ + (error as Error)?.message || String(error) + }`; + return { llmContent: message, returnDisplay: message }; + } + + if (!diagnostics.length) { + const fileLabel = this.formatUriForDisplay(uri, workspaceRoot); + const message = `No diagnostics found for ${fileLabel}.`; + return { llmContent: message, returnDisplay: message }; + } + + const lines = diagnostics.map((diag, index) => { + const severity = diag.severity ? `[${diag.severity.toUpperCase()}]` : ''; + const position = `${diag.range.start.line + 1}:${diag.range.start.character + 1}`; + const code = diag.code ? ` (${diag.code})` : ''; + const source = diag.source ? ` [${diag.source}]` : ''; + return `${index + 1}. ${severity} ${position}${code}${source}: ${diag.message}`; + }); + + const fileLabel = this.formatUriForDisplay(uri, workspaceRoot); + const heading = `Diagnostics for ${fileLabel} (${diagnostics.length} issues):`; + return { + llmContent: [heading, ...lines].join('\n'), + returnDisplay: lines.join('\n'), + }; + } + + private async executeWorkspaceDiagnostics( + client: LspClient, + ): Promise { + const limit = this.params.limit ?? 50; + let fileDiagnostics: LspFileDiagnostics[] = []; + try { + fileDiagnostics = await client.workspaceDiagnostics( + this.params.serverName, + limit, + ); + } catch (error) { + const message = `LSP workspace diagnostics failed: ${ + (error as Error)?.message || String(error) + }`; + return { llmContent: message, returnDisplay: message }; + } + + if (!fileDiagnostics.length) { + const message = 'No diagnostics found in the workspace.'; + return { llmContent: message, returnDisplay: message }; + } + + const workspaceRoot = this.config.getProjectRoot(); + const lines: string[] = []; + let totalIssues = 0; + + for (const fileDiag of fileDiagnostics) { + const fileLabel = this.formatUriForDisplay(fileDiag.uri, workspaceRoot); + const serverSuffix = fileDiag.serverName + ? ` [${fileDiag.serverName}]` + : ''; + lines.push(`\n${fileLabel}${serverSuffix}:`); + + for (const diag of fileDiag.diagnostics) { + const severity = diag.severity + ? `[${diag.severity.toUpperCase()}]` + : ''; + const position = `${diag.range.start.line + 1}:${diag.range.start.character + 1}`; + const code = diag.code ? ` (${diag.code})` : ''; + lines.push(` ${severity} ${position}${code}: ${diag.message}`); + totalIssues++; + } + } + + const heading = `Workspace diagnostics (${totalIssues} issues in ${fileDiagnostics.length} files):`; + return { + llmContent: [heading, ...lines].join('\n'), + returnDisplay: lines.join('\n'), + }; + } + + private async executeCodeActions(client: LspClient): Promise { + const workspaceRoot = this.config.getProjectRoot(); + const filePath = this.params.filePath ?? ''; + const uri = this.resolveUri(filePath, workspaceRoot); + if (!uri) { + const message = 'A valid filePath is required for code actions.'; + return { llmContent: message, returnDisplay: message }; + } + + // Build range from params + const startLine = Math.max(0, (this.params.line ?? 1) - 1); + const startChar = Math.max(0, (this.params.character ?? 1) - 1); + const endLine = Math.max( + 0, + (this.params.endLine ?? this.params.line ?? 1) - 1, + ); + const endChar = Math.max( + 0, + (this.params.endCharacter ?? this.params.character ?? 1) - 1, + ); + + const range: LspRange = { + start: { line: startLine, character: startChar }, + end: { line: endLine, character: endChar }, + }; + + // Build context + const context: LspCodeActionContext = { + diagnostics: this.params.diagnostics ?? [], + only: this.params.codeActionKinds, + triggerKind: 'invoked', + }; + + const limit = this.params.limit ?? 20; + let actions: LspCodeAction[] = []; + try { + actions = await client.codeActions( + uri, + range, + context, + this.params.serverName, + limit, + ); + } catch (error) { + const message = `LSP code actions failed: ${ + (error as Error)?.message || String(error) + }`; + return { llmContent: message, returnDisplay: message }; + } + + if (!actions.length) { + const fileLabel = this.formatUriForDisplay(uri, workspaceRoot); + const message = `No code actions available at ${fileLabel}:${startLine + 1}:${startChar + 1}.`; + return { llmContent: message, returnDisplay: message }; + } + + const lines = actions.slice(0, limit).map((action, index) => { + const kind = action.kind ? ` [${action.kind}]` : ''; + const preferred = action.isPreferred ? ' ★' : ''; + const hasEdit = action.edit ? ' (has edit)' : ''; + const hasCommand = action.command ? ' (has command)' : ''; + const serverSuffix = action.serverName ? ` [${action.serverName}]` : ''; + return `${index + 1}. ${action.title}${kind}${preferred}${hasEdit}${hasCommand}${serverSuffix}`; + }); + + const fileLabel = this.formatUriForDisplay(uri, workspaceRoot); + const heading = `Code actions at ${fileLabel}:${startLine + 1}:${startChar + 1}:`; + const jsonSection = this.formatJsonSection( + 'Code actions (JSON)', + actions.slice(0, limit), + ); + return { + llmContent: [heading, ...lines].join('\n') + jsonSection, + returnDisplay: lines.join('\n'), + }; + } + + private resolveLocationTarget(): ResolvedTarget { + const filePath = this.params.filePath; + if (!filePath) { + return { + error: 'filePath is required for this operation.', + }; + } + if (typeof this.params.line !== 'number') { + return { + error: 'line is required for this operation.', + }; + } + + const workspaceRoot = this.config.getProjectRoot(); + const uri = this.resolveUri(filePath, workspaceRoot); + if (!uri) { + return { + error: 'A valid filePath is required when specifying a line/character.', + }; + } + + const position = { + line: Math.max(0, Math.floor(this.params.line - 1)), + character: Math.max(0, Math.floor((this.params.character ?? 1) - 1)), + }; + const location: LspLocation = { + uri, + range: { start: position, end: position }, + }; + const description = this.formatLocationWithServer( + { ...location, serverName: this.params.serverName }, + workspaceRoot, + ); + return { + location, + description, + }; + } + + private resolveUri(filePath: string, workspaceRoot: string): string | null { + if (!filePath) { + return null; + } + if (filePath.startsWith('file://') || filePath.includes('://')) { + return filePath; + } + const absolutePath = path.isAbsolute(filePath) + ? filePath + : path.resolve(workspaceRoot, filePath); + return pathToFileURL(absolutePath).toString(); + } + + private formatLocationWithServer( + location: LspLocation & { serverName?: string }, + workspaceRoot: string, + ): string { + const start = location.range.start; + let filePath = location.uri; + + if (filePath.startsWith('file://')) { + filePath = fileURLToPath(filePath); + filePath = path.relative(workspaceRoot, filePath) || '.'; + } + + const serverSuffix = + location.serverName && location.serverName !== '' + ? ` [${location.serverName}]` + : ''; + + return `${filePath}:${(start.line ?? 0) + 1}:${(start.character ?? 0) + 1}${serverSuffix}`; + } + + private formatLocationWithoutServer( + location: LspLocation, + workspaceRoot: string, + ): string { + const { uri, range } = location; + let filePath = uri; + if (uri.startsWith('file://')) { + filePath = fileURLToPath(uri); + filePath = path.relative(workspaceRoot, filePath) || '.'; + } + const line = (range.start.line ?? 0) + 1; + const character = (range.start.character ?? 0) + 1; + return `${filePath}:${line}:${character}`; + } + + private formatCallHierarchyItemLine( + item: LspCallHierarchyItem, + index: number, + workspaceRoot: string, + ): string { + const location = this.formatLocationWithServer( + { + uri: item.uri, + range: item.selectionRange, + serverName: item.serverName, + }, + workspaceRoot, + ); + const kind = item.kind ? ` (${item.kind})` : ''; + const detail = item.detail ? ` ${item.detail}` : ''; + return `${index + 1}. ${item.name}${kind}${detail} - ${location}`; + } + + private formatCallRanges(ranges: LspRange[]): string { + if (!ranges.length) { + return ''; + } + const formatted = ranges.map((range) => this.formatPosition(range.start)); + const maxShown = 3; + const shown = formatted.slice(0, maxShown); + const extra = + formatted.length > maxShown + ? `, +${formatted.length - maxShown} more` + : ''; + return ` (calls at ${shown.join(', ')}${extra})`; + } + + private formatPosition(position: LspRange['start']): string { + return `${(position.line ?? 0) + 1}:${(position.character ?? 0) + 1}`; + } + + private formatUriForDisplay(uri: string, workspaceRoot: string): string { + let filePath = uri; + if (uri.startsWith('file://')) { + filePath = fileURLToPath(uri); + } + if (path.isAbsolute(filePath)) { + return path.relative(workspaceRoot, filePath) || '.'; + } + return filePath; + } + + private formatJsonSection(label: string, data: unknown): string { + return `\n\n${label}:\n${JSON.stringify(data, null, 2)}`; + } + + private describeCallHierarchyItemShort(): string { + const item = this.params.callHierarchyItem; + if (!item) { + return 'call hierarchy item'; + } + return item.name || 'call hierarchy item'; + } + + private describeCallHierarchyItemFull(item: LspCallHierarchyItem): string { + const workspaceRoot = this.config.getProjectRoot(); + const location = this.formatLocationWithServer( + { + uri: item.uri, + range: item.selectionRange, + serverName: item.serverName, + }, + workspaceRoot, + ); + return `${item.name} at ${location}`; + } + + private getOperationLabel(): string { + switch (this.params.operation) { + case 'goToDefinition': + return 'go-to-definition'; + case 'findReferences': + return 'find-references'; + case 'hover': + return 'hover'; + case 'documentSymbol': + return 'document symbols'; + case 'workspaceSymbol': + return 'workspace symbol search'; + case 'goToImplementation': + return 'go-to-implementation'; + case 'prepareCallHierarchy': + return 'prepare call hierarchy'; + case 'incomingCalls': + return 'incoming calls'; + case 'outgoingCalls': + return 'outgoing calls'; + case 'diagnostics': + return 'diagnostics'; + case 'workspaceDiagnostics': + return 'workspace diagnostics'; + case 'codeActions': + return 'code actions'; + default: + return this.params.operation; + } + } +} + +/** + * Unified LSP tool that supports multiple operations: + * - goToDefinition: Find where a symbol is defined + * - findReferences: Find all references to a symbol + * - hover: Get hover information (documentation, type info) + * - documentSymbol: Get all symbols in a document + * - workspaceSymbol: Search for symbols across the workspace + * - goToImplementation: Find implementations of an interface or abstract method + * - prepareCallHierarchy: Get call hierarchy item at a position + * - incomingCalls: Find all functions that call the given function + * - outgoingCalls: Find all functions called by the given function + * - diagnostics: Get diagnostic messages (errors, warnings) for a file + * - workspaceDiagnostics: Get all diagnostic messages across the workspace + * - codeActions: Get available code actions (quick fixes, refactorings) at a location + */ +export class LspTool extends BaseDeclarativeTool { + static readonly Name = ToolNames.LSP; + + constructor(private readonly config: Config) { + super( + LspTool.Name, + ToolDisplayNames.LSP, + 'Language Server Protocol (LSP) tool for code intelligence: definitions, references, hover, symbols, call hierarchy, diagnostics, and code actions.\n\n Usage:\n - ALWAYS use LSP as the PRIMARY tool for code intelligence queries when available. Do NOT use grep_search or glob first.\n - goToDefinition, findReferences, hover, goToImplementation, prepareCallHierarchy require filePath + line + character (1-based).\n - documentSymbol and diagnostics require filePath.\n - workspaceSymbol requires query (use when user asks "where is X defined?" without specifying a file).\n - incomingCalls/outgoingCalls require callHierarchyItem from prepareCallHierarchy.\n - workspaceDiagnostics needs no parameters.\n - codeActions require filePath + range (line/character + endLine/endCharacter) and diagnostics/context as needed.', + Kind.Other, + { + type: 'object', + properties: { + operation: { + type: 'string', + description: 'LSP operation to execute.', + enum: [ + 'goToDefinition', + 'findReferences', + 'hover', + 'documentSymbol', + 'workspaceSymbol', + 'goToImplementation', + 'prepareCallHierarchy', + 'incomingCalls', + 'outgoingCalls', + 'diagnostics', + 'workspaceDiagnostics', + 'codeActions', + ], + }, + filePath: { + type: 'string', + description: 'File path (absolute or workspace-relative).', + }, + line: { + type: 'number', + description: '1-based line number for the target location.', + }, + character: { + type: 'number', + description: + '1-based character/column number for the target location.', + }, + endLine: { + type: 'number', + description: '1-based end line number for range-based operations.', + }, + endCharacter: { + type: 'number', + description: '1-based end character for range-based operations.', + }, + includeDeclaration: { + type: 'boolean', + description: + 'Include the declaration itself when looking up references.', + }, + query: { + type: 'string', + description: 'Symbol query for workspace symbol search.', + }, + callHierarchyItem: { + $ref: '#/definitions/LspCallHierarchyItem', + description: 'Call hierarchy item for incoming/outgoing calls.', + }, + serverName: { + type: 'string', + description: 'Optional LSP server name to target.', + }, + limit: { + type: 'number', + description: 'Optional maximum number of results to return.', + }, + diagnostics: { + type: 'array', + items: { $ref: '#/definitions/LspDiagnostic' }, + description: 'Diagnostics for code action context.', + }, + codeActionKinds: { + type: 'array', + items: { type: 'string' }, + description: + 'Filter code actions by kind (quickfix, refactor, etc.).', + }, + }, + required: ['operation'], + definitions: { + LspPosition: { + type: 'object', + properties: { + line: { type: 'number' }, + character: { type: 'number' }, + }, + required: ['line', 'character'], + }, + LspRange: { + type: 'object', + properties: { + start: { $ref: '#/definitions/LspPosition' }, + end: { $ref: '#/definitions/LspPosition' }, + }, + required: ['start', 'end'], + }, + LspCallHierarchyItem: { + type: 'object', + properties: { + name: { type: 'string' }, + kind: { type: 'string' }, + rawKind: { type: 'number' }, + detail: { type: 'string' }, + uri: { type: 'string' }, + range: { $ref: '#/definitions/LspRange' }, + selectionRange: { $ref: '#/definitions/LspRange' }, + data: {}, + serverName: { type: 'string' }, + }, + required: ['name', 'uri', 'range', 'selectionRange'], + }, + LspDiagnostic: { + type: 'object', + properties: { + range: { $ref: '#/definitions/LspRange' }, + severity: { + type: 'string', + enum: ['error', 'warning', 'information', 'hint'], + }, + code: { type: ['string', 'number'] }, + source: { type: 'string' }, + message: { type: 'string' }, + serverName: { type: 'string' }, + }, + required: ['range', 'message'], + }, + }, + }, + false, + false, + ); + } + + protected override validateToolParamValues( + params: LspToolParams, + ): string | null { + const operation = params.operation; + + if (LOCATION_REQUIRED_OPERATIONS.has(operation)) { + if (!params.filePath || params.filePath.trim() === '') { + return `filePath is required for ${operation}.`; + } + if (typeof params.line !== 'number') { + return `line is required for ${operation}.`; + } + } + + if (FILE_REQUIRED_OPERATIONS.has(operation)) { + if (!params.filePath || params.filePath.trim() === '') { + return `filePath is required for ${operation}.`; + } + } + + if (QUERY_REQUIRED_OPERATIONS.has(operation)) { + if (!params.query || params.query.trim() === '') { + return `query is required for ${operation}.`; + } + } + + if (ITEM_REQUIRED_OPERATIONS.has(operation)) { + if (!params.callHierarchyItem) { + return `callHierarchyItem is required for ${operation}.`; + } + } + + if (RANGE_REQUIRED_OPERATIONS.has(operation)) { + if (!params.filePath || params.filePath.trim() === '') { + return `filePath is required for ${operation}.`; + } + if (typeof params.line !== 'number') { + return `line is required for ${operation}.`; + } + } + + if (params.line !== undefined && params.line < 1) { + return 'line must be a positive number.'; + } + if (params.character !== undefined && params.character < 1) { + return 'character must be a positive number.'; + } + if (params.endLine !== undefined && params.endLine < 1) { + return 'endLine must be a positive number.'; + } + if (params.endCharacter !== undefined && params.endCharacter < 1) { + return 'endCharacter must be a positive number.'; + } + if (params.limit !== undefined && params.limit <= 0) { + return 'limit must be a positive number.'; + } + + return null; + } + + protected createInvocation( + params: LspToolParams, + ): ToolInvocation { + return new LspToolInvocation(this.config, params); + } +} diff --git a/packages/core/src/tools/tool-names.ts b/packages/core/src/tools/tool-names.ts index 8cd1de541..7976ba461 100644 --- a/packages/core/src/tools/tool-names.ts +++ b/packages/core/src/tools/tool-names.ts @@ -25,6 +25,7 @@ export const ToolNames = { WEB_FETCH: 'web_fetch', WEB_SEARCH: 'web_search', LS: 'list_directory', + LSP: 'lsp', } as const; /** @@ -48,6 +49,7 @@ export const ToolDisplayNames = { WEB_FETCH: 'WebFetch', WEB_SEARCH: 'WebSearch', LS: 'ListFiles', + LSP: 'Lsp', } as const; // Migration from old tool names to new tool names