Skip to content

Commit 98ef23b

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

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
@@ -4,6 +4,7 @@ ContentId: 106AA11C-DB26-493A-9E3C-16F513B2AEC8
44
<<<<<<< HEAD
55
<<<<<<< HEAD
66
<<<<<<< HEAD
7+
<<<<<<< HEAD
78
DateApproved: 10/03/2024
89
=======
910
DateApproved: 10/29/2024
@@ -14,6 +15,9 @@ DateApproved: 10/29/2024
1415
=======
1516
DateApproved: 10/29/2024
1617
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
18+
=======
19+
DateApproved: 10/29/2024
20+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
1721

1822
# Summarize the whole topic in less than 300 characters for SEO purpose
1923
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
@@ -3,6 +3,7 @@ ContentId: 5c708951-e566-42db-9d97-e9715d95cdd1
33
<<<<<<< HEAD
44
<<<<<<< HEAD
55
<<<<<<< HEAD
6+
<<<<<<< HEAD
67
DateApproved: 10/03/2024
78
=======
89
DateApproved: 10/29/2024
@@ -13,6 +14,9 @@ DateApproved: 10/29/2024
1314
=======
1415
DateApproved: 10/29/2024
1516
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
17+
=======
18+
DateApproved: 10/29/2024
19+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
1620

1721
# Summarize the whole topic in less than 300 characters for SEO purpose
1822
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
@@ -3,6 +3,7 @@ ContentId: f00c4913-58e3-4a61-aa42-e769c3430906
33
<<<<<<< HEAD
44
<<<<<<< HEAD
55
<<<<<<< HEAD
6+
<<<<<<< HEAD
67
DateApproved: 10/03/2024
78
=======
89
DateApproved: 10/29/2024
@@ -13,6 +14,9 @@ DateApproved: 10/29/2024
1314
=======
1415
DateApproved: 10/29/2024
1516
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
17+
=======
18+
DateApproved: 10/29/2024
19+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
1620

1721
# Summarize the whole topic in less than 300 characters for SEO purpose
1822
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
@@ -4,6 +4,7 @@ ContentId: f4d4e9e0-8901-405c-aaf5-faa16c32588b
44
<<<<<<< HEAD
55
<<<<<<< HEAD
66
<<<<<<< HEAD
7+
<<<<<<< HEAD
78
DateApproved: 10/03/2024
89
=======
910
DateApproved: 10/29/2024
@@ -14,6 +15,9 @@ DateApproved: 10/29/2024
1415
=======
1516
DateApproved: 10/29/2024
1617
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
18+
=======
19+
DateApproved: 10/29/2024
20+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
1721

1822
# Summarize the whole topic in less than 300 characters for SEO purpose
1923
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
@@ -4,6 +4,7 @@ ContentId: 9c48dfbf-e49d-4f33-aadc-5ebf06d5dde0
44
<<<<<<< HEAD
55
<<<<<<< HEAD
66
<<<<<<< HEAD
7+
<<<<<<< HEAD
78
DateApproved: 10/03/2024
89
=======
910
DateApproved: 10/29/2024
@@ -14,6 +15,9 @@ DateApproved: 10/29/2024
1415
=======
1516
DateApproved: 10/29/2024
1617
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
18+
=======
19+
DateApproved: 10/29/2024
20+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
1721

