Skip to content

Commit c191abc

Browse files
ntroghntrogh
committed
Refresh from public docs
1 parent 98ef23b commit c191abc

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
@@ -5,6 +5,7 @@ ContentId: 106AA11C-DB26-493A-9E3C-16F513B2AEC8
55
<<<<<<< HEAD
66
<<<<<<< HEAD
77
<<<<<<< HEAD
8+
<<<<<<< HEAD
89
DateApproved: 10/03/2024
910
=======
1011
DateApproved: 10/29/2024
@@ -18,6 +19,9 @@ DateApproved: 10/29/2024
1819
=======
1920
DateApproved: 10/29/2024
2021
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
22+
=======
23+
DateApproved: 10/29/2024
24+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2125

2226
# Summarize the whole topic in less than 300 characters for SEO purpose
2327
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
@@ -4,6 +4,7 @@ ContentId: 5c708951-e566-42db-9d97-e9715d95cdd1
44
<<<<<<< HEAD
55
<<<<<<< HEAD
66
<<<<<<< HEAD
7+
<<<<<<< HEAD
78
DateApproved: 10/03/2024
89
=======
910
DateApproved: 10/29/2024
@@ -17,6 +18,9 @@ DateApproved: 10/29/2024
1718
=======
1819
DateApproved: 10/29/2024
1920
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
21+
=======
22+
DateApproved: 10/29/2024
23+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2024

2125
# Summarize the whole topic in less than 300 characters for SEO purpose
2226
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
@@ -4,6 +4,7 @@ ContentId: f00c4913-58e3-4a61-aa42-e769c3430906
44
<<<<<<< HEAD
55
<<<<<<< HEAD
66
<<<<<<< HEAD
7+
<<<<<<< HEAD
78
DateApproved: 10/03/2024
89
=======
910
DateApproved: 10/29/2024
@@ -17,6 +18,9 @@ DateApproved: 10/29/2024
1718
=======
1819
DateApproved: 10/29/2024
1920
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
21+
=======
22+
DateApproved: 10/29/2024
23+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2024

2125
# Summarize the whole topic in less than 300 characters for SEO purpose
2226
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
@@ -5,6 +5,7 @@ ContentId: f4d4e9e0-8901-405c-aaf5-faa16c32588b
55
<<<<<<< HEAD
66
<<<<<<< HEAD
77
<<<<<<< HEAD
8+
<<<<<<< HEAD
89
DateApproved: 10/03/2024
910
=======
1011
DateApproved: 10/29/2024
@@ -18,6 +19,9 @@ DateApproved: 10/29/2024
1819
=======
1920
DateApproved: 10/29/2024
2021
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
22+
=======
23+
DateApproved: 10/29/2024
24+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2125

2226
# Summarize the whole topic in less than 300 characters for SEO purpose
2327
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
@@ -5,6 +5,7 @@ ContentId: 9c48dfbf-e49d-4f33-aadc-5ebf06d5dde0
55
<<<<<<< HEAD
66
<<<<<<< HEAD
77
<<<<<<< HEAD
8+
<<<<<<< HEAD
89
DateApproved: 10/03/2024
910
=======
1011
DateApproved: 10/29/2024
@@ -18,6 +19,9 @@ DateApproved: 10/29/2024
1819
=======
1920
DateApproved: 10/29/2024
2021
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
22+
=======
23+
DateApproved: 10/29/2024
24+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2125

