如何为基于IHaskell的自定义DSL Jupyter内核加载语法高亮解析器

核心思路 #

Jupyter Lab 3.x+ 采用Lezer作为语法解析引擎，要让自定义DSL内核实现对应高亮，需将Lezer解析器绑定到DSL对应的代码单元格MIME类型，同时确保内核能触发解析器的加载流程。

步骤1：打包Lezer解析器为可加载的JS模块 #

按照Lezer教程生成解析器后，编译成浏览器环境可加载的模块。示例代码如下（需根据你的DSL调整细节）：

import { parser } from "./my-dsl-parser.js";
import { LezerLanguage } from "@jupyterlab/codemirror";

export const myDSLLanguage = new LezerLanguage({
  parser: parser,
  languageData: {
    commentTokens: { line: "//" }, // 替换为你的DSL注释规则
  },
});

将该文件与依赖的Lezer核心模块打包为独立JS文件，比如命名为my-dsl-highlight.js。

步骤2：挂载解析器到内核静态资源目录 #

IHaskell内核的静态资源目录通常为：

• 本地安装：~/.ipython/kernels/your-dsl-kernel/static/
• 全局安装：/usr/share/jupyter/kernels/your-dsl-kernel/static/

把打包好的my-dsl-highlight.js放入该目录。

步骤3：修改内核配置关联语法规则 #

1. 在静态资源目录创建kernel.js，内容如下：

define(["@jupyterlab/codemirror", "./my-dsl-highlight.js"], function(codemirror, myDSL) {
  // 绑定DSL的MIME类型到语法模式
  codemirror.CodeMirror.modeInfo.push({
    name: "MyDSL",
    mime: "text/x-mydsl", // 需与内核返回的MIME类型一致
    mode: "mydsl",
    ext: [".mydsl"]
  });
  // 注册Lezer语言实例
  codemirror.LezerLanguage.register({
    id: "mydsl",
    language: myDSL.myDSLLanguage
  });
});

2. 编辑同目录下的kernel.json，在metadata字段添加脚本引用：

{
  "argv": ["your-dsl-kernel-executable", "{connection_file}"],
  "display_name": "MyDSL",
  "language": "MyDSL",
  "metadata": {
    "kernelspec": {
      "script": "kernel.js"
    }
  },
  "mimetype": "text/x-mydsl"
}

步骤4：验证加载效果 #

重启Jupyter Lab，新建一个MyDSL内核的笔记本，检查代码单元格是否自动应用语法高亮。若未生效，可打开浏览器控制台排查加载错误（如路径错误、解析器初始化失败等）。

替代方案：通过Jupyter Lab扩展加载 #

若不想将解析器与内核绑定，可单独编写轻量Jupyter Lab扩展，在扩展激活时注册Lezer语法，示例激活函数如下：

import { JupyterFrontEnd } from "@jupyterlab/application";
import { myDSLLanguage } from "./my-dsl-highlight.js";
import { LezerLanguage } from "@jupyterlab/codemirror";

export function activate(app: JupyterFrontEnd) {
  LezerLanguage.register({
    id: "mydsl",
    language: myDSLLanguage
  });
  app.docRegistry.addFileType({
    name: "mydsl",
    mimeTypes: ["text/x-mydsl"],
    fileExtensions: [".mydsl"],
    contentType: "text"
  });
}

打包扩展后用jupyter labextension install命令安装即可。

内容的提问来源于stack exchange，提问作者Yuriosity