0

0

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

P粉986688829

P粉986688829

发布时间:2026-01-01 12:43:39

|

107人浏览过

|

来源于php中文网

原创

需直接使用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 模块

PixVerse
PixVerse

PixVerse是一款强大的AI视频生成工具,可以轻松地将多种输入转化为令人惊叹的视频。

下载

三、扩展 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() 操作,否则输出将丢失

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

82

2025.09.10

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

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

761

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1570

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

651

2023.11.24

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

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

精品课程

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

共34课时 | 2.7万人学习

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

共98课时 | 8.4万人学习

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

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