VSCode的Notebook API:自定义你的交互式体验

13次阅读

需直接使用vscode公开Notebook API实现自定义交互:一、注册NotebookProvider接管生命周期;二、注入NotebookRenderer控制MIME类型渲染;三、扩展cell工具栏与上下文菜单;四、拦截执行请求注入预处理与后解析逻辑。

VSCode的Notebook API:自定义你的交互式体验

如果您希望在 VSCode 中扩展 Notebook 功能,通过编程方式控制单元格行为、渲染逻辑或交互流程,则需直接使用其公开的 Notebook API。以下是实现自定义交互式体验的具体路径:

本文运行环境:macBook Pro,macOS Sequoia。

一、注册自定义 Notebook 提供程序

VSCode 通过 NotebookProvider 接口允许扩展注册专属 Notebook 类型,从而完全接管打开、保存、执行等生命周期事件。该方式适用于构建全新格式的 Notebook(如 .mybook),并绑定专属内核与 ui 行为。

1、在扩展的 package.json 中声明 notebook 类型,添加 contributes.notebooks 字段,指定 type、displayName 和 selector。

2、在激活函数中调用 vscode.notebooks.registerNotebookProvider,传入唯一 type 字符串和实现 NotebookProvider 接口的对象

3、重写 resolveNotebookContent 方法,返回包含 metadata 和 cells 的 NotebookData 实例;重写 serializeNotebook 方法,将 NotebookData 转为 Uint8Array 写入文件系统。

4、在 onDidChangeNotebookCellExecutionState 事件监听中响应单元格执行状态变化,确保所有异步操作均返回 promise 并正确处理 reject

二、注入自定义 Cell Renderer

通过 NotebookRendererApi 可注册独立于内核的前端渲染器,用于控制特定 MIME 类型内容的展示效果,例如将 text/html 渲染为带动画的卡片、将 application/vnd.myplot+json 渲染为可拖拽图表。

1、在 package.json 的 contributes.notebookRenderer 中声明 renderer ID 与支持的 mimeTypes 列表。

2、创建 renderer.js 文件,在其中调用 acquireRenderer() 获取 RendererApi 实例,并监听 customMessage 事件。

3、在 NotebookCellOutputItem.create() 中传入自定义 mimeType 和 data ArrayBuffer,触发对应 renderer 执行。

4、renderer.js 必须为纯客户端脚本,不可访问 vscode 命名空间node.js 模块

三、扩展 Cell 工具栏与上下文菜单

通过 notebook.cellToolbarItems 和 notebook.cellContextMenus 贡献点,可在每个单元格顶部工具栏或右键菜单中插入自定义按钮与命令,实现快速格式化、导出、调试跳转等功能。

1、在 package.json 的 contributes.menus 下配置 notebook/cell/toolbar 或 notebook/cell/context 节点,指定 command 和 when 条件。

2、注册对应 command,其回调函数接收 NotebookCell 对象作为参数,可读取 cell.document.getText() 或修改 cell.metadata。

3、使用 vscode.window.showQuickPick 配合 cell.index 构建当前单元格上下文感知的操作流。

4、when 条件中禁止使用 resourceScheme=notebook,应改用 notebookType=my-custom-type 精确匹配

四、监听并拦截执行请求

通过实现 NotebookKernel.executeAllCells、executeCell 等方法,可在代码执行前注入预处理逻辑(如自动补全 magic 命令、注入调试钩子)或执行后解析输出结构(如提取错误并高亮行号)。

1、在 Kernel 实现类中覆盖 executeAllCells 方法,遍历 notebook.getCells() 获取全部 NotebookCell。

2、对每个 cell,调用 kernel.executeCell 并传入 new NotebookCellExecution(cell) 实例。

3、在 executeCell 内部,先调用 execution.start(),再使用 execSync 或 spawn 启动外部进程处理 cell.document.getText()。

4、必须在 execution.end() 调用前完成所有 output.append() 操作,否则输出将丢失

text=ZqhQzanResources