Skip to content

Commit 329e5bc

Browse files
ntroghntrogh
committed
Merge branch 'main' of https://github.com/microsoft/vscode-docs into sync-main-branch
2 parents 53e000d + 27e6951 commit 329e5bc

File tree

254 files changed

+2368
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

254 files changed

+2368
-3
lines changed

‎api/advanced-topics/extension-host.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ ContentId: 106AA11C-DB26-493A-9E3C-16F513B2AEC8
88
<<<<<<< HEAD
99
<<<<<<< HEAD
1010
<<<<<<< HEAD
11+
<<<<<<< HEAD
1112
DateApproved: 10/03/2024
1213
=======
1314
DateApproved: 10/29/2024
@@ -30,6 +31,9 @@ DateApproved: 10/29/2024
3031
=======
3132
DateApproved: 10/29/2024
3233
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
34+
=======
35+
DateApproved: 10/29/2024
36+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
3337

3438
# Summarize the whole topic in less than 300 characters for SEO purpose
3539
MetaDescription: The Visual Studio Code Extension Host is responsible for managing extensions and ensuring the stability and performance of Visual Studio Code.

‎api/advanced-topics/remote-extensions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ ContentId: 5c708951-e566-42db-9d97-e9715d95cdd1
77
<<<<<<< HEAD
88
<<<<<<< HEAD
99
<<<<<<< HEAD
10+
<<<<<<< HEAD
1011
DateApproved: 10/03/2024
1112
=======
1213
DateApproved: 10/29/2024
@@ -29,6 +30,9 @@ DateApproved: 10/29/2024
2930
=======
3031
DateApproved: 10/29/2024
3132
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
33+
=======
34+
DateApproved: 10/29/2024
35+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
3236

3337
# Summarize the whole topic in less than 300 characters for SEO purpose
3438
MetaDescription: A guide to adding Visual Studio Code Remote Development and GitHub Codespaces support to extensions

‎api/advanced-topics/tslint-eslint-migration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ ContentId: f00c4913-58e3-4a61-aa42-e769c3430906
77
<<<<<<< HEAD
88
<<<<<<< HEAD
99
<<<<<<< HEAD
10+
<<<<<<< HEAD
1011
DateApproved: 10/03/2024
1112
=======
1213
DateApproved: 10/29/2024
@@ -29,6 +30,9 @@ DateApproved: 10/29/2024
2930
=======
3031
DateApproved: 10/29/2024
3132
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
33+
=======
34+
DateApproved: 10/29/2024
35+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
3236

3337
# Summarize the whole topic in less than 300 characters for SEO purpose
3438
MetaDescription: A guide to migrating extension projects from the TSLint linter to ESLint.

‎api/advanced-topics/using-proposed-api.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ ContentId: f4d4e9e0-8901-405c-aaf5-faa16c32588b
88
<<<<<<< HEAD
99
<<<<<<< HEAD
1010
<<<<<<< HEAD
11+
<<<<<<< HEAD
1112
DateApproved: 10/03/2024
1213
=======
1314
DateApproved: 10/29/2024
@@ -30,6 +31,9 @@ DateApproved: 10/29/2024
3031
=======
3132
DateApproved: 10/29/2024
3233
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
34+
=======
35+
DateApproved: 10/29/2024
36+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
3337

3438
# Summarize the whole topic in less than 300 characters for SEO purpose
3539
MetaDescription: Use Visual Studio Code's Proposed API

‎api/extension-capabilities/common-capabilities.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ ContentId: 9c48dfbf-e49d-4f33-aadc-5ebf06d5dde0
88
<<<<<<< HEAD
99
<<<<<<< HEAD
1010
<<<<<<< HEAD
11+
<<<<<<< HEAD
1112
DateApproved: 10/03/2024
1213
=======
1314
DateApproved: 10/29/2024
@@ -30,6 +31,9 @@ DateApproved: 10/29/2024
3031
=======
3132
DateApproved: 10/29/2024
3233
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
34+
=======
35+
DateApproved: 10/29/2024
36+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
3337

