@codingame/monaco-vscode-api 1.85.1 → 1.85.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -5
- package/missing-services.js +305 -63
- package/monaco-editor-treemending.patch +946 -946
- package/package.json +8 -7
- package/service-override/tools/editor.js +1 -1
- package/services.js +10 -6
- package/vscode/src/vs/base/browser/ui/tree/treeDefaults.js +14 -0
- package/vscode/src/vs/platform/extensionManagement/common/extensionEnablementService.js +140 -0
- package/vscode/src/vs/platform/extensions/common/extensions.d.ts +1062 -93
- package/vscode/src/vs/platform/files/common/inMemoryFilesystemProvider.js +220 -0
- package/vscode/src/vs/platform/quickinput/browser/quickPickPin.js +102 -0
- package/vscode/src/vs/platform/userDataSync/common/content.js +9 -0
- package/vscode/src/vs/platform/userDataSync/common/settingsMerge.js +514 -0
- package/vscode/src/vs/platform/userDataSync/common/userDataSync.js +154 -2
- package/vscode/src/vs/platform/userDataSync/common/userDataSyncAccount.js +43 -1
- package/vscode/src/vs/platform/userDataSync/common/userDataSyncMachines.js +177 -0
- package/vscode/src/vs/workbench/api/common/extHostApiCommands.js +1 -1
- package/vscode/src/vs/workbench/api/common/extHostTypeConverters.js +1 -1
- package/vscode/src/vs/workbench/api/common/extHostWebview.js +2 -2
- package/vscode/src/vs/workbench/browser/parts/views/checkbox.js +105 -0
- package/vscode/src/vs/workbench/browser/parts/views/media/views.css.js +4 -0
- package/vscode/src/vs/workbench/browser/parts/views/treeView.js +1614 -0
- package/vscode/src/vs/workbench/contrib/codeEditor/browser/languageConfigurationExtensionPoint.js +7 -7
- package/vscode/src/vs/workbench/contrib/files/browser/explorerViewlet.js +73 -2
- package/vscode/src/vs/workbench/contrib/tasks/common/taskDefinitionRegistry.js +6 -6
- package/vscode/src/vs/workbench/contrib/tasks/common/taskService.js +12 -2
- package/vscode/src/vs/workbench/contrib/tasks/common/tasks.js +712 -0
- package/vscode/src/vs/workbench/contrib/terminal/browser/terminalProcessExtHostProxy.js +130 -0
- package/vscode/src/vs/workbench/services/authentication/browser/authenticationService.js +20 -1
- package/vscode/src/vs/workbench/services/configurationResolver/common/configurationResolverSchema.js +205 -0
- package/vscode/src/vs/workbench/services/configurationResolver/common/configurationResolverUtils.js +11 -0
- package/vscode/src/vs/workbench/services/configurationResolver/common/variableResolver.js +9 -9
- package/vscode/src/vs/workbench/services/extensionManagement/browser/extensionBisect.js +1 -1
- package/vscode/src/vs/workbench/services/keybinding/common/keybindingEditing.js +2 -2
- package/vscode/src/vs/workbench/services/languageStatus/common/languageStatusService.js +24 -1
- package/vscode/src/vs/workbench/services/preferences/browser/keybindingsEditorInput.js +41 -0
- package/vscode/src/vs/workbench/services/preferences/browser/keybindingsEditorModel.js +588 -0
- package/vscode/src/vs/workbench/services/preferences/common/preferencesEditorInput.js +43 -0
- package/vscode/src/vs/workbench/services/search/common/search.js +3 -3
- package/vscode/src/vs/workbench/services/terminal/common/embedderTerminalService.js +75 -1
- package/vscode/src/vs/workbench/services/timer/browser/timerService.js +240 -1
- package/vscode/src/vs/workbench/services/userData/browser/userDataInit.js +31 -1
- package/vscode/src/vs/workbench/services/userDataProfile/common/userDataProfile.js +25 -1
- package/vscode/src/vs/workbench/services/userDataProfile/common/userDataProfileIcons.js +75 -1
- package/vscode/src/vs/workbench/services/userDataSync/common/userDataSync.js +74 -4
- package/vscode/src/vs/base/parts/request/browser/request.js +0 -60
- package/vscode/src/vs/platform/request/browser/requestService.js +0 -28
- package/vscode/src/vs/platform/request/common/requestIpc.js +0 -17
- package/vscode/src/vs/platform/url/common/urlService.js +0 -17
- package/vscode/src/vs/workbench/services/configuration/common/jsonEditingService.js +0 -120
- package/vscode/src/vs/workbench/services/decorations/browser/decorationsService.js +0 -319
- package/vscode/src/vs/workbench/services/files/browser/elevatedFileService.js +0 -9
- package/vscode/src/vs/workbench/services/host/browser/browserHostService.js +0 -408
- package/vscode/src/vs/workbench/services/request/browser/requestService.js +0 -48
- package/vscode/src/vs/workbench/services/textfile/browser/browserTextFileService.js +0 -56
- package/vscode/src/vs/workbench/services/textfile/browser/textFileService.js +0 -639
- package/vscode/src/vs/workbench/services/textfile/common/textFileEditorModelManager.js +0 -402
- package/vscode/src/vs/workbench/services/textfile/common/textFileSaveParticipant.js +0 -62
- package/vscode/src/vs/workbench/services/themes/browser/browserHostColorSchemeService.js +0 -38
- package/vscode/src/vs/workbench/services/themes/common/tokenClassificationExtensionPoint.js +0 -295
- package/vscode/src/vs/workbench/services/url/browser/urlService.js +0 -47
- package/vscode/src/vs/workbench/services/views/common/treeViewsService.js +0 -20
- package/vscode/src/vs/workbench/services/workspaces/common/canonicalUriService.js +0 -19
|
@@ -1,138 +1,579 @@
|
|
|
1
|
+
import { IJSONSchema } from '../../../base/common/jsonSchema.js';
|
|
1
2
|
import Severity from '../../../base/common/severity.js';
|
|
2
3
|
import { URI } from '../../../base/common/uri.js';
|
|
3
4
|
import { ILocalizedString } from '../../action/common/action.js';
|
|
4
5
|
import { ExtensionKind } from '../../environment/common/environment.js';
|
|
5
6
|
|
|
6
7
|
interface ICommand {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
8
|
+
/**
|
|
9
|
+
* Identifier of the command to execute
|
|
10
|
+
*/
|
|
11
|
+
readonly command: string;
|
|
12
|
+
/**
|
|
13
|
+
* Title by which the command is represented in the UI
|
|
14
|
+
*/
|
|
15
|
+
readonly title: string | ILocalizedString;
|
|
16
|
+
readonly shortTitle?: string;
|
|
17
|
+
/**
|
|
18
|
+
* (Optional) Category string by which the command is grouped in the UI
|
|
19
|
+
*/
|
|
20
|
+
readonly category?: string | ILocalizedString;
|
|
21
|
+
/**
|
|
22
|
+
* (Optional) Condition which must be true to enable the command in the UI (menu and keybindings). Does not prevent executing the command by other means, like the `executeCommand`-api.
|
|
23
|
+
*/
|
|
24
|
+
readonly enablement?: string;
|
|
25
|
+
/**
|
|
26
|
+
* (Optional) Icon which is used to represent the command in the UI. Either a file path, an object with file paths for dark and light themes, or a theme icon references, like `\$(zap)`
|
|
27
|
+
*/
|
|
28
|
+
readonly icon?: string | {
|
|
29
|
+
/**
|
|
30
|
+
* Icon path when a light theme is used
|
|
31
|
+
*/
|
|
32
|
+
readonly light?: string;
|
|
33
|
+
/**
|
|
34
|
+
* Icon path when a dark theme is used
|
|
35
|
+
*/
|
|
36
|
+
readonly dark?: string;
|
|
37
|
+
};
|
|
15
38
|
}
|
|
16
39
|
interface IConfiguration {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
40
|
+
/**
|
|
41
|
+
* A title for the current category of settings. This label will be rendered in the Settings editor as a subheading. If the title is the same as the extension display name, then the category will be grouped under the main extension heading.
|
|
42
|
+
*/
|
|
43
|
+
readonly title?: string;
|
|
44
|
+
/**
|
|
45
|
+
* When specified, gives the order of this category of settings relative to other categories.
|
|
46
|
+
*/
|
|
47
|
+
readonly order?: number;
|
|
48
|
+
/**
|
|
49
|
+
* Description of the configuration properties.
|
|
50
|
+
*/
|
|
51
|
+
readonly properties: {
|
|
52
|
+
[key: string]: IJSONSchema;
|
|
22
53
|
};
|
|
23
54
|
}
|
|
24
55
|
interface IDebugger {
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
56
|
+
/**
|
|
57
|
+
* Unique identifier for this debug adapter.
|
|
58
|
+
*/
|
|
59
|
+
readonly type: string;
|
|
60
|
+
/**
|
|
61
|
+
* Display name for this debug adapter.
|
|
62
|
+
*/
|
|
63
|
+
readonly label?: string;
|
|
64
|
+
/**
|
|
65
|
+
* Path to the debug adapter program. Path is either absolute or relative to the extension folder.
|
|
66
|
+
*/
|
|
67
|
+
readonly program?: string;
|
|
68
|
+
/**
|
|
69
|
+
* Optional arguments to pass to the adapter.
|
|
70
|
+
*/
|
|
71
|
+
readonly args?: unknown[];
|
|
72
|
+
/**
|
|
73
|
+
* Optional runtime in case the program attribute is not an executable but requires a runtime.
|
|
74
|
+
*/
|
|
75
|
+
readonly runtime?: string;
|
|
76
|
+
/**
|
|
77
|
+
* Optional runtime arguments.
|
|
78
|
+
*/
|
|
79
|
+
readonly runtimeArgs?: unknown[];
|
|
80
|
+
/**
|
|
81
|
+
* Mapping from interactive variables (e.g. ${action.pickProcess}) in `launch.json` to a command.
|
|
82
|
+
*/
|
|
83
|
+
readonly variables?: {};
|
|
84
|
+
/**
|
|
85
|
+
* Configurations for generating the initial 'launch.json'.
|
|
86
|
+
*/
|
|
87
|
+
readonly initialConfigurations?: unknown[] | string;
|
|
88
|
+
/**
|
|
89
|
+
* List of languages for which the debug extension could be considered the "default debugger".
|
|
90
|
+
*/
|
|
91
|
+
readonly languages?: unknown[];
|
|
92
|
+
/**
|
|
93
|
+
* Snippets for adding new configurations in 'launch.json'.
|
|
94
|
+
*/
|
|
95
|
+
readonly configurationSnippets?: unknown[];
|
|
96
|
+
/**
|
|
97
|
+
* JSON schema configurations for validating 'launch.json'.
|
|
98
|
+
*/
|
|
99
|
+
readonly configurationAttributes?: {};
|
|
100
|
+
/**
|
|
101
|
+
* Condition which must be true to enable this type of debugger. Consider using 'shellExecutionSupported', 'virtualWorkspace', 'resourceScheme' or an extension-defined context key as appropriate for this.
|
|
102
|
+
*/
|
|
103
|
+
readonly when?: string;
|
|
104
|
+
/**
|
|
105
|
+
* When this condition is true, this debugger type is hidden from the debugger list, but is still enabled.
|
|
106
|
+
*/
|
|
107
|
+
readonly hiddenWhen?: string;
|
|
108
|
+
/**
|
|
109
|
+
* Optional message to mark this debug type as being deprecated.
|
|
110
|
+
*/
|
|
111
|
+
readonly deprecated?: string;
|
|
112
|
+
/**
|
|
113
|
+
* Windows specific settings.
|
|
114
|
+
*/
|
|
115
|
+
readonly windows?: {
|
|
116
|
+
/**
|
|
117
|
+
* Runtime used for Windows.
|
|
118
|
+
*/
|
|
119
|
+
runtime?: string;
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* macOS specific settings.
|
|
123
|
+
*/
|
|
124
|
+
readonly osx?: {
|
|
125
|
+
/**
|
|
126
|
+
* Runtime used for macOS.
|
|
127
|
+
*/
|
|
128
|
+
runtime?: string;
|
|
129
|
+
};
|
|
130
|
+
/**
|
|
131
|
+
* Linux specific settings.
|
|
132
|
+
*/
|
|
133
|
+
readonly linux?: {
|
|
134
|
+
/**
|
|
135
|
+
* Runtime used for Linux.
|
|
136
|
+
*/
|
|
137
|
+
readonly runtime?: string;
|
|
138
|
+
};
|
|
139
|
+
/**
|
|
140
|
+
* UI strings contributed by this debug adapter.
|
|
141
|
+
*/
|
|
142
|
+
readonly strings?: {
|
|
143
|
+
/**
|
|
144
|
+
* When there are unverified breakpoints in a language supported by this debug adapter, this message will appear on the breakpoint hover and in the breakpoints view. Markdown and command links are supported.
|
|
145
|
+
*/
|
|
146
|
+
readonly unverifiedBreakpoints?: string;
|
|
147
|
+
};
|
|
28
148
|
}
|
|
29
149
|
interface IGrammar {
|
|
30
|
-
|
|
150
|
+
/**
|
|
151
|
+
* Language identifier for which this syntax is contributed to.
|
|
152
|
+
*/
|
|
153
|
+
readonly language: string;
|
|
154
|
+
/**
|
|
155
|
+
* Textmate scope name used by the tmLanguage file.
|
|
156
|
+
*/
|
|
157
|
+
readonly scopeName: string;
|
|
158
|
+
/**
|
|
159
|
+
* Path of the tmLanguage file. The path is relative to the extension folder and typically starts with './syntaxes/'.
|
|
160
|
+
*/
|
|
161
|
+
readonly path: string;
|
|
162
|
+
/**
|
|
163
|
+
* A map of scope name to language id if this grammar contains embedded languages.
|
|
164
|
+
*/
|
|
165
|
+
readonly embeddedLanguages?: {};
|
|
166
|
+
/**
|
|
167
|
+
* A map of scope name to token types.
|
|
168
|
+
*/
|
|
169
|
+
readonly tokenTypes?: {
|
|
170
|
+
[k: string]: 'string' | 'comment' | 'other';
|
|
171
|
+
};
|
|
172
|
+
/**
|
|
173
|
+
* List of language scope names to which this grammar is injected to.
|
|
174
|
+
*/
|
|
175
|
+
readonly injectTo?: string[];
|
|
176
|
+
/**
|
|
177
|
+
* Defines which scope names contain balanced brackets.
|
|
178
|
+
*/
|
|
179
|
+
readonly balancedBracketScopes?: string[];
|
|
180
|
+
/**
|
|
181
|
+
* Defines which scope names do not contain balanced brackets.
|
|
182
|
+
*/
|
|
183
|
+
readonly unbalancedBracketScopes?: string[];
|
|
31
184
|
}
|
|
32
185
|
interface IJSONValidation {
|
|
33
|
-
|
|
34
|
-
|
|
186
|
+
/**
|
|
187
|
+
* The file pattern (or an array of patterns) to match, for example "package.json" or "*.launch". Exclusion patterns start with '!'
|
|
188
|
+
*/
|
|
189
|
+
readonly fileMatch?: string | string[];
|
|
190
|
+
/**
|
|
191
|
+
* A schema URL ('http:', 'https:') or relative path to the extension folder ('./').
|
|
192
|
+
*/
|
|
193
|
+
readonly url?: string;
|
|
35
194
|
}
|
|
36
195
|
interface IKeyBinding {
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
196
|
+
/**
|
|
197
|
+
* Identifier of the command to run when keybinding is triggered.
|
|
198
|
+
*/
|
|
199
|
+
readonly command: string;
|
|
200
|
+
/**
|
|
201
|
+
* Arguments to pass to the command to execute.
|
|
202
|
+
*/
|
|
203
|
+
readonly args?: {
|
|
204
|
+
[k: string]: unknown;
|
|
205
|
+
};
|
|
206
|
+
/**
|
|
207
|
+
* Key or key sequence (separate keys with plus-sign and sequences with space, e.g. Ctrl+O and Ctrl+L L for a chord).
|
|
208
|
+
*/
|
|
209
|
+
readonly key: string;
|
|
210
|
+
/**
|
|
211
|
+
* Mac specific key or key sequence.
|
|
212
|
+
*/
|
|
213
|
+
readonly mac?: string;
|
|
214
|
+
/**
|
|
215
|
+
* Linux specific key or key sequence.
|
|
216
|
+
*/
|
|
217
|
+
readonly linux?: string;
|
|
218
|
+
/**
|
|
219
|
+
* Windows specific key or key sequence.
|
|
220
|
+
*/
|
|
221
|
+
readonly win?: string;
|
|
222
|
+
/**
|
|
223
|
+
* Condition when the key is active.
|
|
224
|
+
*/
|
|
225
|
+
readonly when?: string;
|
|
43
226
|
}
|
|
44
227
|
interface ILanguage {
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
228
|
+
/**
|
|
229
|
+
* ID of the language.
|
|
230
|
+
*/
|
|
231
|
+
readonly id: string;
|
|
232
|
+
/**
|
|
233
|
+
* Name aliases for the language.
|
|
234
|
+
*/
|
|
235
|
+
readonly aliases?: string[];
|
|
236
|
+
/**
|
|
237
|
+
* File extensions associated to the language.
|
|
238
|
+
*/
|
|
239
|
+
readonly extensions?: string[];
|
|
240
|
+
/**
|
|
241
|
+
* File names associated to the language.
|
|
242
|
+
*/
|
|
243
|
+
readonly filenames?: string[];
|
|
244
|
+
/**
|
|
245
|
+
* File name glob patterns associated to the language.
|
|
246
|
+
*/
|
|
247
|
+
readonly filenamePatterns?: string[];
|
|
248
|
+
/**
|
|
249
|
+
* Mime types associated to the language.
|
|
250
|
+
*/
|
|
251
|
+
readonly mimetypes?: string[];
|
|
252
|
+
/**
|
|
253
|
+
* A regular expression matching the first line of a file of the language.
|
|
254
|
+
*/
|
|
255
|
+
readonly firstLine?: string;
|
|
256
|
+
/**
|
|
257
|
+
* A relative path to a file containing configuration options for the language.
|
|
258
|
+
*/
|
|
259
|
+
readonly configuration?: string;
|
|
260
|
+
/**
|
|
261
|
+
* A icon to use as file icon, if no icon theme provides one for the language.
|
|
262
|
+
*/
|
|
263
|
+
readonly icon?: {
|
|
264
|
+
/**
|
|
265
|
+
* Icon path when a light theme is used
|
|
266
|
+
*/
|
|
267
|
+
readonly light?: string;
|
|
268
|
+
/**
|
|
269
|
+
* Icon path when a dark theme is used
|
|
270
|
+
*/
|
|
271
|
+
readonly dark?: string;
|
|
272
|
+
};
|
|
48
273
|
}
|
|
49
274
|
interface IMenu {
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
275
|
+
/**
|
|
276
|
+
* Identifier of the command to execute. The command must be declared in the 'commands'-section
|
|
277
|
+
*/
|
|
278
|
+
readonly command: string;
|
|
279
|
+
/**
|
|
280
|
+
* Identifier of an alternative command to execute. The command must be declared in the 'commands'-section
|
|
281
|
+
*/
|
|
282
|
+
readonly alt?: string;
|
|
283
|
+
/**
|
|
284
|
+
* Condition which must be true to show this item
|
|
285
|
+
*/
|
|
286
|
+
readonly when?: string;
|
|
287
|
+
/**
|
|
288
|
+
* Group into which this item belongs
|
|
289
|
+
*/
|
|
290
|
+
readonly group?: string;
|
|
54
291
|
}
|
|
55
292
|
interface ISnippet {
|
|
56
|
-
|
|
293
|
+
/**
|
|
294
|
+
* Language identifier for which this snippet is contributed to.
|
|
295
|
+
*/
|
|
296
|
+
readonly language: string;
|
|
297
|
+
/**
|
|
298
|
+
* Path of the snippets file. The path is relative to the extension folder and typically starts with './snippets/'.
|
|
299
|
+
*/
|
|
300
|
+
readonly path: string;
|
|
301
|
+
}
|
|
302
|
+
interface IColorTheme {
|
|
303
|
+
/**
|
|
304
|
+
* Id of the color theme as used in the user settings.
|
|
305
|
+
*/
|
|
306
|
+
readonly id: string;
|
|
307
|
+
/**
|
|
308
|
+
* Label of the color theme as shown in the UI.
|
|
309
|
+
*/
|
|
310
|
+
readonly label: string;
|
|
311
|
+
/**
|
|
312
|
+
* Base theme defining the colors around the editor: 'vs' is the light color theme, 'vs-dark' is the dark color theme. 'hc-black' is the dark high contrast theme, 'hc-light' is the light high contrast theme.
|
|
313
|
+
*/
|
|
314
|
+
readonly uiTheme: 'vs' | 'vs-dark' | 'hc-black' | 'hc-light';
|
|
315
|
+
/**
|
|
316
|
+
* Path of the tmTheme file. The path is relative to the extension folder and is typically './colorthemes/awesome-color-theme.json'.
|
|
317
|
+
*/
|
|
318
|
+
readonly path: string;
|
|
57
319
|
}
|
|
58
|
-
interface
|
|
59
|
-
|
|
320
|
+
interface IIconTheme {
|
|
321
|
+
/**
|
|
322
|
+
* Id of the file icon theme as used in the user settings.
|
|
323
|
+
*/
|
|
324
|
+
readonly id: string;
|
|
325
|
+
/**
|
|
326
|
+
* Label of the file icon theme as shown in the UI.
|
|
327
|
+
*/
|
|
328
|
+
readonly label: string;
|
|
329
|
+
/**
|
|
330
|
+
* Path of the file icon theme definition file. The path is relative to the extension folder and is typically './fileicons/awesome-icon-theme.json'.
|
|
331
|
+
*/
|
|
332
|
+
readonly path: string;
|
|
333
|
+
}
|
|
334
|
+
interface IProductTheme {
|
|
335
|
+
/**
|
|
336
|
+
* Id of the product icon theme as used in the user settings.
|
|
337
|
+
*/
|
|
338
|
+
readonly id: string;
|
|
339
|
+
/**
|
|
340
|
+
* Label of the product icon theme as shown in the UI.
|
|
341
|
+
*/
|
|
342
|
+
readonly label: string;
|
|
343
|
+
/**
|
|
344
|
+
* Path of the product icon theme definition file. The path is relative to the extension folder and is typically './producticons/awesome-product-icon-theme.json'.
|
|
345
|
+
*/
|
|
346
|
+
readonly path: string;
|
|
60
347
|
}
|
|
61
348
|
interface IViewContainer {
|
|
62
|
-
|
|
63
|
-
|
|
349
|
+
/**
|
|
350
|
+
* Unique id used to identify the container in which views can be contributed using 'views' contribution point
|
|
351
|
+
*/
|
|
352
|
+
readonly id: string;
|
|
353
|
+
/**
|
|
354
|
+
* Human readable string used to render the container
|
|
355
|
+
*/
|
|
356
|
+
readonly title: string;
|
|
357
|
+
/**
|
|
358
|
+
* Path to the container icon. Icons are 24x24 centered on a 50x40 block and have a fill color of 'rgb(215, 218, 224)' or '#d7dae0'. It is recommended that icons be in SVG, though any image file type is accepted.
|
|
359
|
+
*/
|
|
360
|
+
readonly icon: string;
|
|
64
361
|
}
|
|
65
362
|
interface IView {
|
|
66
|
-
|
|
67
|
-
|
|
363
|
+
readonly type?: 'tree' | 'webview';
|
|
364
|
+
readonly id: string;
|
|
365
|
+
/**
|
|
366
|
+
* The human-readable name of the view. Will be shown
|
|
367
|
+
*/
|
|
368
|
+
readonly name: string;
|
|
369
|
+
/**
|
|
370
|
+
* Condition which must be true to show this view
|
|
371
|
+
*/
|
|
372
|
+
readonly when?: string;
|
|
373
|
+
/**
|
|
374
|
+
* Path to the view icon. View icons are displayed when the name of the view cannot be shown. It is recommended that icons be in SVG, though any image file type is accepted.
|
|
375
|
+
*/
|
|
376
|
+
readonly icon?: string;
|
|
377
|
+
/**
|
|
378
|
+
* Human-readable context for when the view is moved out of its original location. By default, the view's container name will be used.
|
|
379
|
+
*/
|
|
380
|
+
readonly contextualTitle?: string;
|
|
381
|
+
/**
|
|
382
|
+
* Initial state of the view when the extension is first installed. Once the user has changed the view state by collapsing, moving, or hiding the view, the initial state will not be used again.
|
|
383
|
+
*/
|
|
384
|
+
readonly visibility?: 'visible' | 'hidden' | 'collapsed';
|
|
385
|
+
/**
|
|
386
|
+
* The initial size of the view. The size will behave like the css 'flex' property, and will set the initial size when the view is first shown. In the side bar, this is the height of the view. This value is only respected when the same extension owns both the view and the view container.
|
|
387
|
+
*/
|
|
388
|
+
readonly initialSize?: number;
|
|
68
389
|
}
|
|
69
390
|
interface IColor {
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
391
|
+
/**
|
|
392
|
+
* The identifier of the themable color
|
|
393
|
+
*/
|
|
394
|
+
readonly id: string;
|
|
395
|
+
/**
|
|
396
|
+
* The description of the themable color
|
|
397
|
+
*/
|
|
398
|
+
readonly description?: string;
|
|
399
|
+
readonly defaults: {
|
|
400
|
+
/**
|
|
401
|
+
* The default color for light themes. Either a color value in hex (#RRGGBB[AA]) or the identifier of a themable color which provides the default.
|
|
402
|
+
*/
|
|
403
|
+
readonly light: string;
|
|
404
|
+
/**
|
|
405
|
+
* The default color for dark themes. Either a color value in hex (#RRGGBB[AA]) or the identifier of a themable color which provides the default.
|
|
406
|
+
*/
|
|
407
|
+
readonly dark: string;
|
|
408
|
+
/**
|
|
409
|
+
* The default color for high contrast dark themes. Either a color value in hex (#RRGGBB[AA]) or the identifier of a themable color which provides the default. If not provided, the `dark` color is used as default for high contrast dark themes.
|
|
410
|
+
*/
|
|
411
|
+
readonly highContrast?: string;
|
|
412
|
+
/**
|
|
413
|
+
* The default color for high contrast light themes. Either a color value in hex (#RRGGBB[AA]) or the identifier of a themable color which provides the default. If not provided, the `light` color is used as default for high contrast light themes.
|
|
414
|
+
*/
|
|
415
|
+
readonly highContrastLight?: string;
|
|
76
416
|
};
|
|
77
417
|
}
|
|
78
418
|
interface IWebviewEditor {
|
|
79
419
|
readonly viewType: string;
|
|
80
420
|
readonly priority: string;
|
|
81
|
-
|
|
421
|
+
/**
|
|
422
|
+
* Human readable name of the custom editor. This is displayed to users when selecting which editor to use.
|
|
423
|
+
*/
|
|
424
|
+
readonly displayName: string;
|
|
425
|
+
/**
|
|
426
|
+
* Set of globs that the custom editor is enabled for.
|
|
427
|
+
*/
|
|
428
|
+
readonly selector: {
|
|
429
|
+
/**
|
|
430
|
+
* Glob that the custom editor is enabled for.
|
|
431
|
+
*/
|
|
82
432
|
readonly filenamePattern?: string;
|
|
83
433
|
}[];
|
|
84
434
|
}
|
|
85
435
|
interface ICodeActionContributionAction {
|
|
86
436
|
readonly kind: string;
|
|
437
|
+
/**
|
|
438
|
+
* Label for the code action used in the UI.
|
|
439
|
+
*/
|
|
87
440
|
readonly title: string;
|
|
441
|
+
/**
|
|
442
|
+
* Description of what the code action does.
|
|
443
|
+
*/
|
|
88
444
|
readonly description?: string;
|
|
89
445
|
}
|
|
90
446
|
interface ICodeActionContribution {
|
|
91
|
-
|
|
447
|
+
/**
|
|
448
|
+
* Language modes that the code actions are enabled for.
|
|
449
|
+
*/
|
|
450
|
+
readonly languages: string[];
|
|
92
451
|
readonly actions: readonly ICodeActionContributionAction[];
|
|
93
452
|
}
|
|
94
453
|
interface IAuthenticationContribution {
|
|
454
|
+
/**
|
|
455
|
+
* The id of the authentication provider.
|
|
456
|
+
*/
|
|
95
457
|
readonly id: string;
|
|
458
|
+
/**
|
|
459
|
+
* The human readable name of the authentication provider.
|
|
460
|
+
*/
|
|
96
461
|
readonly label: string;
|
|
97
462
|
}
|
|
98
463
|
interface IWalkthroughStep {
|
|
464
|
+
/**
|
|
465
|
+
* Unique identifier for this step. This is used to keep track of which steps have been completed.
|
|
466
|
+
*/
|
|
99
467
|
readonly id: string;
|
|
468
|
+
/**
|
|
469
|
+
* Title of step.
|
|
470
|
+
*/
|
|
100
471
|
readonly title: string;
|
|
101
|
-
|
|
472
|
+
/**
|
|
473
|
+
* Description of step. Supports ``preformatted``, __italic__, and **bold** text. Use markdown-style links for commands or external links: [Title](command:myext.command), [Title](command:toSide:myext.command), or [Title](https://aka.ms). Links on their own line will be rendered as buttons.
|
|
474
|
+
*/
|
|
475
|
+
readonly description?: string;
|
|
476
|
+
readonly button?: {
|
|
477
|
+
[k: string]: unknown;
|
|
478
|
+
};
|
|
479
|
+
/**
|
|
480
|
+
* Media to show alongside this step, either an image or markdown content.
|
|
481
|
+
*/
|
|
102
482
|
readonly media: {
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
483
|
+
readonly path?: {
|
|
484
|
+
[k: string]: unknown;
|
|
485
|
+
};
|
|
486
|
+
/**
|
|
487
|
+
* Path to an image - or object consisting of paths to light, dark, and hc images - relative to extension directory. Depending on context, the image will be displayed from 400px to 800px wide, with similar bounds on height. To support HIDPI displays, the image will be rendered at 1.5x scaling, for example a 900 physical pixels wide image will be displayed as 600 logical pixels wide.
|
|
488
|
+
*/
|
|
489
|
+
readonly image: string | {
|
|
490
|
+
/**
|
|
491
|
+
* Path to the image for dark themes, relative to extension directory.
|
|
492
|
+
*/
|
|
493
|
+
readonly dark: string;
|
|
494
|
+
/**
|
|
495
|
+
* Path to the image for light themes, relative to extension directory.
|
|
496
|
+
*/
|
|
497
|
+
readonly light: string;
|
|
498
|
+
/**
|
|
499
|
+
* Path to the image for hc themes, relative to extension directory.
|
|
500
|
+
*/
|
|
501
|
+
readonly hc: string;
|
|
502
|
+
/**
|
|
503
|
+
* Path to the image for hc light themes, relative to extension directory.
|
|
504
|
+
*/
|
|
505
|
+
readonly hcLight: string;
|
|
107
506
|
};
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
507
|
+
/**
|
|
508
|
+
* Alternate text to display when the image cannot be loaded or in screen readers.
|
|
509
|
+
*/
|
|
510
|
+
readonly altText: string;
|
|
511
|
+
readonly markdown?: never;
|
|
512
|
+
readonly svg?: never;
|
|
111
513
|
} | {
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
514
|
+
/**
|
|
515
|
+
* Path to an svg, color tokens are supported in variables to support theming to match the workbench.
|
|
516
|
+
*/
|
|
517
|
+
readonly svg: string;
|
|
518
|
+
/**
|
|
519
|
+
* Alternate text to display when the image cannot be loaded or in screen readers.
|
|
520
|
+
*/
|
|
521
|
+
readonly altText: string;
|
|
522
|
+
readonly image?: never;
|
|
523
|
+
readonly markdown?: never;
|
|
115
524
|
} | {
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
525
|
+
readonly path?: {
|
|
526
|
+
[k: string]: unknown;
|
|
527
|
+
};
|
|
528
|
+
/**
|
|
529
|
+
* Path to the markdown document, relative to extension directory.
|
|
530
|
+
*/
|
|
531
|
+
readonly markdown: string;
|
|
532
|
+
readonly image?: never;
|
|
533
|
+
readonly svg?: never;
|
|
120
534
|
};
|
|
535
|
+
/**
|
|
536
|
+
* Events that should trigger this step to become checked off. If empty or not defined, the step will check off when any of the step's buttons or links are clicked; if the step has no buttons or links it will check on when it is selected.
|
|
537
|
+
*/
|
|
121
538
|
readonly completionEvents?: string[];
|
|
122
|
-
/**
|
|
539
|
+
/**
|
|
540
|
+
* Signal to mark step as complete.
|
|
541
|
+
* @deprecated use `completionEvents: 'onCommand:...'`
|
|
542
|
+
**/
|
|
123
543
|
readonly doneOn?: {
|
|
124
544
|
command: string;
|
|
125
545
|
};
|
|
546
|
+
/**
|
|
547
|
+
* Context key expression to control the visibility of this step.
|
|
548
|
+
*/
|
|
126
549
|
readonly when?: string;
|
|
127
550
|
}
|
|
128
551
|
interface IWalkthrough {
|
|
552
|
+
/**
|
|
553
|
+
* Unique identifier for this walkthrough.
|
|
554
|
+
*/
|
|
129
555
|
readonly id: string;
|
|
556
|
+
/**
|
|
557
|
+
* Title of walkthrough.
|
|
558
|
+
*/
|
|
130
559
|
readonly title: string;
|
|
560
|
+
/**
|
|
561
|
+
* Relative path to the icon of the walkthrough. The path is relative to the extension location. If not specified, the icon defaults to the extension icon if available.
|
|
562
|
+
*/
|
|
131
563
|
readonly icon?: string;
|
|
564
|
+
/**
|
|
565
|
+
* Description of walkthrough.
|
|
566
|
+
*/
|
|
132
567
|
readonly description: string;
|
|
133
|
-
|
|
134
|
-
|
|
568
|
+
/**
|
|
569
|
+
* Walkthroughs that match one of these glob patterns appear as 'featured' in workspaces with the specified files. For example, a walkthrough for TypeScript projects might specify `tsconfig.json` here.
|
|
570
|
+
*/
|
|
571
|
+
readonly featuredFor?: string[];
|
|
572
|
+
/**
|
|
573
|
+
* Context key expression to control the visibility of this walkthrough.
|
|
574
|
+
*/
|
|
135
575
|
readonly when?: string;
|
|
576
|
+
readonly steps: IWalkthroughStep[];
|
|
136
577
|
}
|
|
137
578
|
interface IStartEntry {
|
|
138
579
|
readonly title: string;
|
|
@@ -142,57 +583,585 @@ interface IStartEntry {
|
|
|
142
583
|
readonly category: 'file' | 'folder' | 'notebook';
|
|
143
584
|
}
|
|
144
585
|
interface INotebookEntry {
|
|
586
|
+
/**
|
|
587
|
+
* Type of the notebook.
|
|
588
|
+
*/
|
|
145
589
|
readonly type: string;
|
|
590
|
+
/**
|
|
591
|
+
* Human readable name of the notebook.
|
|
592
|
+
*/
|
|
146
593
|
readonly displayName: string;
|
|
594
|
+
/**
|
|
595
|
+
* Set of globs that the notebook is for.
|
|
596
|
+
*/
|
|
597
|
+
readonly selector: {
|
|
598
|
+
/**
|
|
599
|
+
* Glob that the notebook is enabled for.
|
|
600
|
+
*/
|
|
601
|
+
readonly filenamePattern?: string;
|
|
602
|
+
/**
|
|
603
|
+
* Glob that the notebook is disabled for.
|
|
604
|
+
*/
|
|
605
|
+
readonly excludeFileNamePattern?: string;
|
|
606
|
+
}[];
|
|
607
|
+
readonly priority?: 'default' | 'option';
|
|
147
608
|
}
|
|
148
609
|
interface INotebookRendererContribution {
|
|
610
|
+
/**
|
|
611
|
+
* Unique identifier of the notebook output renderer.
|
|
612
|
+
*/
|
|
149
613
|
readonly id: string;
|
|
614
|
+
/**
|
|
615
|
+
* Human readable name of the notebook output renderer.
|
|
616
|
+
*/
|
|
150
617
|
readonly displayName: string;
|
|
618
|
+
readonly dependencies?: string[];
|
|
619
|
+
readonly optionalDependencies?: string[];
|
|
620
|
+
/**
|
|
621
|
+
* Defines how and if the renderer needs to communicate with an extension host, via `createRendererMessaging`. Renderers with stronger messaging requirements may not work in all environments.
|
|
622
|
+
*/
|
|
623
|
+
readonly requiresMessaging?: 'always' | 'optional' | 'never';
|
|
624
|
+
/**
|
|
625
|
+
* Set of globs that the notebook is for.
|
|
626
|
+
*/
|
|
151
627
|
readonly mimeTypes: string[];
|
|
628
|
+
readonly entrypoint: string | {
|
|
629
|
+
readonly extends: string;
|
|
630
|
+
readonly path: string;
|
|
631
|
+
};
|
|
152
632
|
}
|
|
153
633
|
interface ITranslation {
|
|
154
|
-
|
|
155
|
-
|
|
634
|
+
/**
|
|
635
|
+
* Id of VS Code or Extension for which this translation is contributed to. Id of VS Code is always `vscode` and of extension should be in format `publisherId.extensionName`.
|
|
636
|
+
*/
|
|
637
|
+
readonly id: string;
|
|
638
|
+
/**
|
|
639
|
+
* A relative path to a file containing translations for the language.
|
|
640
|
+
*/
|
|
641
|
+
readonly path: string;
|
|
156
642
|
}
|
|
157
643
|
interface ILocalizationContribution {
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
644
|
+
/**
|
|
645
|
+
* Id of the language into which the display strings are translated.
|
|
646
|
+
*/
|
|
647
|
+
readonly languageId: string;
|
|
648
|
+
/**
|
|
649
|
+
* Name of the language in English.
|
|
650
|
+
*/
|
|
651
|
+
readonly languageName?: string;
|
|
652
|
+
/**
|
|
653
|
+
* Name of the language in contributed language.
|
|
654
|
+
*/
|
|
655
|
+
readonly localizedLanguageName?: string;
|
|
656
|
+
/**
|
|
657
|
+
*
|
|
658
|
+
*/
|
|
659
|
+
readonly translations: ITranslation[];
|
|
660
|
+
}
|
|
661
|
+
interface ITerminal {
|
|
662
|
+
readonly profiles?: {
|
|
663
|
+
readonly id: string;
|
|
664
|
+
readonly title: string;
|
|
665
|
+
readonly icon?: (string | {
|
|
666
|
+
/**
|
|
667
|
+
* Icon path when a light theme is used
|
|
668
|
+
*/
|
|
669
|
+
readonly light?: string;
|
|
670
|
+
/**
|
|
671
|
+
* Icon path when a dark theme is used
|
|
672
|
+
*/
|
|
673
|
+
readonly dark?: string;
|
|
674
|
+
[k: string]: unknown;
|
|
675
|
+
});
|
|
676
|
+
}[];
|
|
677
|
+
}
|
|
678
|
+
interface IStatusBarItem {
|
|
679
|
+
readonly id: string;
|
|
680
|
+
/**
|
|
681
|
+
* The name of the entry, like 'Python Language Indicator', 'Git Status' etc. Try to keep the length of the name short, yet descriptive enough that users can understand what the status bar item is about.
|
|
682
|
+
*/
|
|
683
|
+
readonly name: string;
|
|
684
|
+
/**
|
|
685
|
+
* The text to show for the entry. You can embed icons in the text by leveraging the `$(<name>)`-syntax, like 'Hello $(globe)!'
|
|
686
|
+
*/
|
|
687
|
+
readonly text: string;
|
|
688
|
+
/**
|
|
689
|
+
* The tooltip text for the entry.
|
|
690
|
+
*/
|
|
691
|
+
readonly tooltip?: string;
|
|
692
|
+
/**
|
|
693
|
+
* The command to execute when the status bar entry is clicked.
|
|
694
|
+
*/
|
|
695
|
+
readonly command?: string;
|
|
696
|
+
/**
|
|
697
|
+
* The alignment of the status bar entry.
|
|
698
|
+
*/
|
|
699
|
+
readonly alignment: 'left' | 'right';
|
|
700
|
+
/**
|
|
701
|
+
* The priority of the status bar entry. Higher value means the item should be shown more to the left.
|
|
702
|
+
*/
|
|
703
|
+
readonly priority?: number;
|
|
704
|
+
/**
|
|
705
|
+
* Defines the role and aria label to be used when the status bar entry is focused.
|
|
706
|
+
*/
|
|
707
|
+
readonly accessibilityInformation?: {
|
|
708
|
+
/**
|
|
709
|
+
* The role of the status bar entry which defines how a screen reader interacts with it. More about aria roles can be found here https://w3c.github.io/aria/#widget_roles
|
|
710
|
+
*/
|
|
711
|
+
readonly role?: string;
|
|
712
|
+
/**
|
|
713
|
+
* The aria label of the status bar entry. Defaults to the entry's text.
|
|
714
|
+
*/
|
|
715
|
+
readonly label?: string;
|
|
716
|
+
};
|
|
717
|
+
}
|
|
718
|
+
interface IRemoteHelp {
|
|
719
|
+
/**
|
|
720
|
+
* The url, or a command that returns the url, to your project's Getting Started page, or a walkthrough ID contributed by your project's extension
|
|
721
|
+
*/
|
|
722
|
+
readonly getStarted?: string | {
|
|
723
|
+
/**
|
|
724
|
+
* The ID of a Get Started walkthrough to open.
|
|
725
|
+
*/
|
|
726
|
+
id: string;
|
|
727
|
+
};
|
|
728
|
+
/**
|
|
729
|
+
* The url, or a command that returns the url, to your project's documentation page
|
|
730
|
+
*/
|
|
731
|
+
readonly documentation?: string;
|
|
732
|
+
/**
|
|
733
|
+
* The url, or a command that returns the url, to your project's feedback reporter
|
|
734
|
+
*/
|
|
735
|
+
readonly feedback?: string;
|
|
736
|
+
/**
|
|
737
|
+
* The url, or a command that returns the url, to your project's issue reporter
|
|
738
|
+
*/
|
|
739
|
+
readonly reportIssue?: string;
|
|
740
|
+
/**
|
|
741
|
+
* The url, or a command that returns the url, to your project's issues list
|
|
742
|
+
*/
|
|
743
|
+
readonly issues?: string;
|
|
744
|
+
}
|
|
745
|
+
interface ITaskDefinitions {
|
|
746
|
+
/**
|
|
747
|
+
* The actual task type. Please note that types starting with a '$' are reserved for internal usage.
|
|
748
|
+
*/
|
|
749
|
+
readonly type?: string;
|
|
750
|
+
readonly required?: string[];
|
|
751
|
+
/**
|
|
752
|
+
* Additional properties of the task type
|
|
753
|
+
*/
|
|
754
|
+
readonly properties?: {
|
|
755
|
+
[k: string]: IJSONSchema;
|
|
756
|
+
};
|
|
757
|
+
readonly when?: string;
|
|
758
|
+
}
|
|
759
|
+
interface IIcon {
|
|
760
|
+
/**
|
|
761
|
+
* The description of the themable icon
|
|
762
|
+
*/
|
|
763
|
+
readonly description: string;
|
|
764
|
+
/**
|
|
765
|
+
* The default of the icon. Either a reference to an extisting ThemeIcon or an icon in an icon font.
|
|
766
|
+
*/
|
|
767
|
+
readonly default: string | {
|
|
768
|
+
/**
|
|
769
|
+
* The path of the icon font that defines the icon.
|
|
770
|
+
*/
|
|
771
|
+
readonly fontPath: string;
|
|
772
|
+
/**
|
|
773
|
+
* The character for the icon in the icon font.
|
|
774
|
+
*/
|
|
775
|
+
readonly fontCharacter: string;
|
|
164
776
|
};
|
|
165
777
|
}
|
|
778
|
+
interface IDocumentationRefactoring {
|
|
779
|
+
/**
|
|
780
|
+
* Label for the documentation used in the UI.
|
|
781
|
+
*/
|
|
782
|
+
readonly title: string;
|
|
783
|
+
/**
|
|
784
|
+
* When clause.
|
|
785
|
+
*/
|
|
786
|
+
readonly when: string;
|
|
787
|
+
/**
|
|
788
|
+
* Command executed.
|
|
789
|
+
*/
|
|
790
|
+
readonly command: string;
|
|
791
|
+
}
|
|
792
|
+
interface IDocumentation {
|
|
793
|
+
/**
|
|
794
|
+
* Contributed documentation for refactorings.
|
|
795
|
+
*/
|
|
796
|
+
readonly refactoring?: IDocumentationRefactoring[];
|
|
797
|
+
}
|
|
798
|
+
interface ISubMenu {
|
|
799
|
+
/**
|
|
800
|
+
* Identifier of the submenu to display in this item.
|
|
801
|
+
*/
|
|
802
|
+
readonly submenu: string;
|
|
803
|
+
/**
|
|
804
|
+
* Condition which must be true to show this item
|
|
805
|
+
*/
|
|
806
|
+
readonly when?: string;
|
|
807
|
+
/**
|
|
808
|
+
* Group into which this item belongs
|
|
809
|
+
*/
|
|
810
|
+
readonly group?: string;
|
|
811
|
+
}
|
|
812
|
+
interface ISubMenu {
|
|
813
|
+
/**
|
|
814
|
+
* Identifier of the menu to display as a submenu.
|
|
815
|
+
*/
|
|
816
|
+
readonly id: string;
|
|
817
|
+
/**
|
|
818
|
+
* The label of the menu item which leads to this submenu.
|
|
819
|
+
*/
|
|
820
|
+
readonly label: string;
|
|
821
|
+
/**
|
|
822
|
+
* (Optional) Icon which is used to represent the submenu in the UI. Either a file path, an object with file paths for dark and light themes, or a theme icon references, like `\$(zap)`
|
|
823
|
+
*/
|
|
824
|
+
readonly icon?: string | {
|
|
825
|
+
/**
|
|
826
|
+
* Icon path when a light theme is used
|
|
827
|
+
*/
|
|
828
|
+
readonly light?: string;
|
|
829
|
+
/**
|
|
830
|
+
* Icon path when a dark theme is used
|
|
831
|
+
*/
|
|
832
|
+
readonly dark?: string;
|
|
833
|
+
};
|
|
834
|
+
}
|
|
835
|
+
interface IResourceLabelFormatters {
|
|
836
|
+
/**
|
|
837
|
+
* URI scheme on which to match the formatter on. For example "file". Simple glob patterns are supported.
|
|
838
|
+
*/
|
|
839
|
+
readonly scheme: string;
|
|
840
|
+
/**
|
|
841
|
+
* URI authority on which to match the formatter on. Simple glob patterns are supported.
|
|
842
|
+
*/
|
|
843
|
+
readonly authority?: string;
|
|
844
|
+
/**
|
|
845
|
+
* Rules for formatting uri resource labels.
|
|
846
|
+
*/
|
|
847
|
+
readonly formatting: {
|
|
848
|
+
/**
|
|
849
|
+
* Label rules to display. For example: myLabel:/${path}. ${path}, ${scheme}, ${authority} and ${authoritySuffix} are supported as variables.
|
|
850
|
+
*/
|
|
851
|
+
readonly label?: string;
|
|
852
|
+
/**
|
|
853
|
+
* Separator to be used in the uri label display. '/' or '' as an example.
|
|
854
|
+
*/
|
|
855
|
+
readonly separator?: string;
|
|
856
|
+
/**
|
|
857
|
+
* Controls whether `${path}` substitutions should have starting separator characters stripped.
|
|
858
|
+
*/
|
|
859
|
+
readonly stripPathStartingSeparator?: boolean;
|
|
860
|
+
/**
|
|
861
|
+
* Controls if the start of the uri label should be tildified when possible.
|
|
862
|
+
*/
|
|
863
|
+
readonly tildify?: boolean;
|
|
864
|
+
/**
|
|
865
|
+
* Suffix appended to the workspace label.
|
|
866
|
+
*/
|
|
867
|
+
readonly workspaceSuffix?: string;
|
|
868
|
+
};
|
|
869
|
+
}
|
|
870
|
+
interface ISemanticTokenTypes {
|
|
871
|
+
/**
|
|
872
|
+
* The identifier of the semantic token type
|
|
873
|
+
*/
|
|
874
|
+
readonly id?: string;
|
|
875
|
+
/**
|
|
876
|
+
* The super type of the semantic token type
|
|
877
|
+
*/
|
|
878
|
+
readonly superType?: string;
|
|
879
|
+
/**
|
|
880
|
+
* The description of the semantic token type
|
|
881
|
+
*/
|
|
882
|
+
readonly description?: string;
|
|
883
|
+
}
|
|
884
|
+
interface ISemanticTokenModifiers {
|
|
885
|
+
/**
|
|
886
|
+
* The identifier of the semantic token modifier
|
|
887
|
+
*/
|
|
888
|
+
readonly id?: string;
|
|
889
|
+
/**
|
|
890
|
+
* The description of the semantic token modifier
|
|
891
|
+
*/
|
|
892
|
+
readonly description?: string;
|
|
893
|
+
}
|
|
894
|
+
interface ISemanticTokenScopes {
|
|
895
|
+
/**
|
|
896
|
+
* Lists the languge for which the defaults are.
|
|
897
|
+
*/
|
|
898
|
+
readonly language?: string;
|
|
899
|
+
/**
|
|
900
|
+
* Maps a semantic token (described by semantic token selector) to one or more textMate scopes used to represent that token.
|
|
901
|
+
*/
|
|
902
|
+
readonly scopes?: {
|
|
903
|
+
[k: string]: string[];
|
|
904
|
+
};
|
|
905
|
+
}
|
|
906
|
+
interface IBreakpoint {
|
|
907
|
+
/**
|
|
908
|
+
* Allow breakpoints for this language.
|
|
909
|
+
*/
|
|
910
|
+
readonly language?: string;
|
|
911
|
+
/**
|
|
912
|
+
* Condition which must be true to enable breakpoints in this language. Consider matching this to the debugger when clause as appropriate.
|
|
913
|
+
*/
|
|
914
|
+
readonly when?: string;
|
|
915
|
+
}
|
|
916
|
+
interface ITerminalQuickFix {
|
|
917
|
+
/**
|
|
918
|
+
* The ID of the quick fix provider
|
|
919
|
+
*/
|
|
920
|
+
readonly id: string;
|
|
921
|
+
/**
|
|
922
|
+
* A regular expression or string to test the command line against
|
|
923
|
+
*/
|
|
924
|
+
readonly commandLineMatcher: string;
|
|
925
|
+
readonly outputMatcher: {
|
|
926
|
+
/**
|
|
927
|
+
* A regular expression or string to test the command line against
|
|
928
|
+
*/
|
|
929
|
+
readonly lineMatcher: string;
|
|
930
|
+
/**
|
|
931
|
+
* Where the search should begin in the buffer
|
|
932
|
+
*/
|
|
933
|
+
readonly anchor: 'top' | 'bottom';
|
|
934
|
+
/**
|
|
935
|
+
* The number of lines vertically from the anchor in the buffer to start matching against
|
|
936
|
+
*/
|
|
937
|
+
readonly offset: number;
|
|
938
|
+
/**
|
|
939
|
+
* The number of rows to match against, this should be as small as possible for performance reasons
|
|
940
|
+
*/
|
|
941
|
+
readonly length: number;
|
|
942
|
+
};
|
|
943
|
+
/**
|
|
944
|
+
* The command exit result to match on
|
|
945
|
+
*/
|
|
946
|
+
readonly commandExitResult: 'success' | 'error';
|
|
947
|
+
/**
|
|
948
|
+
* The kind of the resulting quick fix. This changes how the quick fix is presented. Defaults to `"fix"`.
|
|
949
|
+
*/
|
|
950
|
+
readonly kind?: 'default' | 'explain';
|
|
951
|
+
}
|
|
952
|
+
interface IInteractiveSession {
|
|
953
|
+
/**
|
|
954
|
+
* Unique identifier for this Interactive Session provider.
|
|
955
|
+
*/
|
|
956
|
+
readonly id: string;
|
|
957
|
+
/**
|
|
958
|
+
* Display name for this Interactive Session provider.
|
|
959
|
+
*/
|
|
960
|
+
readonly label: string;
|
|
961
|
+
/**
|
|
962
|
+
* An icon for this Interactive Session provider.
|
|
963
|
+
*/
|
|
964
|
+
readonly icon?: string;
|
|
965
|
+
/**
|
|
966
|
+
* A condition which must be true to enable this Interactive Session provider.
|
|
967
|
+
*/
|
|
968
|
+
readonly when?: string;
|
|
969
|
+
}
|
|
970
|
+
interface NotebookPreload {
|
|
971
|
+
/**
|
|
972
|
+
* Type of the notebook.
|
|
973
|
+
*/
|
|
974
|
+
readonly type: string;
|
|
975
|
+
/**
|
|
976
|
+
* Path to file loaded in the webview.
|
|
977
|
+
*/
|
|
978
|
+
readonly entrypoint: string;
|
|
979
|
+
/**
|
|
980
|
+
* Paths to additional resources that should be allowed in the webview.
|
|
981
|
+
*/
|
|
982
|
+
readonly localResourceRoots?: string[];
|
|
983
|
+
}
|
|
984
|
+
interface IViewsWelcome {
|
|
985
|
+
readonly view: string;
|
|
986
|
+
/**
|
|
987
|
+
* Welcome content to be displayed. The format of the contents is a subset of Markdown, with support for links only.
|
|
988
|
+
*/
|
|
989
|
+
readonly contents: string;
|
|
990
|
+
/**
|
|
991
|
+
* Condition when the welcome content should be displayed.
|
|
992
|
+
*/
|
|
993
|
+
readonly when?: string;
|
|
994
|
+
/**
|
|
995
|
+
* Group to which this welcome content belongs. Proposed API.
|
|
996
|
+
*/
|
|
997
|
+
readonly group?: string;
|
|
998
|
+
/**
|
|
999
|
+
* Condition when the welcome content buttons and command links should be enabled.
|
|
1000
|
+
*/
|
|
1001
|
+
readonly enablement?: string;
|
|
1002
|
+
}
|
|
166
1003
|
interface IExtensionContributions {
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
1004
|
+
/**
|
|
1005
|
+
* Contributes terminal functionality.
|
|
1006
|
+
*/
|
|
1007
|
+
readonly terminal?: ITerminal;
|
|
1008
|
+
/**
|
|
1009
|
+
* Contributes commands to the command palette.
|
|
1010
|
+
*/
|
|
1011
|
+
readonly commands?: ICommand[];
|
|
1012
|
+
/**
|
|
1013
|
+
* Contributes configuration settings.
|
|
1014
|
+
*/
|
|
1015
|
+
readonly configuration?: IConfiguration | IConfiguration[];
|
|
1016
|
+
/**
|
|
1017
|
+
* Contributes debug adapters.
|
|
1018
|
+
*/
|
|
1019
|
+
readonly debuggers?: IDebugger[];
|
|
1020
|
+
/**
|
|
1021
|
+
* Contributes breakpoints.
|
|
1022
|
+
*/
|
|
1023
|
+
readonly breakpoints?: IBreakpoint[];
|
|
1024
|
+
/**
|
|
1025
|
+
* Contributes textmate tokenizers.
|
|
1026
|
+
*/
|
|
1027
|
+
readonly grammars?: IGrammar[];
|
|
1028
|
+
/**
|
|
1029
|
+
* Contributes json schema configuration.
|
|
1030
|
+
*/
|
|
1031
|
+
readonly jsonValidation?: IJSONValidation[];
|
|
1032
|
+
/**
|
|
1033
|
+
* Contributes keybindings.
|
|
1034
|
+
*/
|
|
1035
|
+
readonly keybindings?: IKeyBinding[];
|
|
1036
|
+
/**
|
|
1037
|
+
* Contributes language declarations.
|
|
1038
|
+
*/
|
|
1039
|
+
readonly languages?: ILanguage[];
|
|
1040
|
+
/**
|
|
1041
|
+
* Contributes menu items to the editor
|
|
1042
|
+
*/
|
|
1043
|
+
readonly menus?: {
|
|
175
1044
|
[context: string]: IMenu[];
|
|
176
1045
|
};
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
1046
|
+
/**
|
|
1047
|
+
* Contributes submenu items to the editor
|
|
1048
|
+
*/
|
|
1049
|
+
readonly submenus?: ISubMenu[];
|
|
1050
|
+
/**
|
|
1051
|
+
* Contributes snippets.
|
|
1052
|
+
*/
|
|
1053
|
+
readonly snippets?: ISnippet[];
|
|
1054
|
+
/**
|
|
1055
|
+
* Contributes textmate color themes.
|
|
1056
|
+
*/
|
|
1057
|
+
readonly themes?: IColorTheme[];
|
|
1058
|
+
/**
|
|
1059
|
+
* Contributes file icon themes.
|
|
1060
|
+
*/
|
|
1061
|
+
readonly iconThemes?: IIconTheme[];
|
|
1062
|
+
/**
|
|
1063
|
+
* Contributes product icon themes.
|
|
1064
|
+
*/
|
|
1065
|
+
readonly productIconThemes?: IProductTheme[];
|
|
1066
|
+
/**
|
|
1067
|
+
* Contributes views containers to the editor
|
|
1068
|
+
*/
|
|
1069
|
+
readonly viewsContainers?: {
|
|
182
1070
|
[location: string]: IViewContainer[];
|
|
183
1071
|
};
|
|
184
|
-
|
|
1072
|
+
/**
|
|
1073
|
+
* Contributes views to the editor
|
|
1074
|
+
*/
|
|
1075
|
+
readonly views?: {
|
|
185
1076
|
[location: string]: IView[];
|
|
186
1077
|
};
|
|
187
|
-
|
|
188
|
-
|
|
1078
|
+
/**
|
|
1079
|
+
* Contributes extension defined themable colors
|
|
1080
|
+
*/
|
|
1081
|
+
readonly colors?: IColor[];
|
|
1082
|
+
/**
|
|
1083
|
+
* Contributes localizations to the editor
|
|
1084
|
+
*/
|
|
1085
|
+
readonly localizations?: ILocalizationContribution[];
|
|
1086
|
+
/**
|
|
1087
|
+
* Contributed custom editors.
|
|
1088
|
+
*/
|
|
189
1089
|
readonly customEditors?: readonly IWebviewEditor[];
|
|
190
1090
|
readonly codeActions?: readonly ICodeActionContribution[];
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
1091
|
+
/**
|
|
1092
|
+
* Contributes authentication
|
|
1093
|
+
*/
|
|
1094
|
+
readonly authentication?: IAuthenticationContribution[];
|
|
1095
|
+
/**
|
|
1096
|
+
* Contribute walkthroughs to help users getting started with your extension.
|
|
1097
|
+
*/
|
|
1098
|
+
readonly walkthroughs?: IWalkthrough[];
|
|
1099
|
+
readonly startEntries?: IStartEntry[];
|
|
1100
|
+
/**
|
|
1101
|
+
* Contributes notebook document provider.
|
|
1102
|
+
*/
|
|
194
1103
|
readonly notebooks?: INotebookEntry[];
|
|
1104
|
+
/**
|
|
1105
|
+
* Contributes notebook output renderer provider.
|
|
1106
|
+
*/
|
|
195
1107
|
readonly notebookRenderer?: INotebookRendererContribution[];
|
|
1108
|
+
/**
|
|
1109
|
+
* Contributes notebook preloads.
|
|
1110
|
+
*/
|
|
1111
|
+
readonly notebookPreload?: NotebookPreload[];
|
|
1112
|
+
/**
|
|
1113
|
+
* Contributes items to the status bar.
|
|
1114
|
+
*/
|
|
1115
|
+
readonly statusBarItems?: IStatusBarItem[];
|
|
1116
|
+
/**
|
|
1117
|
+
* Contributes help information for Remote
|
|
1118
|
+
*/
|
|
1119
|
+
readonly remoteHelp?: IRemoteHelp;
|
|
1120
|
+
/**
|
|
1121
|
+
* Contributes task kinds
|
|
1122
|
+
*/
|
|
1123
|
+
readonly taskDefinitions?: ITaskDefinitions[];
|
|
1124
|
+
/**
|
|
1125
|
+
* Contributes extension defined themable icons
|
|
1126
|
+
*/
|
|
1127
|
+
readonly icons?: {
|
|
1128
|
+
[id: string]: IIcon;
|
|
1129
|
+
};
|
|
1130
|
+
/**
|
|
1131
|
+
* Contributed documentation.
|
|
1132
|
+
*/
|
|
1133
|
+
readonly documentation?: IDocumentation;
|
|
1134
|
+
/**
|
|
1135
|
+
* Contributes resource label formatting rules.
|
|
1136
|
+
*/
|
|
1137
|
+
readonly resourceLabelFormatters?: IResourceLabelFormatters[];
|
|
1138
|
+
readonly configurationDefaults?: {
|
|
1139
|
+
[id: string]: any;
|
|
1140
|
+
};
|
|
1141
|
+
/**
|
|
1142
|
+
* Contributes semantic token types.
|
|
1143
|
+
*/
|
|
1144
|
+
readonly semanticTokenTypes?: ISemanticTokenTypes[];
|
|
1145
|
+
/**
|
|
1146
|
+
* Contributes semantic token modifiers.
|
|
1147
|
+
*/
|
|
1148
|
+
readonly semanticTokenModifiers?: ISemanticTokenModifiers[];
|
|
1149
|
+
/**
|
|
1150
|
+
* Contributes semantic token scope maps.
|
|
1151
|
+
*/
|
|
1152
|
+
readonly semanticTokenScopes?: ISemanticTokenScopes[];
|
|
1153
|
+
/**
|
|
1154
|
+
* Contributes terminal quick fixes.
|
|
1155
|
+
*/
|
|
1156
|
+
readonly terminalQuickFixes?: ITerminalQuickFix[];
|
|
1157
|
+
/**
|
|
1158
|
+
* Contributes an Interactive Session provider
|
|
1159
|
+
*/
|
|
1160
|
+
readonly interactiveSession?: IInteractiveSession[];
|
|
1161
|
+
/**
|
|
1162
|
+
* Contributed views welcome content. Welcome content will be rendered in tree based views whenever they have no meaningful content to display, ie. the File Explorer when no folder is open. Such content is useful as in-product documentation to drive users to use certain features before they are available. A good example would be a `Clone Repository` button in the File Explorer welcome view.
|
|
1163
|
+
*/
|
|
1164
|
+
readonly viewsWelcome?: IViewsWelcome[];
|
|
196
1165
|
}
|
|
197
1166
|
interface IExtensionCapabilities {
|
|
198
1167
|
readonly virtualWorkspaces?: ExtensionVirtualWorkspaceSupport;
|
|
@@ -340,4 +1309,4 @@ interface IRelaxedExtensionDescription extends IRelaxedExtensionManifest {
|
|
|
340
1309
|
}
|
|
341
1310
|
type IExtensionDescription = Readonly<IRelaxedExtensionDescription>;
|
|
342
1311
|
|
|
343
|
-
export { ExtensionIdentifier, ExtensionIdentifierMap, ExtensionType, type ExtensionUntrustedWorkspaceSupport, type ExtensionUntrustedWorkspaceSupportType, type ExtensionVirtualWorkspaceSupport, type ExtensionVirtualWorkspaceSupportType, type IAuthenticationContribution, type ICodeActionContribution, type ICodeActionContributionAction, type IColor, type ICommand, type IConfiguration, type
|
|
1312
|
+
export { ExtensionIdentifier, ExtensionIdentifierMap, ExtensionType, type ExtensionUntrustedWorkspaceSupport, type ExtensionUntrustedWorkspaceSupportType, type ExtensionVirtualWorkspaceSupport, type ExtensionVirtualWorkspaceSupportType, type IAuthenticationContribution, type IBreakpoint, type ICodeActionContribution, type ICodeActionContributionAction, type IColor, type IColorTheme, type ICommand, type IConfiguration, type IDebugger, type IDocumentation, type IDocumentationRefactoring, type IExtension, type IExtensionCapabilities, type IExtensionContributions, type IExtensionDescription, type IExtensionIdentifier, type IExtensionManifest, type IGrammar, type IIcon, type IIconTheme, type IInteractiveSession, type IJSONValidation, type IKeyBinding, type ILanguage, type ILocalizationContribution, type IMenu, type INotebookEntry, type INotebookRendererContribution, type IProductTheme, type IRelaxedExtensionDescription, type IRelaxedExtensionManifest, type IRemoteHelp, type ISemanticTokenModifiers, type ISemanticTokenScopes, type ISemanticTokenTypes, type ISnippet, type IStartEntry, type IStatusBarItem, type ISubMenu, type ITaskDefinitions, type ITerminal, type ITerminalQuickFix, type ITranslation, type IView, type IViewContainer, type IViewsWelcome, type IWalkthrough, type IWalkthroughStep, type LimitedWorkspaceSupportType, type NotebookPreload, TargetPlatform };
|