Skip to content

Commit b4cb927

Browse files
ntroghntrogh
committed
Refresh from public docs
1 parent 02e6d21 commit b4cb927

File tree

253 files changed

+2365
-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.

253 files changed

+2365
-3
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ ContentId: 106AA11C-DB26-493A-9E3C-16F513B2AEC8
77
<<<<<<< HEAD
88
<<<<<<< HEAD
99
<<<<<<< HEAD
10+
<<<<<<< HEAD
1011
DateApproved: 10/03/2024
1112
=======
1213
DateApproved: 10/29/2024
@@ -26,6 +27,9 @@ DateApproved: 10/29/2024
2627
=======
2728
DateApproved: 10/29/2024
2829
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
30+
=======
31+
DateApproved: 10/29/2024
32+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2933

3034
# Summarize the whole topic in less than 300 characters for SEO purpose
3135
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
@@ -6,6 +6,7 @@ ContentId: 5c708951-e566-42db-9d97-e9715d95cdd1
66
<<<<<<< HEAD
77
<<<<<<< HEAD
88
<<<<<<< HEAD
9+
<<<<<<< HEAD
910
DateApproved: 10/03/2024
1011
=======
1112
DateApproved: 10/29/2024
@@ -25,6 +26,9 @@ DateApproved: 10/29/2024
2526
=======
2627
DateApproved: 10/29/2024
2728
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
29+
=======
30+
DateApproved: 10/29/2024
31+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2832

2933
# Summarize the whole topic in less than 300 characters for SEO purpose
3034
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
@@ -6,6 +6,7 @@ ContentId: f00c4913-58e3-4a61-aa42-e769c3430906
66
<<<<<<< HEAD
77
<<<<<<< HEAD
88
<<<<<<< HEAD
9+
<<<<<<< HEAD
910
DateApproved: 10/03/2024
1011
=======
1112
DateApproved: 10/29/2024
@@ -25,6 +26,9 @@ DateApproved: 10/29/2024
2526
=======
2627
DateApproved: 10/29/2024
2728
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
29+
=======
30+
DateApproved: 10/29/2024
31+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2832

2933
# Summarize the whole topic in less than 300 characters for SEO purpose
3034
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
@@ -7,6 +7,7 @@ ContentId: f4d4e9e0-8901-405c-aaf5-faa16c32588b
77
<<<<<<< HEAD
88
<<<<<<< HEAD
99
<<<<<<< HEAD
10+
<<<<<<< HEAD
1011
DateApproved: 10/03/2024
1112
=======
1213
DateApproved: 10/29/2024
@@ -26,6 +27,9 @@ DateApproved: 10/29/2024
2627
=======
2728
DateApproved: 10/29/2024
2829
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
30+
=======
31+
DateApproved: 10/29/2024
32+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2933

3034
# Summarize the whole topic in less than 300 characters for SEO purpose
3135
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
@@ -7,6 +7,7 @@ ContentId: 9c48dfbf-e49d-4f33-aadc-5ebf06d5dde0
77
<<<<<<< HEAD
88
<<<<<<< HEAD
99
<<<<<<< HEAD
10+
<<<<<<< HEAD
1011
DateApproved: 10/03/2024
1112
=======
1213
DateApproved: 10/29/2024
@@ -26,6 +27,9 @@ DateApproved: 10/29/2024
2627
=======
2728
DateApproved: 10/29/2024
2829
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
30+
=======
31+
DateApproved: 10/29/2024
32+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2933