1822
# Summarize the whole topic in less than 300 characters for SEO purpose
1923
MetaDescription: Common capabilities that Visual Studio Code extensions (plug-ins) can take advantage of
@@ -51,6 +55,7 @@ An extension can register custom Context Menu items that will be displayed in di
5155
<<<<<<< HEAD
5256
<<<<<<< HEAD
5357
<<<<<<< HEAD
58+
<<<<<<< HEAD
5459
There are four options for storing data:
5560
=======
5661
There are five options for storing data:
@@ -61,6 +66,9 @@ There are five options for storing data:
6166
=======
6267
There are five options for storing data:
6368
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
69+
=======
70+
There are five options for storing data:
71+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
6472
6573
- [`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.
6674
- [`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`.
@@ -69,6 +77,10 @@ There are five options for storing data:
6977
<<<<<<< HEAD
7078
<<<<<<< HEAD
7179
<<<<<<< HEAD
80+
<<<<<<< HEAD
81+
=======
82+
- [`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.
83+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
7284
=======
7385
- [`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.
7486
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ ContentId: e0d5bd37-f020-4235-ad81-c977baaeb24f
44
<<<<<<< HEAD
55
<<<<<<< HEAD
66
<<<<<<< HEAD
7+
<<<<<<< HEAD
78
DateApproved: 10/03/2024
89
=======
910
DateApproved: 10/29/2024
@@ -14,6 +15,9 @@ DateApproved: 10/29/2024
1415
=======
1516
DateApproved: 10/29/2024
1617
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
18+
=======
19+
DateApproved: 10/29/2024
20+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
1721

1822
# Summarize the whole topic in less than 300 characters for SEO purpose
1923
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
@@ -4,6 +4,7 @@ ContentId: d22675fc-6609-43f2-a66b-8f2a52597195
44
<<<<<<< HEAD
55
<<<<<<< HEAD
66
<<<<<<< HEAD
7+
<<<<<<< HEAD
78
DateApproved: 10/03/2024
89
=======
910
DateApproved: 10/29/2024
@@ -14,6 +15,9 @@ DateApproved: 10/29/2024
1415
=======
1516
DateApproved: 10/29/2024
1617
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
18+
=======
19+
DateApproved: 10/29/2024
20+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
1721

1822
# Summarize the whole topic in less than 300 characters for SEO purpose
1923
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
@@ -4,6 +4,7 @@ ContentId: 37b6ae0a-d1b5-48b6-9bd4-9b50ef11d573
44
<<<<<<< HEAD
55
<<<<<<< HEAD
66
<<<<<<< HEAD
7+
<<<<<<< HEAD
78
DateApproved: 10/03/2024
89
=======
910
DateApproved: 10/29/2024
@@ -14,6 +15,9 @@ DateApproved: 10/29/2024
1415
=======
1516
DateApproved: 10/29/2024
1617
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
18+
=======
19+
DateApproved: 10/29/2024
20+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
1721

1822
# Summarize the whole topic in less than 300 characters for SEO purpose
1923
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
@@ -4,6 +4,7 @@ ContentId: bea1d4c5-71e5-4b27-ac1e-fa9b59886dab
44
<<<<<<< HEAD
55
<<<<<<< HEAD
66
<<<<<<< HEAD
7+
<<<<<<< HEAD
78
DateApproved: 10/03/2024
89
=======
910
DateApproved: 10/29/2024
@@ -14,6 +15,9 @@ DateApproved: 10/29/2024
1415
=======
1516
DateApproved: 10/29/2024
1617
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
18+
=======
19+
DateApproved: 10/29/2024
20+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
1721

1822
# Summarize the whole topic in less than 300 characters for SEO purpose
1923
MetaDescription: Tutorial that walks you through creating a GitHub Copilot chat participant in VS Code by using the Chat API.
@@ -93,6 +97,7 @@ Finally, setting `isSticky: true` will automatically prepend the participant nam
9397
<<<<<<< HEAD
9498
<<<<<<< HEAD
9599
<<<<<<< HEAD
100+
<<<<<<< HEAD
96101
## Step 3: Craft the prompt and select the model
97102

98103
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.
@@ -109,6 +114,11 @@ Now that the participant is registered, you can start implementing the logic for
109114
=======
110115
## Step 3: Craft the prompt
111116

117+
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.
118+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
119+
=======
120+
## Step 3: Craft the prompt
121+
112122
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.
113123
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
114124
@@ -130,6 +140,7 @@ const BASE_PROMPT = 'You are a helpful code tutor. Your job is to teach the user
130140
<<<<<<< HEAD
131141
<<<<<<< HEAD
132142
<<<<<<< HEAD
143+
<<<<<<< HEAD
133144
You also need to select the model for the requests. gpt-4o is recommended since it is fast and high quality.
134145

135146
```ts
@@ -152,6 +163,11 @@ Now that the prompt is selected, you need to implement the request handler. This
152163
=======
153164
## Step 4: Implement the request handler
154165

166+
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.
167+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
168+
=======
169+
## Step 4: Implement the request handler
170+
155171
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.
156172
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
157173
@@ -168,6 +184,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
168184
<<<<<<< HEAD
169185
<<<<<<< HEAD
170186
<<<<<<< HEAD
187+
<<<<<<< HEAD
171188
Within the body of this handler, initialize the prompt and model. Check that the model returned successfully.
172189
=======
173190
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`.
@@ -182,6 +199,11 @@ Send the request using `request.model.sendRequest`, which will send the request
182199
=======
183200
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`.
184201

202+
Send the request using `request.model.sendRequest`, which will send the request using the currently selected model. Finally, stream the response to the user.
203+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
204+
=======
205+
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`.
206+
185207
Send the request using `request.model.sendRequest`, which will send the request using the currently selected model. Finally, stream the response to the user.
186208
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
187209
@@ -191,6 +213,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
191213

192214
<<<<<<< HEAD
193215
<<<<<<< HEAD
216+
<<<<<<< HEAD
194217
<<<<<<< HEAD
195218
// initialize the prompt and model
196219
let prompt = BASE_PROMPT;
@@ -240,6 +263,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
240263
=======
241264
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
242265
=======
266+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
267+
=======
243268
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
244269
// initialize the prompt
245270
let prompt = BASE_PROMPT;
@@ -260,6 +285,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
260285
stream.markdown(fragment);
261286
<<<<<<< HEAD
262287
<<<<<<< HEAD
288+
<<<<<<< HEAD
289+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
290+
=======
263291
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
264292
=======
265293
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -283,6 +311,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
283311

284312
<<<<<<< HEAD
285313
<<<<<<< HEAD
314+
<<<<<<< HEAD
286315
<<<<<<< HEAD
287316
// initialize the prompt and model
288317
let prompt = BASE_PROMPT;
@@ -310,6 +339,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
310339
=======
311340
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
312341
=======
342+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
343+
=======
313344
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
314345
// initialize the prompt
315346
let prompt = BASE_PROMPT;
@@ -330,6 +361,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
330361
stream.markdown(fragment);
331362
<<<<<<< HEAD
332363
<<<<<<< HEAD
364+
<<<<<<< HEAD
365+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
366+
=======
333367
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
334368
=======
335369
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -376,6 +410,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
376410

377411
<<<<<<< HEAD
378412
<<<<<<< HEAD
413+
<<<<<<< HEAD
379414
<<<<<<< HEAD
380415
// initialize the prompt and model
381416
let prompt = BASE_PROMPT;
@@ -418,6 +453,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
418453
=======
419454
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
420455
=======
456+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
457+
=======
421458
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
422459
// initialize the prompt
423460
let prompt = BASE_PROMPT;
@@ -453,6 +490,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
453490
stream.markdown(fragment);
454491
<<<<<<< HEAD
455492
<<<<<<< HEAD
493+
<<<<<<< HEAD
494+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
495+
=======
456496
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
457497
=======
458498
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -512,6 +552,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
512552

513553
<<<<<<< HEAD
514554
<<<<<<< HEAD
555+
<<<<<<< HEAD
515556
<<<<<<< HEAD
516557
// initialize the prompt and model
517558
=======
@@ -520,6 +561,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
520561
=======
521562
// initialize the prompt
522563
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
564+
=======
565+
// initialize the prompt
566+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
523567
=======
524568
// initialize the prompt
525569
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
@@ -531,6 +575,7 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
531575

532576
<<<<<<< HEAD
533577
<<<<<<< HEAD
578+
<<<<<<< HEAD
534579
<<<<<<< HEAD
535580
const [model] = await vscode.lm.selectChatModels(MODEL_SELECTOR);
536581

@@ -570,6 +615,8 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
570615
=======
571616
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
572617
=======
618+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
619+
=======
573620
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
574621
// initialize the messages array with the prompt
575622
const messages = [
@@ -602,6 +649,9 @@ const handler: vscode.ChatRequestHandler = async (request: vscode.ChatRequest, c
602649
stream.markdown(fragment);
603650
<<<<<<< HEAD
604651
<<<<<<< HEAD
652+
<<<<<<< HEAD
653+
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
654+
=======
605655
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65
606656
=======
607657
>>>>>>> 27e6951b86c69326ee8ff76ba46694a60b72ec65

0 commit comments

Comments
 (0)