2226
# Summarize the whole topic in less than 300 characters for SEO purpose
2327
MetaDescription: Common capabilities that Visual Studio Code extensions (plug-ins) can take advantage of
@@ -56,6 +60,7 @@ An extension can register custom Context Menu items that will be displayed in di
5660
<<<<<<< HEAD
5761
<<<<<<< HEAD
5862
<<<<<<< HEAD
63+
<<<<<<< HEAD
5964
There are four options for storing data:
6065
=======
6166
There are five options for storing data:
@@ -69,6 +74,9 @@ There are five options for storing data:
6974
=======
7075
There are five options for storing data:
7176
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
77+
=======
78+
There are five options for storing data:
79+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
7280
7381
- [`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.
7482
- [`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`.
@@ -78,6 +86,10 @@ There are five options for storing data:
7886
<<<<<<< HEAD
7987
<<<<<<< HEAD
8088
<<<<<<< HEAD
89+
<<<<<<< HEAD
90+
=======
91+
- [`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.
92+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
8193
=======
8294
- [`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.
8395
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ ContentId: e0d5bd37-f020-4235-ad81-c977baaeb24f
55
<<<<<<< HEAD
66
<<<<<<< HEAD
77
<<<<<<< HEAD
8+
<<<<<<< HEAD
89
DateApproved: 10/03/2024
910
=======
1011
DateApproved: 10/29/2024
@@ -18,6 +19,9 @@ DateApproved: 10/29/2024
1819
=======
1920
DateApproved: 10/29/2024
2021
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
22+
=======
23+
DateApproved: 10/29/2024
24+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2125

2226
# Summarize the whole topic in less than 300 characters for SEO purpose
2327
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
@@ -5,6 +5,7 @@ ContentId: d22675fc-6609-43f2-a66b-8f2a52597195
55
<<<<<<< HEAD
66
<<<<<<< HEAD
77
<<<<<<< HEAD
8+
<<<<<<< HEAD
89
DateApproved: 10/03/2024
910
=======
1011
DateApproved: 10/29/2024
@@ -18,6 +19,9 @@ DateApproved: 10/29/2024
1819
=======
1920
DateApproved: 10/29/2024
2021
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
22+
=======
23+
DateApproved: 10/29/2024
24+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2125

2226
# Summarize the whole topic in less than 300 characters for SEO purpose
2327
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
@@ -5,6 +5,7 @@ ContentId: 37b6ae0a-d1b5-48b6-9bd4-9b50ef11d573
55
<<<<<<< HEAD
66
<<<<<<< HEAD
77
<<<<<<< HEAD
8+
<<<<<<< HEAD
89
DateApproved: 10/03/2024
910
=======
1011
DateApproved: 10/29/2024
@@ -18,6 +19,9 @@ DateApproved: 10/29/2024
1819
=======
1920
DateApproved: 10/29/2024
2021
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
22+
=======
23+
DateApproved: 10/29/2024
24+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2125

2226
# Summarize the whole topic in less than 300 characters for SEO purpose
2327
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
@@ -5,6 +5,7 @@ ContentId: bea1d4c5-71e5-4b27-ac1e-fa9b59886dab
55
<<<<<<< HEAD
66
<<<<<<< HEAD
77
<<<<<<< HEAD
8+
<<<<<<< HEAD
89
DateApproved: 10/03/2024
910
=======
1011
DateApproved: 10/29/2024
@@ -18,6 +19,9 @@ DateApproved: 10/29/2024
1819
=======
1920
DateApproved: 10/29/2024
2021
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
22+
=======
23+
DateApproved: 10/29/2024
24+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
2125

2226
# Summarize the whole topic in less than 300 characters for SEO purpose
2327
MetaDescription: Tutorial that walks you through creating a GitHub Copilot chat participant in VS Code by using the Chat API.
@@ -98,6 +102,7 @@ Finally, setting `isSticky: true` will automatically prepend the participant nam
98102
<<<<<<< HEAD
99103
<<<<<<< HEAD
100104
<<<<<<< HEAD
105+
<<<<<<< HEAD
101106
## Step 3: Craft the prompt and select the model
102107

103108
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.
@@ -119,6 +124,11 @@ Now that the participant is registered, you can start implementing the logic for
119124
=======
120125
## Step 3: Craft the prompt
121126

127+
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.
128+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
129+
=======
130+
## Step 3: Craft the prompt
131+
122132
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.
123133
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
124134
@@ -141,6 +151,7 @@ const BASE_PROMPT = 'You are a helpful code tutor. Your job is to teach the user
141151
<<<<<<< HEAD
142152
<<<<<<< HEAD
143153
<<<<<<< HEAD
154+
<<<<<<< HEAD
144155
You also need to select the model for the requests. gpt-4o is recommended since it is fast and high quality.
145156

146157
```ts
@@ -168,6 +179,11 @@ Now that the prompt is selected, you need to implement the request handler. This
168179
=======
169180
## Step 4: Implement the request handler
170181

182+
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.
183+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
184+
=======
185+
## Step 4: Implement the request handler
186+
171187
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.
172188
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
173189
@@ -185,6 +201,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
185201
<<<<<<< HEAD
186202
<<<<<<< HEAD
187203
<<<<<<< HEAD
204+
<<<<<<< HEAD
188205
Within the body of this handler, initialize the prompt and model. Check that the model returned successfully.
189206
=======
190207
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`.
@@ -204,6 +221,11 @@ Send the request using `request.model.sendRequest`, which will send the request
204221
=======
205222
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`.
206223

224+
Send the request using `request.model.sendRequest`, which will send the request using the currently selected model. Finally, stream the response to the user.
225+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
226+
=======
227+
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`.
228+
207229
Send the request using `request.model.sendRequest`, which will send the request using the currently selected model. Finally, stream the response to the user.
208230
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
209231
@@ -214,6 +236,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
214236
<<<<<<< HEAD
215237
<<<<<<< HEAD
216238
<<<<<<< HEAD
239+
<<<<<<< HEAD
217240
<<<<<<< HEAD
218241
// initialize the prompt and model
219242
let prompt = BASE_PROMPT;
@@ -265,6 +288,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
265288
=======
266289
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
267290
=======
291+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
292+
=======
268293
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
269294
// initialize the prompt
270295
let prompt = BASE_PROMPT;
@@ -286,6 +311,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
286311
<<<<<<< HEAD
287312
<<<<<<< HEAD
288313
<<<<<<< HEAD
314+
<<<<<<< HEAD
315+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
316+
=======
289317
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
290318
=======
291319
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -312,6 +340,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
312340
<<<<<<< HEAD
313341
<<<<<<< HEAD
314342
<<<<<<< HEAD
343+
<<<<<<< HEAD
315344
<<<<<<< HEAD
316345
// initialize the prompt and model
317346
let prompt = BASE_PROMPT;
@@ -341,6 +370,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
341370
=======
342371
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
343372
=======
373+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
374+
=======
344375
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
345376
// initialize the prompt
346377
let prompt = BASE_PROMPT;
@@ -362,6 +393,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
362393
<<<<<<< HEAD
363394
<<<<<<< HEAD
364395
<<<<<<< HEAD
396+
<<<<<<< HEAD
397+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
398+
=======
365399
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
366400
=======
367401
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -411,6 +445,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
411445
<<<<<<< HEAD
412446
<<<<<<< HEAD
413447
<<<<<<< HEAD
448+
<<<<<<< HEAD
414449
<<<<<<< HEAD
415450
// initialize the prompt and model
416451
let prompt = BASE_PROMPT;
@@ -455,6 +490,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
455490
=======
456491
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
457492
=======
493+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
494+
=======
458495
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
459496
// initialize the prompt
460497
let prompt = BASE_PROMPT;
@@ -491,6 +528,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
491528
<<<<<<< HEAD
492529
<<<<<<< HEAD
493530
<<<<<<< HEAD
531+
<<<<<<< HEAD
532+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
533+
=======
494534
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
495535
=======
496536
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -553,6 +593,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
553593
<<<<<<< HEAD
554594
<<<<<<< HEAD
555595
<<<<<<< HEAD
596+
<<<<<<< HEAD
556597
<<<<<<< HEAD
557598
// initialize the prompt and model
558599
=======
@@ -564,6 +605,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
564605
=======
565606
// initialize the prompt
566607
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
608+
=======
609+
// initialize the prompt
610+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
567611
=======
568612
// initialize the prompt
569613
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -576,6 +620,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
576620
<<<<<<< HEAD
577621
<<<<<<< HEAD
578622
<<<<<<< HEAD
623+
<<<<<<< HEAD
579624
<<<<<<< HEAD
580625
const [model] = await vscode.lm.selectChatModels(MODEL_SELECTOR);
581626

@@ -617,6 +662,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
617662
=======
618663
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
619664
=======
665+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
666+
=======
620667
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
621668
// initialize the messages array with the prompt
622669
const messages = [
@@ -650,6 +697,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
650697
<<<<<<< HEAD
651698
<<<<<<< HEAD
652699
<<<<<<< HEAD
700+
<<<<<<< HEAD
701+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
702+
=======
653703
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
654704
=======
655705
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65

0 commit comments

Comments
 (0)