如何为VSCode WorkspaceEdit实现JSON文档的最小编辑？

我正按照《VSCode自定义编辑器扩展指南》开发一款基于JSON存储数据的自定义编辑器。学习示例代码时，看到这段注释：

// Just replace the entire document every time for this example extension.
// A more complete extension should compute minimal edits instead.

（代码来源：vscode-extension-samples仓库的custom-editor-sample/src/catScratchEditor.ts）

我想了解三个问题：

1. 具体该如何实现最小编辑操作？
2. VSCode设置编辑器是JSON文件的GUI界面，是否存在能将JSON变更转换为文档编辑的API？
3. 有没有支持红绿树结构、可关联JSON数据与源码位置的JSON解析器？

一、实现JSON文档的最小编辑操作 #

要实现最小编辑，核心是对比新旧JSON结构差异，生成精准的文本编辑操作而非全量替换，步骤如下：

• 保留原始格式：解析JSON时不要自动格式化，需保留原有的缩进、换行甚至注释（如果支持），这依赖能追踪源码位置的解析器。
• 定位差异节点：对比新旧JSON对象，定位到具体需要修改的键值对、数组元素：
  • 新增/删除键：找到父对象在文本中的位置，插入或删除对应行。
  • 修改键值：定位到该值在文本中的起止位置，替换为新内容。
  • 数组元素变更：定位到数组的对应索引位置，执行精准的插入/删除/替换。
• 生成VSCode增量编辑：使用vscode.WorkspaceEdit创建编辑操作，通过replace方法指定具体的vscode.Range范围和新内容，而非替换整个文档。

示例代码片段：

import * as vscode from 'vscode';

// 假设已通过解析器获取到目标节点的起止位置startPos、endPos
const edit = new vscode.WorkspaceEdit();
const targetRange = new vscode.Range(startPos, endPos);
edit.replace(document.uri, targetRange, updatedValue);
await vscode.workspace.applyEdit(edit);

二、VSCode内置的JSON编辑API #

VSCode提供了专门处理JSON文档的内置API，可直接将JSON数据变更转换为文档增量编辑：

• 借助vscode.languages.getDocumentSymbols获取JSON文档的符号结构，快速定位到目标节点的文本位置。
• 使用VSCode官方的JSONLanguageService，可以直接解析JSON文档并获取每个节点的位置信息，基于此生成精准的编辑操作，无需手动计算差异。
• VSCode设置编辑器的底层正是依赖这些内置JSON语言服务，实现GUI操作到JSON文档的同步更新。

三、支持位置追踪的JSON解析器 #

以下工具可满足关联JSON数据与源码位置的需求，部分还支持红绿树结构：

• jsonc-parser：VSCode官方使用的解析器，支持带注释的JSON（JSONC），能返回每个节点的行、列、偏移量等位置信息，完全适配VSCode的文本范围需求。
• immutable-js：提供不可变的红绿树数据结构，结合位置追踪解析器，可高效对比新旧JSON的差异，快速定位最小变更点。
• ajv：虽主打JSON验证，但开启位置追踪功能后，也能获取节点的源码位置信息。

其中jsonc-parser是最推荐的选择，它和VSCode生态完全兼容，能直接处理编辑器中的JSONC文件，API简洁易用。

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