development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-07-02 15:59:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Git - clarify git extension API usage (#192139)

Browse Source 
* Git - clarify git extension API usage

* Fixed white space
This commit is contained in:
Ladislau Szomoru 2023-09-04 15:40:56 +02:00 committed by GitHub
parent 0f816a3513
commit 4a3ed95527
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
extensions/git/README.md
View File

@ -14,7 +14,13 @@ The Git extension exposes an API, reachable by any other extension.
2. Include `git.d.ts` in your extension's compilation.
3. Get a hold of the API with the following snippet:
```ts
const gitExtension = vscode.extensions.getExtension<GitExtension>('vscode.git').exports;
const git = gitExtension.getAPI(1);
```
```ts
const gitExtension = vscode.extensions.getExtension<GitExtension>('vscode.git').exports;
const git = gitExtension.getAPI(1);
```
**Note:** To ensure that the `vscode.git` extension is activated before your extension, add `extensionDependencies` ([docs](https://code.visualstudio.com/api/references/extension-manifest)) into the `package.json` of your extension:
```json
"extensionDependencies": [
"vscode.git"
]
```