基于Language Server Protocol的VSCode语法高亮插件开发实践

夏萱同学_9063

夏萱同学_9063

2026-09-06

138人浏览

原创

lsp本身不负责语法高亮,它仅定义编辑器与语言服务器的通信协议;真正实现高亮的是客户端的semantictokensprovider等api,需服务器主动返回结构化token数据并手动配置启用。

基于language server protocol的vscode语法高亮插件开发实践

为什么LSP不是语法高亮的首选方案

直接说结论:Language Server Protocol 本身不负责语法高亮。它只定义了编辑器与语言服务器之间的通信协议,真正做高亮的是 VSCode 客户端侧的 semanticTokensProviderdocumentHighlightProvider 等 API,而这些能力需要语言服务器主动注册并返回结构化 token 数据——这意味着你必须在 LSP 服务里额外实现语义分析逻辑,且客户端插件仍需配套注册 provider。

常见误解是“用了 LSP 就自动有高亮”,结果跑起来发现文件全是黑白的。根本原因在于:LSP 的 textDocument/semanticTokens/full 请求默认不触发,除非你在客户端扩展中显式调用 languages.registerSemanticTokensProvider,并在服务器端正确响应 token 类型、范围和修饰符。

  • 纯 LSP 启动后,VSCode 不会自动启用语义高亮,必须手动开启设置:"editor.semanticHighlighting.enabled": true
  • semanticTokensProvider 返回的 token 数组不能包含重叠范围,否则整个高亮会失效(VSCode 不报错,但静默跳过)
  • 性能敏感:每次编辑都会触发 full/delta token 请求,若服务器解析耗时 >100ms,用户会感知到高亮延迟或闪烁

TextMate 语法高亮才是快速落地的第一步

如果你的目标是让 GoSu 或类似 DSL 在 VSCode 里“先看起来像代码”,package.json 里声明 grammars + snippets,搭配一个 .tmLanguage.json 文件,5 分钟就能上线基础高亮。VSCode 内置的 TextMate 引擎只做词法匹配,不依赖进程通信,零延迟、零崩溃风险。

这个方案适合绝大多数内部 DSL 场景——比如 GoSu 的 programfunctionproperty 关键字,或是自定义注释 ##@rule、变量插值 ${foo} 等模式,全靠正则就能覆盖。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • 正则中避免使用 .* 这类贪婪匹配,TextMate 对嵌套结构支持弱,容易导致整行变色异常
  • 作用域名(scope name)必须唯一且符合规范,例如 source.gosu,否则主题无法映射颜色
  • 不要试图在 TextMate 里做语义判断(如“只有在 class 块内才高亮 method”),它没有上下文状态机

何时必须上 LSP 语义高亮

当你需要区分同名但不同含义的标识符时,TextMate 就不够用了。比如 GoSu 中的 policy 可能是类型名、变量名、或配置块关键字;又或者你想把所有被 @Deprecated 注解修饰的方法名标成灰色——这种依赖 AST 或符号表的判断,只能由 LSP 服务完成。

此时你要做的不是重写整个高亮逻辑,而是复用已有的 TextMate 基础高亮,再叠加一层语义层:TextMate 负责分词(tokenization),LSP 负责标注(annotation)。

  • 服务器端需实现 semanticTokensProvider 接口,返回 TokenTypes(如 functiontype)和 TokenModifiers(如 deprecatedreadonly
  • 客户端扩展中必须用 vscode.languages.registerSemanticTokensProvider 绑定文档语言和 provider 实例
  • VSCode 主题需支持对应 scope,例如 support.function.gosu 才能生效,否则 fallback 到 TextMate 颜色

调试高亮失效的三个关键检查点

高亮没反应?别急着重写 parser,先看这三处:

  • 确认 package.jsoncontributes.languages.idgrammars.language 完全一致,大小写、连字符都不能错(例如 gosuGoSu
  • 打开 VSCode 开发者工具(Ctrl+Shift+PDeveloper: Toggle Developer Tools),过滤关键词 semanticTokens,看是否有 Response rejected 或空数组返回
  • 运行 Developer: Inspect Editor Tokens and Scopes(快捷键 Ctrl+Shift+P 搜),点击目标文本,检查右下角显示的 scope 是否是你在 .tmLanguage.json 或 LSP 中定义的那个

最常被忽略的一点:VSCode 缓存了语法定义。改完 .tmLanguage.json 后,必须重启窗口(Developer: Reload Window),仅刷新扩展无效。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1135

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2232

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1789

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1587

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2467

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1738

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1202

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1076

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

394

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程