如何在VSCode中配置LSP以实现自定义语言支持？-VSCode-PHP中文网

答案是需搭建VSCode扩展作为客户端连接语言服务器，核心步骤包括：准备支持LSP的语言服务器、用yo code创建TypeScript扩展项目、配置package.json声明语言ID与激活事件、编写客户端代码通过vscode-languageclient库建立通信、区分LSP不提供的语法高亮（需TextMate语法）和代码片段（需.json文件），并利用trace日志调试双向通信。

如何在vscode中配置lsp以实现自定义语言支持？

要在VSCode里为自定义语言配置LSP（Language Server Protocol）支持，核心其实就是搭建一个“翻译官”——一个VSCode扩展，它能理解LSP协议，并把VSCode的操作指令传达给你的语言服务器，再把服务器的智能反馈展示出来。这听起来可能有点绕，但说白了，就是让VSCode学会怎么跟你的语言“大脑”对话，从而实现代码补全、错误提示、跳转定义这些高级功能。

解决方案

配置LSP支持，通常需要你先有一个实现了LSP协议的语言服务器（Language Server），然后用一个VSCode扩展（Language Client）来连接它。整个过程可以拆解成几个关键步骤，在我看来，这更像是在构建一个双向沟通的桥梁。

准备你的语言服务器： 这是所有智能功能的源头。你的语言服务器需要能够解析自定义语言的代码，并根据LSP规范提供诊断、补全、格式化等服务。它可以是用任何语言编写的，比如Python、Java、Go、Rust，只要它能通过标准输入/输出（stdio）或TCP套接字与客户端通信。如果你还没有，这会是你工作量最大的一块。
创建VSCode扩展项目： 使用
```
yo code
```
登录后复制
脚手架工具，选择 "New Language Server Extension (TypeScript)" 模板。这会为你生成一个包含客户端和服务器端（一个简单的Node.js服务器示例）的骨架项目。即便你的语言服务器是其他语言写的，这个模板也提供了一个很好的客户端结构。

配置

package.json

登录后复制

：这是你的扩展的“身份证”。你需要在这里声明你的语言ID、文件关联、激活事件等。最关键的是

contributes.languages

登录后复制

部分，它告诉VSCode你的扩展支持哪种语言：

{
    "name": "my-custom-language-extension",
    "displayName": "My Custom Language",
    "description": "Provides LSP support for My Custom Language.",
    "version": "0.0.1",
    "engines": {
        "vscode": "^1.80.0"
    },
    "categories": [
        "Programming Languages"
    ],
    "contributes": {
        "languages": [{
            "id": "myCustomLang", // 你的语言ID，非常重要
            "aliases": ["My Custom Language", "myCustomLang"],
            "extensions": [".myc"], // 你的语言文件后缀
            "configuration": "./language-configuration.json" // 可选，用于括号匹配等
        }],
        "grammars": [
            // 语法高亮配置，后面会提到
        ],
        "snippets": [
            // 代码片段配置，后面会提到
        ]
    },
    "main": "./out/extension.js", // 扩展的入口文件
    "activationEvents": [
        "onLanguage:myCustomLang" // 当VSCode打开你的语言文件时激活
    ],
    "scripts": {
        "vscode:prepublish": "npm run compile",
        "compile": "tsc -p ./",
        "watch": "tsc -watch -p ./"
    },
    "devDependencies": {
        "vscode": "^1.80.0",
        "vscode-languageclient": "^8.0.2",
        "typescript": "^5.0.0"
    }
}

登录后复制

编写客户端代码 (

extension.ts

登录后复制

)：这是连接VSCode和语言服务器的桥梁。你会用到

vscode-languageclient

登录后复制

库。

import * as path from 'path';
import { workspace, ExtensionContext } from 'vscode';
import {
    LanguageClient,
    LanguageClientOptions,
    ServerOptions,
    TransportKind
} from 'vscode-languageclient/node';

let client: LanguageClient;

export function activate(context: ExtensionContext) {
    // 你的语言服务器的路径，这里假设是一个Node.js脚本
    // 如果是其他语言，这里可能是可执行文件的路径
    const serverModule = context.asAbsolutePath(
        path.join('server', 'out', 'server.js') // 假设你的服务器在 'server/out/server.js'
    );

    // 语言服务器的启动选项
    // 这里以Node.js为例，使用Node.js的debug端口
    const serverOptions: ServerOptions = {
        run: { module: serverModule, transport: TransportKind.ipc },
        debug: {
            module: serverModule,
            transport: TransportKind.ipc,
            options: { execArgv: ['--nolazy', '--inspect=6009'] } // 调试模式
        }
    };

    // 客户端选项
    const clientOptions: LanguageClientOptions = {
        documentSelector: [{ scheme: 'file', language: 'myCustomLang' }], // 监听 'myCustomLang' 语言的文件
        synchronize: {
            // 当工作区文件改变时，通知语言服务器
            fileEvents: workspace.createFileSystemWatcher('**/.myc')
        },
        outputChannelName: 'My Custom Language Server' // 在VSCode输出面板显示服务器日志
    };

    // 创建语言客户端并启动
    client = new LanguageClient(
        'myCustomLanguageServer', // 客户端ID
        'My Custom Language Server', // 客户端名称
        serverOptions,
        clientOptions
    );

    client.start(); // 启动客户端，连接服务器
}

