0

0

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

幻影之瞳

幻影之瞳

发布时间:2025-10-31 13:38:02

|

291人浏览过

|

来源于php中文网

原创

答案是通过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 等。

Cursor
Cursor

一个新的IDE,使用AI来帮助您重构、理解、调试和编写代码。

下载

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 实现清晰可读的高亮效果。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

420

2023.08.07

json是什么
json是什么

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

536

2023.08.23

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

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

312

2023.10.13

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

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

77

2025.09.10

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

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

515

2023.06.20

正则表达式不包含
正则表达式不包含

正则表达式,又称规则表达式,,是一种文本模式,包括普通字符和特殊字符,是计算机科学的一个概念。正则表达式使用单个字符串来描述、匹配一系列匹配某个句法规则的字符串,通常被用来检索、替换那些符合某个模式的文本。php中文网给大家带来了有关正则表达式的相关教程以及文章,希望对大家能有所帮助。

251

2023.07.05

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

748

2023.07.05

java正则表达式匹配字符串
java正则表达式匹配字符串

在Java中,我们可以使用正则表达式来匹配字符串。本专题为大家带来java正则表达式匹配字符串的相关内容,帮助大家解决问题。

215

2023.08.11

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

14

2026.01.30

热门下载

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

精品课程

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

共34课时 | 2.6万人学习

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

共98课时 | 7.6万人学习

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

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