VSCode语言配置:为领域特定语言创建语法高亮规则

答案是通过vscode扩展为DSL添加语法高亮。首先用Yeoman生成项目结构,配置language-configuration.json定义注释、括号等规则,再在syntaxes目录的TextMate语法文件中使用正则定义关键字、字符串等匹配模式,通过F5调试并检查Token作用域,最后打包发布。

VSCode语言配置:为领域特定语言创建语法高亮规则

在 VSCode 中为领域特定语言(DSL)创建语法高亮规则,核心是通过 TextMate 语法文件(json 或 PLIST 格式)定义词法匹配模式。你不需要从零开发编辑器,只需编写一个语法扩展,让 VSCode 能识别 DSL 的关键字、注释、字符串等元素并着色。

1. 准备工作:创建 VSCode 扩展项目

使用 Yeoman 生成器快速搭建语法扩展结构:

npm install -g yo generator-code
yo code

选择“New Language”类型,填写你的 DSL 名称、文件扩展名(如 .mydsl)、语言 ID 等信息。生成的项目包含基本文件结构,重点关注 language-configuration.jsonsyntaxes/ 目录下的语法文件。

2. 定义语言配置 language-configuration.json

这个文件告诉 VSCode 基本的语言行为,比如注释格式、括号配对、自动缩进等。示例:

{   "comments": {     "lineComment": "//",     "blockComment": ["/*", "*/"]   },   "brackets": [     ["{", "}"],     ["[", "]"],     ["(", ")"]   ],   "autoClosingPairs": [     ["{", "}"],     ["[", "]"],     ["(", ")"],     [""", """],     ["'", "'"]   ],   "surroundingPairs": [     ["{", "}"],     ["[", "]"],     ["(", ")"],     [""", """],     ["'", "'"]   ] } 

根据你的 DSL 实际规则调整内容。

3. 编写语法高亮规则(TextMate 语法)

进入 syntaxes/ 目录,默认会有一个 .json 文件(如 mydsl.tmLanguage.json)。这是语法高亮的核心,使用正则表达式匹配语言元素。

基本结构包括:

  • scopeName:唯一标识符,如 source.mydsl
  • name:语法名称
  • patterns:匹配规则列表
  • repository:可复用的规则片段

示例:为自定义关键字、字符串和注释添加高亮

{   "scopeName": "source.mydsl",   "name": "MyDSL",   "patterns": [     {       "name": "keyword.control.mydsl",       "match": "b(if|else|while|return)b"     },     {       "name": "String.quoted.double.mydsl",       "begin": """,       "end": """,       "patterns": [         {           "name": "constant.character.escape.mydsl",           "match": "\."         }       ]     },     {       "name": "comment.line.double-slash.mydsl",       "match": "//.*$"     }   ],   "repository": {} } 

其中 name 字段是作用域(scope),VSCode 使用它决定颜色。你可以参考现有语言的作用域命名规范,如 keyword、string、comment 等。

VSCode语言配置:为领域特定语言创建语法高亮规则

云雀语言模型

云雀是一款由字节跳动研发的语言模型,通过便捷的自然语言交互,能够高效的完成互动对话

VSCode语言配置:为领域特定语言创建语法高亮规则54

查看详情 VSCode语言配置:为领域特定语言创建语法高亮规则

4. 测试与调试语法高亮

按 F5 启动扩展调试窗口,在新窗口中打开一个 .mydsl 文件。如果未自动启用你的语言模式,可通过右下角选择语言模式。

使用以下方法检查匹配情况:

  • 菜单:Developer: Inspect Editor Tokens and Scopes
  • 查看当前光标位置的 token 类型和作用域链
  • 根据返回的 scope 判断是否正确匹配

修改语法文件后需重新加载调试窗口(Ctrl+R 或 Cmd+R)查看更新效果。

5. 发布与使用

完成测试后,可将扩展打包为 .vsix 文件:

npx vsce package

安装本地扩展:

code –install-extension your-extension.vsix

也可发布到 VSCode Marketplace 供他人使用。

基本上就这些。不复杂但容易忽略细节,尤其是正则表达式边界和作用域命名。保持语法简洁,逐步迭代添加规则,就能为你的 DSL 实现清晰可读的高亮效果。

上一篇
下一篇
text=ZqhQzanResources