export function deactivate(): Thenable<void> | undefined {
    if (!client) {
        return undefined;
    }
    return client.stop(); // 停止客户端
}

登录后复制

这里的

serverModule

登录后复制

如果你的服务器是Python可执行文件，就指向那个文件。如果是Java，可能需要

command: ['java', '-jar', 'your-server.jar']

登录后复制

这样的配置。这是最灵活也最容易出错的地方，得根据你的实际情况来。

测试与调试： 在VSCode中按
```
F5
```
登录后复制
，会打开一个新的“扩展开发主机”窗口。在这个新窗口中打开你的
```
.myc
```
登录后复制
文件，你的LSP功能应该就能工作了。如果没工作，别慌，调试是必经之路。

开发自定义LSP客户端需要哪些核心技术栈？

要搞定一个自定义LSP客户端，主要的技术栈其实相对集中，但服务器端就看你的选择了。在我看来，这更像是一个前端（VSCode扩展）和后端（语言服务器）的协作。

VSCode扩展开发环境 (客户端侧)：
- TypeScript/JavaScript： 这是编写VSCode扩展的首选语言。TypeScript提供了类型安全，对大型项目来说是救命稻草。
- Node.js： VSCode扩展运行在Node.js环境中。
- vscode
  登录后复制
  API： VSCode提供了一套丰富的API，用于与编辑器本身交互，比如注册命令、创建视图、操作文本等。
- vscode-languageclient
  登录后复制
  库：这是核心中的核心。它封装了LSP协议的复杂性，让你能更专注于业务逻辑，而不是底层通信细节。它负责启动和管理语言服务器进程，以及处理JSON-RPC消息的发送和接收。
语言服务器开发环境 (服务器侧)：
- 你自定义语言的解析器/编译器/解释器： 这是基础，服务器需要能理解你的语言。
- 支持LSP的库/框架： 无论你用什么语言开发服务器，最好都找一个现成的LSP库来简化开发。
  - Python:
```
pygls
```
    登录后复制
    是一个非常流行的选择，它让用Python实现LSP服务器变得简单。
  - Java:
```
lsp4j
```
    登录后复制
    是Eclipse基金会提供的LSP库，功能强大。
  - Rust:
```
tower-lsp
```
    登录后复制
    是一个不错的异步LSP框架。
  - Go: 社区也有一些LSP相关的库，但可能不如其他语言成熟。
- JSON-RPC： LSP本身就是基于JSON-RPC进行通信的，所以你的服务器需要能够发送和接收符合LSP规范的JSON-RPC消息。

总的来说，客户端这边是TypeScript/Node.js的世界，而服务器那边则灵活得多，你可以用你最熟悉的语言去实现。

如何有效地调试VSCode中的自定义LSP扩展？

调试LSP扩展，说实话，有点像在两个黑盒之间找问题，因为涉及客户端和服务器两个进程。但掌握一些技巧，能让你少走很多弯路。

分清客户端和服务器：
- 客户端 (VSCode Extension): 运行在VSCode的扩展宿主进程中。主要负责启动服务器、转发用户操作、显示服务器返回的信息。
- 服务器 (Language Server): 一个独立的进程，负责语言的核心逻辑。
客户端调试：
- VSCode内置调试器： 这是最直接的方式。在你的
```
extension.ts
```
  登录后复制
  文件中设置断点，然后按
```
F5
```
  登录后复制
  启动“扩展开发主机”。当你的扩展被激活时，断点就会触发。
- console.log
  登录后复制
  和
  vscode.window.showInformationMessage
  登录后复制
  ：快速检查值或流程，比断点更轻量。信息会显示在“调试控制台”或VSCode的通知区域。
- outputChannel
  登录后复制
  ：在
```
clientOptions
```
  登录后复制
  中配置
```
outputChannelName
```
  登录后复制
  ，然后通过
```
client.outputChannel.appendLine('...')
```
  登录后复制
  来输出客户端日志。这些日志会显示在VSCode的“输出”面板中。
服务器调试：
- Node.js 服务器： 如果你的语言服务器也是用Node.js写的，那调试起来相对容易。
  - 在
```
serverOptions.debug.options
```
    登录后复制
    中设置
```
--inspect
```
    登录后复制
    或
```
--inspect-brk
```
    登录后复制
    参数（比如
```
--inspect=6009
```
    登录后复制
    ）。
  - 在
```
launch.json
```
    登录后复制
    中添加一个配置，用于“Attach to Node Process”，并指定端口（例如
```
6009
```
    登录后复制
    ）。这样，你可以在VSCode中同时调试客户端和服务器。
