0

0

VSCode插件开发实战_构建自定义语言支持

betcha

betcha

发布时间:2025-11-23 19:44:02

|

198人浏览过

|

来源于php中文网

原创

首先通过yo code初始化VSCode插件项目,接着定义TextMate语法实现高亮,然后使用vscode-languageserver构建语言服务器支持智能提示,最后测试并打包发布插件。

vscode插件开发实战_构建自定义语言支持

想让你的语言在编辑器里“活”起来?Visual Studio Code 提供了强大的 API,让开发者能轻松为自定义语言添加语法高亮、智能提示、代码跳转等核心功能。本文带你一步步从零开始,构建一个支持简单 DSL(领域特定语言)的 VSCode 插件。

1. 初始化插件项目

VSCode 官方提供 yo code 脚手架工具,可快速生成插件模板。确保已安装 Node.jsnpm,然后执行:

  • 安装 Yeoman 和 VSCode 生成器:
    npm install -g yo generator-code
  • 运行生成器:
    yo code
  • 选择“New Language Support”类型,填写语言名、文件扩展名等信息

完成后会生成包含 package.jsonsyntaxes/snippets/ 等目录的基础结构。

2. 定义语法高亮(TextMate 规则)

VSCode 使用 TextMate 语法规则实现语法着色。在 syntaxes/ 目录下创建 yourlang.tmLanguage.json 文件。

以一个配置语言为例,匹配关键字和键值对

{
  "scopeName": "source.yourlang",
  "patterns": [
    {
      "match": "\\b(if|else|while)\\b",
      "name": "keyword.control.yourlang"
    },
    {
      "match": "^\\s*([a-zA-Z_][\\w]*)\\s*=",
      "captures": {
        "1": { "name": "entity.name.function.yourlang" }
      }
    },
    {
      "begin": "\"",
      "end": "\"",
      "name": "string.quoted.double.yourlang"
    }
  ],
  "repository": {},
  "fileTypes": ["your"]
}

保存后,在 package.jsoncontributes 字段中注册该语法:

"grammars": [
  {
    "language": "yourlang",
    "scopeName": "source.yourlang",
    "path": "./syntaxes/yourlang.tmLanguage.json"
  }
]

3. 实现语言服务器(LSP)功能

要支持补全、跳转、悬停提示等功能,需集成语言服务器协议(LSP)。使用 vscode-languageserver 库构建服务端。

极品HTML5网络建站公司模板源码(包含源文件)3.0
极品HTML5网络建站公司模板源码(包含源文件)3.0

1、架构轻盈,完全免费与开源采用轻量MVC架构开发,兼顾效率与拓展性。全局高效缓存,打造飞速体验。 2、让简洁与强大并存强大字段自定义功能,完善的后台开关模块,不会编程也能搭建各类网站系统。 3、顶级搜索引擎优化功能纯静态、伪静态,全部支持自由设置规则,内容、栏目自由设置URL格式。 4、会员、留言、投稿、支付购物神马一个不能少不断升级完善的模块与插件,灵活的组装与自定义设置,满足你的多样需求。

下载
  • 安装依赖:
    npm install vscode-languageserver
  • 创建 server.js,监听客户端请求:
const { createConnection, TextDocuments } = require('vscode-languageserver');

const connection = createConnection();
const documents = new TextDocuments();

connection.onInitialize(() => ({
  capabilities: {
    textDocumentSync: documents.syncKind,
    completionProvider: { triggerCharacters: ['.'] }
  }
}));

connection.onCompletion((params) => {
  return [
    { label: 'startService', kind: 2 },
    { label: 'timeout', kind: 5 }
  ];
});

documents.listen(connection);
connection.listen();

package.json 中声明激活事件和服务器入口:

"activationEvents": [
  "onLanguage:yourlang"
],
"main": "./extension",
"contributes": {
  "languages": [{
    "id": "yourlang",
    "extensions": [".your"]
  }]
}

并在 extension.js 中启动语言服务器进程。

4. 测试与打包发布

F5 启动调试模式,VSCode 会打开一个新窗口加载你的插件。创建一个 .your 文件测试高亮和补全是否生效。

确认无误后,使用 vsce 工具打包:

  • 安装:npm install -g vsce
  • 登录 Microsoft Marketplace
  • 执行:vsce publish 直接发布,或 vsce package 生成 .vsix 文件本地安装

基本上就这些。掌握语法定义和 LSP 集成后,你可以逐步加入诊断检查、格式化、重命名等高级功能。自定义语言支持看似复杂,拆解后每一步都很清晰。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

402

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

528

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

306

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

508

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

241

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

248

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

5217

2023.08.17

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

3

2025.12.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
go语言零基础开发内容管理系统
go语言零基础开发内容管理系统

共34课时 | 2.5万人学习

第二十三期_前端开发
第二十三期_前端开发

共98课时 | 7.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号