VSCode语言扩展实现单文件Quick Diff：自定义URI Scheme作用及配置

为什么要注册自定义URI scheme的TextDocumentContentProvider #

VSCode的Quick Diff依赖两个内容源：当前编辑的文件和基准对比文件。TextDocumentContentProvider的核心作用是向编辑器提供基准文件的内容，但如果你的基准文件不是常规本地文件（或是需要扩展自定义逻辑获取的文件），就需要通过自定义URI scheme来标识它。

注册自定义scheme（比如my-lang-diff://）是VSCode的机制约定：当你的QuickDiffProvider返回这个scheme的URI时，编辑器会自动调用你注册的ContentProvider来获取对应的基准内容。简单说，这是让VSCode“找到”你提供的对比基准的唯一方式。

跟踪文件变更的必要操作 #

• 监听当前文件的编辑事件
  通过vscode.workspace.onDidChangeTextDocument监听目标文件的内容变化，每次变更触发Quick Diff刷新，保证对比状态实时更新：

  vscode.workspace.onDidChangeTextDocument(event => {
    if (event.document.uri.fsPath === 你的目标文件路径) {
      vscode.commands.executeCommand('workbench.action.editor.refreshQuickDiff');
    }
  });
  

• 正确实现QuickDiffProvider的基准URI返回
  provideOriginalResource方法只需要针对你的单个目标文件，返回自定义scheme的基准URI：

  provideOriginalResource(document: vscode.TextDocument): vscode.Uri | undefined {
    if (document.uri.fsPath === 你的特定文件路径) {
      return vscode.Uri.parse('my-lang-diff://reference-file');
    }
    return undefined;
  }
  

• 在ContentProvider中返回基准内容
  provideTextDocumentContent方法根据自定义URI读取并返回基准文件的内容，比如读取本地固定路径的文件：

  async provideTextDocumentContent(uri: vscode.Uri): Promise<string> {
    // 根据uri标识返回对应的基准文件内容，这里示例读取本地文件
    const referencePath = 你的基准文件本地路径;
    return await vscode.workspace.fs.readFile(vscode.Uri.file(referencePath)).then(buf => buf.toString());
  }
  

• 监听基准文件的变更（可选）
  如果基准文件可能被修改，同样需要监听它的变化，触发Quick Diff刷新，确保对比的是最新基准。

简化实现的关键 #

因为你只支持单个文件，完全可以砍掉示例中复杂的仓库、文件夹逻辑：

• 无需创建SourceControl实例，仅保留TextDocumentContentProvider和QuickDiffProvider即可。
• 通过硬编码或扩展配置指定目标文件和基准文件的路径，不用做动态扫描。

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