- 其他语言的服务器： 这就需要利用各语言的调试工具了。
  - Python (
    debugpy
    登录后复制
    ): 在服务器代码中导入
```
debugpy
```
    登录后复制
    并调用
```
debugpy.listen()
```
    登录后复制
    ，然后在
```
launch.json
```
    登录后复制
    中配置“Python: Remote Attach”来连接。
  - Java (JDWP): 在JVM启动参数中添加
```
-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005
```
    登录后复制
    ，然后在
```
launch.json
```
    登录后复制
    中配置“Java: Attach to Remote Process”。
  - 通常，你需要在
```
serverOptions.command
```
    登录后复制
    中添加这些调试参数。
- 服务器日志： 确保你的语言服务器有良好的日志输出机制。这些日志通常会打印到标准错误流（stderr）或你配置的文件中。
```
clientOptions.traceOutputChannel
```
  登录后复制
  也可以帮你把服务器发来的LSP消息打印到输出面板，这对于理解服务器行为至关重要。
LSP通信日志：
- 这是排查LSP协议级别问题的“杀手锏”。在
```
LanguageClient
```
  登录后复制
  的
```
clientOptions
```
  登录后复制
  中设置
```
trace: Trace.Verbose
```
  登录后复制
  或
```
traceOutputChannel
```
  登录后复制
  。
- ```
clientOptions: { ..., trace: Trace.Verbose }
```
  登录后复制
  会在“输出”面板中显示客户端和服务器之间交换的所有LSP消息（JSON-RPC）。这能帮你判断是客户端没发对消息，还是服务器没正确响应。

调试LSP扩展，耐心是第一位的。一步步来，先确保服务器能独立运行并响应LSP消息，再确保客户端能正确启动服务器并与之通信。

Picsart AI Image Generator

Picsart推出的AI图片生成器

查看详情

自定义语言的语法高亮和代码片段，LSP能直接提供吗？

这是一个常见的误区，说实话，很多人一开始都会搞混。答案是：不，LSP不能直接提供语法高亮和代码片段。 LSP关注的是语言的“语义”部分，而语法高亮和代码片段属于“语法”和“编辑辅助”范畴，它们由VSCode的另外一套机制来支持。

语法高亮 (Syntax Highlighting)：
- LSP不提供： LSP提供的是诊断信息（错误、警告）、符号查找、代码补全建议等，这些都是基于对代码“意义”的理解。
- TextMate 语法文件： VSCode的语法高亮是通过TextMate语法文件（通常是
```
.tmLanguage.json
```
  登录后复制
  或
```
.tmLanguage
```
  登录后复制
  格式）实现的。这些文件使用正则表达式来匹配代码中的不同部分（关键字、字符串、注释、变量名等），然后为它们分配不同的“作用域”（scopes）。VSCode根据这些作用域，结合当前主题的颜色设置，来渲染代码颜色。
- 如何在扩展中添加： 你需要在
```
package.json
```
  登录后复制
  的
```
contributes.grammars
```
  登录后复制
  部分声明你的TextMate语法文件：
```
"contributes": {
    "grammars": [{
        "language": "myCustomLang",
        "scopeName": "source.mycustomlang", // 唯一的作用域名称
        "path": "./syntaxes/mycustomlang.tmLanguage.json" // 你的语法文件路径
    }]
}
```
  登录后复制
- 编写TextMate语法： 这可能需要一些学习曲线，因为它涉及到正则表达式和作用域的层叠。可以使用
```
yo code
```
  登录后复制
  生成一个语法高亮模板，或者使用在线工具来辅助生成。
代码片段 (Code Snippets)：
- LSP不提供： LSP可以提供基于上下文的代码补全（例如，输入对象名后自动弹出成员），但它不会提供预定义的、静态的代码片段（例如，输入
```
for
```
  登录后复制
  然后按Tab自动生成
```
for
```
  登录后复制
  循环结构）。
- ```
.json
```
  登录后复制
  格式文件： VSCode的代码片段通常存储在
```
.json
```
  登录后复制
  文件中。每个片段都包含一个前缀（触发词）、一个主体（实际的代码内容，支持占位符和变量）和一个描述。
- 如何在扩展中添加： 你需要在
```
package.json
```
  登录后复制
  的
```
contributes.snippets
```
  登录后复制
  部分声明你的代码片段文件：
```
"contributes": {
    "snippets": [{
        "language": "myCustomLang",
        "path": "./snippets/mycustomlang.json" // 你的代码片段文件路径
    }]
}
```
  登录后复制
- 示例
```
mycustomlang.json
```
  登录后复制
  ：
```
{
    "Print to console": {
        "prefix": "log",
        "body": [
            "console.log('${1:message}');",
            "$0"
        ],
        "description": "Log a message to the console"
    },
    "Function definition": {
        "prefix": "func",
        "body": [
            "func ${1:functionName}(${2:args}) {",
            "\t$0",
            "}"
        ],
        "description": "Define a new function"
    }
}
```
  登录后复制