Skip to content

Commit 4a3ed95

Browse files
authored
Git - clarify git extension API usage (microsoft#192139)
* Git - clarify git extension API usage * Fixed white space
1 parent 0f816a3 commit 4a3ed95

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

extensions/git/README.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ The Git extension exposes an API, reachable by any other extension.
1414
2. Include `git.d.ts` in your extension's compilation.
1515
3. Get a hold of the API with the following snippet:
1616

17-
```ts
18-
const gitExtension = vscode.extensions.getExtension<GitExtension>('vscode.git').exports;
19-
const git = gitExtension.getAPI(1);
20-
```
17+
```ts
18+
const gitExtension = vscode.extensions.getExtension<GitExtension>('vscode.git').exports;
19+
const git = gitExtension.getAPI(1);
20+
```
21+
**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:
22+
```json
23+
"extensionDependencies": [
24+
"vscode.git"
25+
]
26+
```

0 commit comments

Comments
 (0)