3034
# Summarize the whole topic in less than 300 characters for SEO purpose
3135
MetaDescription: Common capabilities that Visual Studio Code extensions (plug-ins) can take advantage of
@@ -66,6 +70,7 @@ An extension can register custom Context Menu items that will be displayed in di
6670
<<<<<<< HEAD
6771
<<<<<<< HEAD
6872
<<<<<<< HEAD
73+
<<<<<<< HEAD
6974
There are four options for storing data:
7075
=======
7176
There are five options for storing data:
@@ -85,6 +90,9 @@ There are five options for storing data:
8590
=======
8691
There are five options for storing data:
8792
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
93+
=======
94+
There are five options for storing data:
95+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
8896
8997
- [`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.
9098
- [`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`.
@@ -96,6 +104,10 @@ There are five options for storing data:
96104
<<<<<<< HEAD
97105
<<<<<<< HEAD
98106
<<<<<<< HEAD
107+
<<<<<<< HEAD
108+
=======
109+
- [`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.
110+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
99111
=======
100112
- [`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.
101113
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ ContentId: e0d5bd37-f020-4235-ad81-c977baaeb24f
77
<<<<<<< HEAD
88
<<<<<<< HEAD
99
<<<<<<< HEAD
10+
<<<<<<< HEAD
1011
DateApproved: 10/03/2024
1112
=======
1213
DateApproved: 10/29/2024
@@ -26,6 +27,9 @@ DateApproved: 10/29/2024
2627
=======
2728
DateApproved: 10/29/2024
2829
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
30+
=======
31+
DateApproved: 10/29/2024
32+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2933

3034
# Summarize the whole topic in less than 300 characters for SEO purpose
3135
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
@@ -7,6 +7,7 @@ ContentId: d22675fc-6609-43f2-a66b-8f2a52597195
77
<<<<<<< HEAD
88
<<<<<<< HEAD
99
<<<<<<< HEAD
10+
<<<<<<< HEAD
1011
DateApproved: 10/03/2024
1112
=======
1213
DateApproved: 10/29/2024
@@ -26,6 +27,9 @@ DateApproved: 10/29/2024
2627
=======
2728
DateApproved: 10/29/2024
2829
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
30+
=======
31+
DateApproved: 10/29/2024
32+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2933

3034
# Summarize the whole topic in less than 300 characters for SEO purpose
3135
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
@@ -7,6 +7,7 @@ ContentId: 37b6ae0a-d1b5-48b6-9bd4-9b50ef11d573
77
<<<<<<< HEAD
88
<<<<<<< HEAD
99
<<<<<<< HEAD
10+
<<<<<<< HEAD
1011
DateApproved: 10/03/2024
1112
=======
1213
DateApproved: 10/29/2024
@@ -26,6 +27,9 @@ DateApproved: 10/29/2024
2627
=======
2728
DateApproved: 10/29/2024
2829
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
30+
=======
31+
DateApproved: 10/29/2024
32+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2933

3034
# Summarize the whole topic in less than 300 characters for SEO purpose
3135
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
@@ -7,6 +7,7 @@ ContentId: bea1d4c5-71e5-4b27-ac1e-fa9b59886dab
77
<<<<<<< HEAD
88
<<<<<<< HEAD
99
<<<<<<< HEAD
10+
<<<<<<< HEAD
1011
DateApproved: 10/03/2024
1112
=======
1213
DateApproved: 10/29/2024
@@ -26,6 +27,9 @@ DateApproved: 10/29/2024
2627
=======
2728
DateApproved: 10/29/2024
2829
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
30+
=======
31+
DateApproved: 10/29/2024
32+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2933

3034
# Summarize the whole topic in less than 300 characters for SEO purpose
3135
MetaDescription: Tutorial that walks you through creating a GitHub Copilot chat participant in VS Code by using the Chat API.
@@ -108,6 +112,7 @@ Finally, setting `isSticky: true` will automatically prepend the participant nam
108112
<<<<<<< HEAD
109113
<<<<<<< HEAD
110114
<<<<<<< HEAD
115+
<<<<<<< HEAD
111116
## Step 3: Craft the prompt and select the model
112117

113118
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.
@@ -139,6 +144,11 @@ Now that the participant is registered, you can start implementing the logic for
139144
=======
140145
## Step 3: Craft the prompt
141146

147+
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.
148+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
149+
=======
150+
## Step 3: Craft the prompt
151+
142152
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.
143153
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
144154
@@ -163,6 +173,7 @@ const BASE_PROMPT = 'You are a helpful code tutor. Your job is to teach the user
163173
<<<<<<< HEAD
164174
<<<<<<< HEAD
165175
<<<<<<< HEAD
176+
<<<<<<< HEAD
166177
You also need to select the model for the requests. gpt-4o is recommended since it is fast and high quality.
167178

168179
```ts
@@ -200,6 +211,11 @@ Now that the prompt is selected, you need to implement the request handler. This
200211
=======
201212
## Step 4: Implement the request handler
202213

214+
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.
215+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
216+
=======
217+
## Step 4: Implement the request handler
218+
203219
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.
204220
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
205221
@@ -219,6 +235,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
219235
<<<<<<< HEAD
220236
<<<<<<< HEAD
221237
<<<<<<< HEAD
238+
<<<<<<< HEAD
222239
Within the body of this handler, initialize the prompt and model. Check that the model returned successfully.
223240
=======
224241
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`.
@@ -248,6 +265,11 @@ Send the request using `request.model.sendRequest`, which will send the request
248265
=======
249266
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`.
250267

268+
Send the request using `request.model.sendRequest`, which will send the request using the currently selected model. Finally, stream the response to the user.
269+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
270+
=======
271+
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`.
272+
251273
Send the request using `request.model.sendRequest`, which will send the request using the currently selected model. Finally, stream the response to the user.
252274
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
253275
@@ -260,6 +282,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
260282
<<<<<<< HEAD
261283
<<<<<<< HEAD
262284
<<<<<<< HEAD
285+
<<<<<<< HEAD
263286
<<<<<<< HEAD
264287
// initialize the prompt and model
265288
let prompt = BASE_PROMPT;
@@ -315,6 +338,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
315338
=======
316339
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
317340
=======
341+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
342+
=======
318343
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
319344
// initialize the prompt
320345
let prompt = BASE_PROMPT;
@@ -338,6 +363,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
338363
<<<<<<< HEAD
339364
<<<<<<< HEAD
340365
<<<<<<< HEAD
366+
<<<<<<< HEAD
367+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
368+
=======
341369
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
342370
=======
343371
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -370,6 +398,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
370398
<<<<<<< HEAD
371399
<<<<<<< HEAD
372400
<<<<<<< HEAD
401+
<<<<<<< HEAD
373402
<<<<<<< HEAD
374403
// initialize the prompt and model
375404
let prompt = BASE_PROMPT;
@@ -403,6 +432,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
403432
=======
404433
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
405434
=======
435+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
436+
=======
406437
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
407438
// initialize the prompt
408439
let prompt = BASE_PROMPT;
@@ -426,6 +457,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
426457
<<<<<<< HEAD
427458
<<<<<<< HEAD
428459
<<<<<<< HEAD
460+
<<<<<<< HEAD
461+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
462+
=======
429463
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
430464
=======
431465
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -481,6 +515,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
481515
<<<<<<< HEAD
482516
<<<<<<< HEAD
483517
<<<<<<< HEAD
518+
<<<<<<< HEAD
484519
<<<<<<< HEAD
485520
// initialize the prompt and model
486521
let prompt = BASE_PROMPT;
@@ -529,6 +564,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
529564
=======
530565
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
531566
=======
567+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
568+
=======
532569
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
533570
// initialize the prompt
534571
let prompt = BASE_PROMPT;
@@ -567,6 +604,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
567604
<<<<<<< HEAD
568605
<<<<<<< HEAD
569606
<<<<<<< HEAD
607+
<<<<<<< HEAD
608+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
609+
=======
570610
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
571611
=======
572612
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -635,6 +675,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
635675
<<<<<<< HEAD
636676
<<<<<<< HEAD
637677
<<<<<<< HEAD
678+
<<<<<<< HEAD
638679
<<<<<<< HEAD
639680
// initialize the prompt and model
640681
=======
@@ -652,6 +693,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
652693
=======
653694
// initialize the prompt
654695
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
696+
=======
697+
// initialize the prompt
698+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
655699
=======
656700
// initialize the prompt
657701
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -666,6 +710,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
666710
<<<<<<< HEAD
667711
<<<<<<< HEAD
668712
<<<<<<< HEAD
713+
<<<<<<< HEAD
669714
<<<<<<< HEAD
670715
const [model] = await vscode.lm.selectChatModels(MODEL_SELECTOR);
671716

@@ -711,6 +756,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
711756
=======
712757
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
713758
=======
759+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
760+
=======
714761
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
715762
// initialize the messages array with the prompt
716763
const messages = [
@@ -746,6 +793,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
746793
<<<<<<< HEAD
747794
<<<<<<< HEAD
748795
<<<<<<< HEAD
796+
<<<<<<< HEAD
797+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
798+
=======
749799
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
750800
=======
751801
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65

0 commit comments

Comments
 (0)