利用VS Code的Git扩展API进行二次开发-VSCode-PHP中文网

利用VS Code的Git扩展API进行二次开发

P粉986688829

发布： 2025-11-28 17:35:02

原创

560人浏览过

VS Code Git API是供插件开发使用的TypeScript接口，需在扩展中声明依赖vscode.git，通过getExtension获取API实例，支持仓库管理、提交、拉取、推送等操作，适用于构建编辑器内Git自动化工具。

利用vs code的git扩展api进行二次开发

如果你已经熟悉 VS Code 和 Git 的基本操作，想通过编程方式与 Git 交互，VS Code 提供了官方的 Git API 扩展接口，允许你基于它进行二次开发。这个 API 并不是直接暴露给用户在代码中调用的 npm 包，而是以插件（Extension）的形式，供其他 VS Code 扩展使用。

了解 VS Code Git API 的本质　3>

VS Code 自带的 Git 插件（vscode.git）提供了一个可被其他扩展调用的 API。这个 API 不是公开文档化的 REST 接口，而是一个 TypeScript 接口，只能在开发 VS Code 插件时通过依赖引用获得。

要使用该 API，你的扩展必须声明对 vscode.git 的依赖，并在运行时获取其导出的服务对象。

API 来源于内置的 vscode.git 扩展
只能用于开发其他 VS Code 扩展（即写 .vsix 插件）
无法在普通 Node.js 程序或网页中直接调用

如何在扩展中启用 Git API

要在你的 VS Code 插件项目中使用 Git API，需完成以下步骤：

1. 配置 package.json 依赖

在你的扩展的 package.json 中添加对 vscode.git 的依赖声明：

"extensionDependencies": [
  "vscode.git"
]

登录后复制

2. 获取 Git API 实例

在激活扩展的主文件（如 extension.ts）中，通过 getExtension 获取 Git 插件实例，并调用其 getAPI() 方法：

JTopCms建站系统

JTopCMS基于JavaEE自主研发，是用于管理站群内容的国产开源软件(CMS)，能高效便捷地进行内容采编，审核，模板制作，用户交互以及文件等资源的维护。安全，稳定，易扩展，支持国产中间件及数据库，适合建设政府，教育以及企事业单位的站群系统。系统特色 1. 基于 JAVA 标准自主研发，支持主流国产信创环境，国产数据库以及国产中间件。安全，稳定，经过多次政务与企事业单位项目长期检验，顺利通过

查看详情

import * as vscode from 'vscode';
<p>export async function activate(context: vscode.ExtensionContext) {
const gitExtension = vscode.extensions.getExtension<{ getAPI(version: number): any }>('vscode.git');
if (!gitExtension) {
vscode.window.showErrorMessage('Git extension not available');
return;
}</p><p>const gitAPI = gitExtension.exports.getAPI(1);</p><p>// 现在可以使用 gitAPI 操作仓库
const [repository] = gitAPI.repositories;
if (repository) {
await repository.fetch();
const status = repository.state;
console.log('Branch:', status.head);
}
}

登录后复制

常用功能与操作示例

通过 gitAPI 可访问当前所有受管仓库，并执行常见 Git 操作。

获取所有仓库：gitAPI.repositories
拉取代码：await repository.pull()
推送代码：await repository.push()
提交更改：await repository.commit('提交信息')
监听状态变化：使用 repository.state.onDidChange
获取暂存区文件：repository.state.indexChanges

例如，注册一个命令来自动提交所有变更：

context.subscriptions.push(
  vscode.commands.registerCommand('myext.commitAll', async () => {
    const [repo] = gitAPI.repositories;
    if (!repo) return;
<pre class="brush:php;toolbar:false;"><pre class="brush:php;toolbar:false;">await repo.add(repo.state.workingTreeChanges.map(c => c.resourceUri));
await repo.commit('自动提交 via myext');

登录后复制

}) );