3438
# Summarize the whole topic in less than 300 characters for SEO purpose
3539
MetaDescription: Common capabilities that Visual Studio Code extensions (plug-ins) can take advantage of
@@ -71,6 +75,7 @@ An extension can register custom Context Menu items that will be displayed in di
7175
<<<<<<< HEAD
7276
<<<<<<< HEAD
7377
<<<<<<< HEAD
78+
<<<<<<< HEAD
7479
There are four options for storing data:
7580
=======
7681
There are five options for storing data:
@@ -93,6 +98,9 @@ There are five options for storing data:
9398
=======
9499
There are five options for storing data:
95100
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
101+
=======
102+
There are five options for storing data:
103+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
96104
97105
- [`ExtensionContext.workspaceState`](/api/references/vscode-api#ExtensionContext.workspaceState): A workspace storage where you can write key/value pairs. VS Code manages the storage and will restore it when the same workspace is opened again.
98106
- [`ExtensionContext.globalState`](/api/references/vscode-api#ExtensionContext.globalState): A global storage where you can write key/value pairs. VS Code manages the storage and will restore it for each extension activation. You can selectively synchronize key/value pairs in global storage by setting the keys for sync using `setKeysForSync` method on `globalState`.
@@ -105,6 +113,10 @@ There are five options for storing data:
105113
<<<<<<< HEAD
106114
<<<<<<< HEAD
107115
<<<<<<< HEAD
116+
<<<<<<< HEAD
117+
=======
118+
- [`ExtensionContext.secrets`](/api/references/vscode-api#ExtensionContext.secrets): A global storage for secrets (or any information that is sensitive) that will be encrypted. These are not synced across machines. For VS Code desktop, this leverages Electron's [safeStorage API](https://www.electronjs.org/docs/latest/api/safe-storage). For VS Code for the Web, this uses a Double Key Encryption (DKE) implementation.
119+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
108120
=======
109121
- [`ExtensionContext.secrets`](/api/references/vscode-api#ExtensionContext.secrets): A global storage for secrets (or any information that is sensitive) that will be encrypted. These are not synced across machines. For VS Code desktop, this leverages Electron's [safeStorage API](https://www.electronjs.org/docs/latest/api/safe-storage). For VS Code for the Web, this uses a Double Key Encryption (DKE) implementation.
110122
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65

‎api/extension-capabilities/extending-workbench.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ ContentId: e0d5bd37-f020-4235-ad81-c977baaeb24f
88
<<<<<<< HEAD
99
<<<<<<< HEAD
1010
<<<<<<< HEAD
11+
<<<<<<< HEAD
1112
DateApproved: 10/03/2024
1213
=======
1314
DateApproved: 10/29/2024
@@ -30,6 +31,9 @@ DateApproved: 10/29/2024
3031
=======
3132
DateApproved: 10/29/2024
3233
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
34+
=======
35+
DateApproved: 10/29/2024
36+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
3337

3438
# Summarize the whole topic in less than 300 characters for SEO purpose
3539
MetaDescription: Explain how to extend Visual Studio Code's workbench area with custom UI components

‎api/extension-capabilities/overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ ContentId: d22675fc-6609-43f2-a66b-8f2a52597195
88
<<<<<<< HEAD
99
<<<<<<< HEAD
1010
<<<<<<< HEAD
11+
<<<<<<< HEAD
1112
DateApproved: 10/03/2024
1213
=======
1314
DateApproved: 10/29/2024
@@ -30,6 +31,9 @@ DateApproved: 10/29/2024
3031
=======
3132
DateApproved: 10/29/2024
3233
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
34+
=======
35+
DateApproved: 10/29/2024
36+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
3337

3438
# Summarize the whole topic in less than 300 characters for SEO purpose
3539
MetaDescription: Learn the details of what's possible with Visual Studio Code's rich extension (plug-in) API.

‎api/extension-capabilities/theming.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ ContentId: 37b6ae0a-d1b5-48b6-9bd4-9b50ef11d573
88
<<<<<<< HEAD
99
<<<<<<< HEAD
1010
<<<<<<< HEAD
11+
<<<<<<< HEAD
1112
DateApproved: 10/03/2024
1213
=======
1314
DateApproved: 10/29/2024
@@ -30,6 +31,9 @@ DateApproved: 10/29/2024
3031
=======
3132
DateApproved: 10/29/2024
3233
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
34+
=======
35+
DateApproved: 10/29/2024
36+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
3337

3438
# Summarize the whole topic in less than 300 characters for SEO purpose
3539
MetaDescription: Learn how to add custom themes for colors and icons in Visual Studio Code.

‎api/extension-guides/chat-tutorial.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ ContentId: bea1d4c5-71e5-4b27-ac1e-fa9b59886dab
88
<<<<<<< HEAD
99
<<<<<<< HEAD
1010
<<<<<<< HEAD
11+
<<<<<<< HEAD
1112
DateApproved: 10/03/2024
1213
=======
1314
DateApproved: 10/29/2024
@@ -30,6 +31,9 @@ DateApproved: 10/29/2024
3031
=======
3132
DateApproved: 10/29/2024
3233
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
34+
=======
35+
DateApproved: 10/29/2024
36+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
3337

3438
# Summarize the whole topic in less than 300 characters for SEO purpose
3539
MetaDescription: Tutorial that walks you through creating a GitHub Copilot chat participant in VS Code by using the Chat API.
@@ -113,6 +117,7 @@ Finally, setting `isSticky: true` will automatically prepend the participant nam
113117
<<<<<<< HEAD
114118
<<<<<<< HEAD
115119
<<<<<<< HEAD
120+
<<<<<<< HEAD
116121
## Step 3: Craft the prompt and select the model
117122

118123
Now that the participant is registered, you can start implementing the logic for the code tutor. In the `extension.ts` file, you will define a prompt and select the model for the requests.
@@ -149,6 +154,11 @@ Now that the participant is registered, you can start implementing the logic for
149154
=======
150155
## Step 3: Craft the prompt
151156

157+
Now that the participant is registered, you can start implementing the logic for the code tutor. In the `extension.ts` file, you will define a prompt for the requests.
158+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
159+
=======
160+
## Step 3: Craft the prompt
161+
152162
Now that the participant is registered, you can start implementing the logic for the code tutor. In the `extension.ts` file, you will define a prompt for the requests.
153163
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
154164
@@ -174,6 +184,7 @@ const BASE_PROMPT = 'You are a helpful code tutor. Your job is to teach the user
174184
<<<<<<< HEAD
175185
<<<<<<< HEAD
176186
<<<<<<< HEAD
187+
<<<<<<< HEAD
177188
You also need to select the model for the requests. gpt-4o is recommended since it is fast and high quality.
178189

179190
```ts
@@ -216,6 +227,11 @@ Now that the prompt is selected, you need to implement the request handler. This
216227
=======
217228
## Step 4: Implement the request handler
218229

230+
Now that the prompt is selected, you need to implement the request handler. This is what will process the user's chat request. You will define the request handler, perform logic for processing the request, and return a response to the user.
231+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
232+
=======
233+
## Step 4: Implement the request handler
234+
219235
Now that the prompt is selected, you need to implement the request handler. This is what will process the user's chat request. You will define the request handler, perform logic for processing the request, and return a response to the user.
220236
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
221237
@@ -236,6 +252,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
236252
<<<<<<< HEAD
237253
<<<<<<< HEAD
238254
<<<<<<< HEAD
255+
<<<<<<< HEAD
239256
Within the body of this handler, initialize the prompt and model. Check that the model returned successfully.
240257
=======
241258
Within the body of this handler, initialize the prompt and a `messages` array with the prompt. Then, send in what the user typed in the chat box. You can access this through `request.prompt`.
@@ -270,6 +287,11 @@ Send the request using `request.model.sendRequest`, which will send the request
270287
=======
271288
Within the body of this handler, initialize the prompt and a `messages` array with the prompt. Then, send in what the user typed in the chat box. You can access this through `request.prompt`.
272289

290+
Send the request using `request.model.sendRequest`, which will send the request using the currently selected model. Finally, stream the response to the user.
291+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
292+
=======
293+
Within the body of this handler, initialize the prompt and a `messages` array with the prompt. Then, send in what the user typed in the chat box. You can access this through `request.prompt`.
294+
273295
Send the request using `request.model.sendRequest`, which will send the request using the currently selected model. Finally, stream the response to the user.
274296
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
275297
@@ -283,6 +305,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
283305
<<<<<<< HEAD
284306
<<<<<<< HEAD
285307
<<<<<<< HEAD
308+
<<<<<<< HEAD
286309
<<<<<<< HEAD
287310
// initialize the prompt and model
288311
let prompt = BASE_PROMPT;
@@ -340,6 +363,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
340363
=======
341364
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
342365
=======
366+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
367+
=======
343368
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
344369
// initialize the prompt
345370
let prompt = BASE_PROMPT;
@@ -364,6 +389,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
364389
<<<<<<< HEAD
365390
<<<<<<< HEAD
366391
<<<<<<< HEAD
392+
<<<<<<< HEAD
393+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
394+
=======
367395
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
368396
=======
369397
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -399,6 +427,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
399427
<<<<<<< HEAD
400428
<<<<<<< HEAD
401429
<<<<<<< HEAD
430+
<<<<<<< HEAD
402431
<<<<<<< HEAD
403432
// initialize the prompt and model
404433
let prompt = BASE_PROMPT;
@@ -434,6 +463,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
434463
=======
435464
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
436465
=======
466+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
467+
=======
437468
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
438469
// initialize the prompt
439470
let prompt = BASE_PROMPT;
@@ -458,6 +489,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
458489
<<<<<<< HEAD
459490
<<<<<<< HEAD
460491
<<<<<<< HEAD
492+
<<<<<<< HEAD
493+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
494+
=======
461495
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
462496
=======
463497
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -516,6 +550,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
516550
<<<<<<< HEAD
517551
<<<<<<< HEAD
518552
<<<<<<< HEAD
553+
<<<<<<< HEAD
519554
<<<<<<< HEAD
520555
// initialize the prompt and model
521556
let prompt = BASE_PROMPT;
@@ -566,6 +601,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
566601
=======
567602
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
568603
=======
604+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
605+
=======
569606
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
570607
// initialize the prompt
571608
let prompt = BASE_PROMPT;
@@ -605,6 +642,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
605642
<<<<<<< HEAD
606643
<<<<<<< HEAD
607644
<<<<<<< HEAD
645+
<<<<<<< HEAD
646+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
647+
=======
608648
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
609649
=======
610650
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -676,6 +716,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
676716
<<<<<<< HEAD
677717
<<<<<<< HEAD
678718
<<<<<<< HEAD
719+
<<<<<<< HEAD
679720
<<<<<<< HEAD
680721
// initialize the prompt and model
681722
=======
@@ -696,6 +737,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
696737
=======
697738
// initialize the prompt
698739
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
740+
=======
741+
// initialize the prompt
742+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
699743
=======
700744
// initialize the prompt
701745
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -711,6 +755,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
711755
<<<<<<< HEAD
712756
<<<<<<< HEAD
713757
<<<<<<< HEAD
758+
<<<<<<< HEAD
714759
<<<<<<< HEAD
715760
const [model] = await vscode.lm.selectChatModels(MODEL_SELECTOR);
716761

@@ -758,6 +803,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
758803
=======
759804
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
760805
=======
806+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
807+
=======
761808
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
762809
// initialize the messages array with the prompt
763810
const messages = [
@@ -794,6 +841,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
794841
<<<<<<< HEAD
795842
<<<<<<< HEAD
796843
<<<<<<< HEAD
844+
<<<<<<< HEAD
845+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
846+
=======
797847
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
798848
=======
799849
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65

0 commit comments

Comments
 (0)