vscode.proposed.d.ts 51.4 KB
Newer Older
1 2 3 4 5
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

6 7 8 9 10 11 12 13 14 15
/**
 * This is the place for API experiments and proposals.
 * These API are NOT stable and subject to change. They are only available in the Insiders
 * distribution and CANNOT be used in published extensions.
 *
 * To test these API in local environment:
 * - Use Insiders release of VS Code.
 * - Add `"enableProposedApi": true` to your package.json.
 * - Copy this file to your project.
 */
16

17 18
declare module 'vscode' {

19
	//#region Alex - resolvers, AlexR - ports
A
Alex Dima 已提交
20

A
Tweaks  
Alex Dima 已提交
21 22 23 24
	export interface RemoteAuthorityResolverContext {
		resolveAttempt: number;
	}

A
Alex Dima 已提交
25 26 27 28 29 30 31
	export class ResolvedAuthority {
		readonly host: string;
		readonly port: number;

		constructor(host: string, port: number);
	}

32
	export interface ResolvedOptions {
33
		extensionHostEnv?: { [key: string]: string | null };
34 35
	}

36
	export interface TunnelOptions {
A
Alex Ross 已提交
37 38 39 40
		remoteAddress: { port: number, host: string };
		// The desired local port. If this port can't be used, then another will be chosen.
		localAddressPort?: number;
		label?: string;
41 42
	}

43
	export interface Tunnel {
A
Alex Ross 已提交
44 45
		remoteAddress: { port: number, host: string };
		//The complete local address(ex. localhost:1234)
A
Alex Ross 已提交
46
		localAddress: string;
A
Alex Ross 已提交
47 48
		// Implementers of Tunnel should fire onDidDispose when dispose is called.
		onDidDispose: Event<void>;
49
		dispose(): void;
50 51 52 53 54 55 56 57
	}

	/**
	 * Used as part of the ResolverResult if the extension has any candidate, published, or forwarded ports.
	 */
	export interface TunnelInformation {
		/**
		 * Tunnels that are detected by the extension. The remotePort is used for display purposes.
A
Alex Ross 已提交
58
		 * The localAddress should be the complete local address (ex. localhost:1234) for connecting to the port. Tunnels provided through
59 60
		 * detected are read-only from the forwarded ports UI.
		 */
A
Alex Ross 已提交
61
		environmentTunnels?: { remoteAddress: { port: number, host: string }, localAddress: string }[];
62 63 64
	}

	export type ResolverResult = ResolvedAuthority & ResolvedOptions & TunnelInformation;
65

A
Tweaks  
Alex Dima 已提交
66 67 68 69 70 71 72
	export class RemoteAuthorityResolverError extends Error {
		static NotAvailable(message?: string, handled?: boolean): RemoteAuthorityResolverError;
		static TemporarilyNotAvailable(message?: string): RemoteAuthorityResolverError;

		constructor(message?: string);
	}

A
Alex Dima 已提交
73
	export interface RemoteAuthorityResolver {
74
		resolve(authority: string, context: RemoteAuthorityResolverContext): ResolverResult | Thenable<ResolverResult>;
75 76 77 78 79
		/**
		 * Can be optionally implemented if the extension can forward ports better than the core.
		 * When not implemented, the core will use its default forwarding logic.
		 * When implemented, the core will use this to forward ports.
		 */
A
Alex Ross 已提交
80
		tunnelFactory?: (tunnelOptions: TunnelOptions) => Thenable<Tunnel> | undefined;
81 82 83 84
	}

	export namespace workspace {
		/**
85
		 * Forwards a port. If the current resolver implements RemoteAuthorityResolver:forwardPort then that will be used to make the tunnel.
A
Alex Ross 已提交
86 87
		 * By default, openTunnel only support localhost; however, RemoteAuthorityResolver:tunnelFactory can be used to support other ips.
		 * @param tunnelOptions The `localPort` is a suggestion only. If that port is not available another will be chosen.
88
		 */
A
Alex Ross 已提交
89
		export function openTunnel(tunnelOptions: TunnelOptions): Thenable<Tunnel>;
A
Alex Dima 已提交
90 91
	}

92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
	export interface ResourceLabelFormatter {
		scheme: string;
		authority?: string;
		formatting: ResourceLabelFormatting;
	}

	export interface ResourceLabelFormatting {
		label: string; // myLabel:/${path}
		separator: '/' | '\\' | '';
		tildify?: boolean;
		normalizeDriveLetter?: boolean;
		workspaceSuffix?: string;
		authorityPrefix?: string;
	}

A
Alex Dima 已提交
107 108
	export namespace workspace {
		export function registerRemoteAuthorityResolver(authorityPrefix: string, resolver: RemoteAuthorityResolver): Disposable;
109
		export function registerResourceLabelFormatter(formatter: ResourceLabelFormatter): Disposable;
110
	}
111

112 113
	//#endregion

A
Alexandru Dima 已提交
114
	//#region Semantic tokens: https://github.com/microsoft/vscode/issues/86415
A
WIP  
Alexandru Dima 已提交
115

116
	export class SemanticTokensLegend {
A
WIP  
Alexandru Dima 已提交
117 118 119 120 121 122
		public readonly tokenTypes: string[];
		public readonly tokenModifiers: string[];

		constructor(tokenTypes: string[], tokenModifiers: string[]);
	}

123 124 125 126 127 128 129
	export class SemanticTokensBuilder {
		constructor();
		push(line: number, char: number, length: number, tokenType: number, tokenModifiers: number): void;
		build(): Uint32Array;
	}

	export class SemanticTokens {
A
Alexandru Dima 已提交
130 131 132 133 134 135
		/**
		 * The result id of the tokens.
		 *
		 * On a next call to `provideSemanticTokens`, if VS Code still holds in memory this result,
		 * the result id will be passed in as `SemanticTokensRequestOptions.previousResultId`.
		 */
136 137 138 139 140 141 142
		readonly resultId?: string;
		readonly data: Uint32Array;

		constructor(data: Uint32Array, resultId?: string);
	}

	export class SemanticTokensEdits {
A
Alexandru Dima 已提交
143 144 145 146 147 148
		/**
		 * The result id of the tokens.
		 *
		 * On a next call to `provideSemanticTokens`, if VS Code still holds in memory this result,
		 * the result id will be passed in as `SemanticTokensRequestOptions.previousResultId`.
		 */
149 150
		readonly resultId?: string;
		readonly edits: SemanticTokensEdit[];
A
WIP  
Alexandru Dima 已提交
151

152
		constructor(edits: SemanticTokensEdit[], resultId?: string);
A
WIP  
Alexandru Dima 已提交
153 154
	}

155 156 157 158
	export class SemanticTokensEdit {
		readonly start: number;
		readonly deleteCount: number;
		readonly data?: Uint32Array;
A
WIP  
Alexandru Dima 已提交
159

160 161 162 163 164
		constructor(start: number, deleteCount: number, data?: Uint32Array);
	}

	export interface SemanticTokensRequestOptions {
		readonly ranges?: readonly Range[];
A
Alexandru Dima 已提交
165 166 167 168 169
		/**
		 * The previous result id that the editor still holds in memory.
		 *
		 * Only when this is set it is safe for a `SemanticTokensProvider` to return `SemanticTokensEdits`.
		 */
170
		readonly previousResultId?: string;
A
WIP  
Alexandru Dima 已提交
171 172 173
	}

	/**
174 175
	 * The semantic tokens provider interface defines the contract between extensions and
	 * semantic tokens.
A
WIP  
Alexandru Dima 已提交
176
	 */
177
	export interface SemanticTokensProvider {
A
Alex Dima 已提交
178
		/**
A
Alexandru Dima 已提交
179 180 181 182 183
		 * A file can contain many tokens, perhaps even hundreds of thousands of tokens. Therefore, to improve
		 * the memory consumption around describing semantic tokens, we have decided to avoid allocating an object
		 * for each token and we represent tokens from a file as an array of integers. Furthermore, the position
		 * of each token is expressed relative to the token before it because most tokens remain stable relative to
		 * each other when edits are made in a file.
A
Alex Dima 已提交
184 185
		 *
		 *
A
Alexandru Dima 已提交
186 187
		 * ---
		 * In short, each token takes 5 integers to represent, so a specific token `i` in the file consists of the following fields:
A
Alex Dima 已提交
188 189 190 191 192 193 194
		 *  - at index `5*i`   - `deltaLine`: token line number, relative to the previous token
		 *  - at index `5*i+1` - `deltaStart`: token start character, relative to the previous token (relative to 0 or the previous token's start if they are on the same line)
		 *  - at index `5*i+2` - `length`: the length of the token. A token cannot be multiline.
		 *  - at index `5*i+3` - `tokenType`: will be looked up in `SemanticTokensLegend.tokenTypes`
		 *  - at index `5*i+4` - `tokenModifiers`: each set bit will be looked up in `SemanticTokensLegend.tokenModifiers`
		 *
		 *
A
Alexandru Dima 已提交
195 196 197 198
		 *
		 * ---
		 * ### How to encode tokens
		 *
A
Alex Dima 已提交
199 200
		 * Here is an example for encoding a file with 3 tokens:
		 * ```
A
Alexandru Dima 已提交
201
		 *    { line: 2, startChar:  5, length: 3, tokenType: "properties", tokenModifiers: ["private", "static"] },
A
Alex Dima 已提交
202
		 *    { line: 2, startChar: 10, length: 4, tokenType: "types",      tokenModifiers: [] },
A
Alexandru Dima 已提交
203
		 *    { line: 5, startChar:  2, length: 7, tokenType: "classes",    tokenModifiers: [] }
A
Alex Dima 已提交
204 205 206
		 * ```
		 *
		 * 1. First of all, a legend must be devised. This legend must be provided up-front and capture all possible token types.
A
Alexandru Dima 已提交
207
		 * For this example, we will choose the following legend which must be passed in when registering the provider:
A
Alex Dima 已提交
208
		 * ```
A
Alexandru Dima 已提交
209 210
		 *    tokenTypes: ['properties', 'types', 'classes'],
		 *    tokenModifiers: ['private', 'static']
A
Alex Dima 已提交
211 212
		 * ```
		 *
A
Alexandru Dima 已提交
213
		 * 2. The first transformation step is to encode `tokenType` and `tokenModifiers` as integers using the legend. Token types are looked
214
		 * up by index, so a `tokenType` value of `1` means `tokenTypes[1]`. Multiple token modifiers can be set by using bit flags,
A
Alexandru Dima 已提交
215 216
		 * so a `tokenModifier` value of `3` is first viewed as binary `0b00000011`, which means `[tokenModifiers[0], tokenModifiers[1]]` because
		 * bits 0 and 1 are set. Using this legend, the tokens now are:
A
Alex Dima 已提交
217
		 * ```
A
Alexandru Dima 已提交
218 219 220
		 *    { line: 2, startChar:  5, length: 3, tokenType: 0, tokenModifiers: 3 },
		 *    { line: 2, startChar: 10, length: 4, tokenType: 1, tokenModifiers: 0 },
		 *    { line: 5, startChar:  2, length: 7, tokenType: 2, tokenModifiers: 0 }
A
Alex Dima 已提交
221 222
		 * ```
		 *
A
Alexandru Dima 已提交
223 224 225 226
		 * 3. The next steps is to encode each token relative to the previous token in the file. In this case, the second token
		 * is on the same line as the first token, so the `startChar` of the second token is made relative to the `startChar`
		 * of the first token, so it will be `10 - 5`. The third token is on a different line than the second token, so the
		 * `startChar` of the third token will not be altered:
A
Alex Dima 已提交
227
		 * ```
A
Alexandru Dima 已提交
228 229 230
		 *    { deltaLine: 2, deltaStartChar: 5, length: 3, tokenType: 0, tokenModifiers: 3 },
		 *    { deltaLine: 0, deltaStartChar: 5, length: 4, tokenType: 1, tokenModifiers: 0 },
		 *    { deltaLine: 3, deltaStartChar: 2, length: 7, tokenType: 2, tokenModifiers: 0 }
A
Alex Dima 已提交
231 232
		 * ```
		 *
A
Alexandru Dima 已提交
233
		 * 4. Finally, the last step is to inline each of the 5 fields for a token in a single array, which is a memory friendly representation:
A
Alex Dima 已提交
234 235
		 * ```
		 *    // 1st token,  2nd token,  3rd token
A
Alexandru Dima 已提交
236
		 *    [  2,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]
A
Alex Dima 已提交
237 238 239 240
		 * ```
		 *
		 *
		 *
A
Alexandru Dima 已提交
241 242 243 244 245 246 247
		 * ---
		 * ### How tokens change when the document changes
		 *
		 * Let's look at how tokens might change.
		 *
		 * Continuing with the above example, suppose a new line was inserted at the top of the file.
		 * That would make all the tokens move down by one line (notice how the line has changed for each one):
A
Alex Dima 已提交
248
		 * ```
A
Alexandru Dima 已提交
249
		 *    { line: 3, startChar:  5, length: 3, tokenType: "properties", tokenModifiers: ["private", "static"] },
A
Alex Dima 已提交
250
		 *    { line: 3, startChar: 10, length: 4, tokenType: "types",      tokenModifiers: [] },
A
Alexandru Dima 已提交
251
		 *    { line: 6, startChar:  2, length: 7, tokenType: "classes",    tokenModifiers: [] }
A
Alex Dima 已提交
252
		 * ```
A
Alexandru Dima 已提交
253
		 * The integer encoding of the tokens does not change substantially because of the delta-encoding of positions:
A
Alex Dima 已提交
254
		 * ```
A
Alexandru Dima 已提交
255 256
		 *    // 1st token,  2nd token,  3rd token
		 *    [  3,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]
A
Alex Dima 已提交
257
		 * ```
A
Alexandru Dima 已提交
258 259 260 261
		 * It is possible to express these new tokens in terms of an edit applied to the previous tokens:
		 * ```
		 *    [  2,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]
		 *    [  3,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]
A
Alex Dima 已提交
262
		 *
A
Alexandru Dima 已提交
263 264
		 *    edit: { start:  0, deleteCount: 1, data: [3] } // replace integer at offset 0 with 3
		 * ```
A
Alexandru Dima 已提交
265
		 *
A
Alexandru Dima 已提交
266 267 268 269 270 271 272 273
		 * Furthermore, let's assume that a new token has appeared on line 4:
		 * ```
		 *    { line: 3, startChar:  5, length: 3, tokenType: "properties", tokenModifiers: ["private", "static"] },
		 *    { line: 3, startChar: 10, length: 4, tokenType: "types",      tokenModifiers: [] },
		 *    { line: 4, startChar:  3, length: 5, tokenType: "properties", tokenModifiers: ["static"] },
		 *    { line: 6, startChar:  2, length: 7, tokenType: "classes",    tokenModifiers: [] }
		 * ```
		 * The integer encoding of the tokens is:
A
Alex Dima 已提交
274
		 * ```
A
Alexandru Dima 已提交
275 276
		 *    // 1st token,  2nd token,  3rd token,  4th token
		 *    [  3,5,3,0,3,  0,5,4,1,0,  1,3,5,0,2,  2,2,7,2,0, ]
A
Alex Dima 已提交
277
		 * ```
A
Alexandru Dima 已提交
278
		 * Again, it is possible to express these new tokens in terms of an edit applied to the previous tokens:
A
Alex Dima 已提交
279
		 * ```
A
Alexandru Dima 已提交
280 281 282 283
		 *    [  3,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]
		 *    [  3,5,3,0,3,  0,5,4,1,0,  1,3,5,0,2,  2,2,7,2,0, ]
		 *
		 *    edit: { start: 10, deleteCount: 1, data: [1,3,5,0,2,2] } // replace integer at offset 10 with [1,3,5,0,2,2]
A
Alex Dima 已提交
284
		 * ```
A
Alexandru Dima 已提交
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
		 *
		 *
		 *
		 * ---
		 * ### When to return `SemanticTokensEdits`
		 *
		 * When doing edits, it is possible that multiple edits occur until VS Code decides to invoke the semantic tokens provider.
		 * In principle, each call to `provideSemanticTokens` can return a full representations of the semantic tokens, and that would
		 * be a perfectly reasonable semantic tokens provider implementation.
		 *
		 * However, when having a language server running in a separate process, transferring all the tokens between processes
		 * might be slow, so VS Code allows to return the new tokens expressed in terms of multiple edits applied to the previous
		 * tokens.
		 *
		 * To clearly define what "previous tokens" means, it is possible to return a `resultId` with the semantic tokens. If the
		 * editor still has in memory the previous result, the editor will pass in options the previous `resultId` at
		 * `SemanticTokensRequestOptions.previousResultId`. Only when the editor passes in the previous `resultId`, it is allowed
		 * that a semantic tokens provider returns the new tokens expressed as edits to be applied to the previous result. Even in this
		 * case, the semantic tokens provider needs to return a new `resultId` that will identify these new tokens as a basis
		 * for the next request.
		 *
		 * *NOTE 1*: It is illegal to return `SemanticTokensEdits` if `options.previousResultId` is not set.
		 * *NOTE 2*: All edits in `SemanticTokensEdits` contain indices in the old integers array, so they all refer to the previous result state.
A
Alex Dima 已提交
308
		 */
309
		provideSemanticTokens(document: TextDocument, options: SemanticTokensRequestOptions, token: CancellationToken): ProviderResult<SemanticTokens | SemanticTokensEdits>;
A
WIP  
Alexandru Dima 已提交
310 311 312 313
	}

	export namespace languages {
		/**
314
		 * Register a semantic tokens provider.
A
WIP  
Alexandru Dima 已提交
315 316 317 318 319 320
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
		 * of the selected provider will cause a failure of the whole operation.
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
321
		 * @param provider A semantic tokens provider.
A
WIP  
Alexandru Dima 已提交
322 323
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
324
		export function registerSemanticTokensProvider(selector: DocumentSelector, provider: SemanticTokensProvider, legend: SemanticTokensLegend): Disposable;
A
WIP  
Alexandru Dima 已提交
325 326 327
	}

	//#endregion
328

J
Johannes Rieken 已提交
329
	//#region editor insets: https://github.com/microsoft/vscode/issues/85682
330

331 332
	export interface WebviewEditorInset {
		readonly editor: TextEditor;
333 334
		readonly line: number;
		readonly height: number;
335 336 337
		readonly webview: Webview;
		readonly onDidDispose: Event<void>;
		dispose(): void;
338 339
	}

340
	export namespace window {
341
		export function createWebviewTextEditorInset(editor: TextEditor, line: number, height: number, options?: WebviewOptions): WebviewEditorInset;
A
Alex Dima 已提交
342 343 344 345
	}

	//#endregion

J
Johannes Rieken 已提交
346
	//#region read/write in chunks: https://github.com/microsoft/vscode/issues/84515
347 348

	export interface FileSystemProvider {
J
Johannes Rieken 已提交
349
		open?(resource: Uri, options: { create: boolean }): number | Thenable<number>;
350 351 352 353 354 355 356
		close?(fd: number): void | Thenable<void>;
		read?(fd: number, pos: number, data: Uint8Array, offset: number, length: number): number | Thenable<number>;
		write?(fd: number, pos: number, data: Uint8Array, offset: number, length: number): number | Thenable<number>;
	}

	//#endregion

R
Rob Lourens 已提交
357
	//#region TextSearchProvider: https://github.com/microsoft/vscode/issues/59921
358

359 360 361
	/**
	 * The parameters of a query for text search.
	 */
362
	export interface TextSearchQuery {
363 364 365
		/**
		 * The text pattern to search for.
		 */
366
		pattern: string;
367

R
Rob Lourens 已提交
368 369 370 371 372
		/**
		 * Whether or not `pattern` should match multiple lines of text.
		 */
		isMultiline?: boolean;

373 374 375
		/**
		 * Whether or not `pattern` should be interpreted as a regular expression.
		 */
R
Rob Lourens 已提交
376
		isRegExp?: boolean;
377 378 379 380

		/**
		 * Whether or not the search should be case-sensitive.
		 */
R
Rob Lourens 已提交
381
		isCaseSensitive?: boolean;
382 383 384 385

		/**
		 * Whether or not to search for whole word matches only.
		 */
R
Rob Lourens 已提交
386
		isWordMatch?: boolean;
387 388
	}

389 390 391 392 393 394 395 396 397 398
	/**
	 * A file glob pattern to match file paths against.
	 * TODO@roblou - merge this with the GlobPattern docs/definition in vscode.d.ts.
	 * @see [GlobPattern](#GlobPattern)
	 */
	export type GlobString = string;

	/**
	 * Options common to file and text search
	 */
R
Rob Lourens 已提交
399
	export interface SearchOptions {
400 401 402
		/**
		 * The root folder to search within.
		 */
403
		folder: Uri;
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418

		/**
		 * Files that match an `includes` glob pattern should be included in the search.
		 */
		includes: GlobString[];

		/**
		 * Files that match an `excludes` glob pattern should be excluded from the search.
		 */
		excludes: GlobString[];

		/**
		 * Whether external files that exclude files, like .gitignore, should be respected.
		 * See the vscode setting `"search.useIgnoreFiles"`.
		 */
R
Rob Lourens 已提交
419
		useIgnoreFiles: boolean;
420 421 422 423 424

		/**
		 * Whether symlinks should be followed while searching.
		 * See the vscode setting `"search.followSymlinks"`.
		 */
R
Rob Lourens 已提交
425
		followSymlinks: boolean;
P
pkoushik 已提交
426 427 428 429 430 431

		/**
		 * Whether global files that exclude files, like .gitignore, should be respected.
		 * See the vscode setting `"search.useGlobalIgnoreFiles"`.
		 */
		useGlobalIgnoreFiles: boolean;
432
	}
433

R
Rob Lourens 已提交
434 435
	/**
	 * Options to specify the size of the result text preview.
R
Rob Lourens 已提交
436
	 * These options don't affect the size of the match itself, just the amount of preview text.
R
Rob Lourens 已提交
437
	 */
438
	export interface TextSearchPreviewOptions {
439
		/**
R
Rob Lourens 已提交
440
		 * The maximum number of lines in the preview.
R
Rob Lourens 已提交
441
		 * Only search providers that support multiline search will ever return more than one line in the match.
442
		 */
R
Rob Lourens 已提交
443
		matchLines: number;
R
Rob Lourens 已提交
444 445 446 447

		/**
		 * The maximum number of characters included per line.
		 */
R
Rob Lourens 已提交
448
		charsPerLine: number;
449 450
	}

451 452 453
	/**
	 * Options that apply to text search.
	 */
R
Rob Lourens 已提交
454
	export interface TextSearchOptions extends SearchOptions {
455
		/**
456
		 * The maximum number of results to be returned.
457
		 */
458 459
		maxResults: number;

R
Rob Lourens 已提交
460 461 462
		/**
		 * Options to specify the size of the result text preview.
		 */
463
		previewOptions?: TextSearchPreviewOptions;
464 465 466 467

		/**
		 * Exclude files larger than `maxFileSize` in bytes.
		 */
468
		maxFileSize?: number;
469 470 471 472 473

		/**
		 * Interpret files using this encoding.
		 * See the vscode setting `"files.encoding"`
		 */
474
		encoding?: string;
475 476 477 478 479 480 481 482 483 484

		/**
		 * Number of lines of context to include before each match.
		 */
		beforeContext?: number;

		/**
		 * Number of lines of context to include after each match.
		 */
		afterContext?: number;
485 486
	}

487 488 489 490 491 492 493 494 495 496 497 498 499 500
	/**
	 * Information collected when text search is complete.
	 */
	export interface TextSearchComplete {
		/**
		 * Whether the search hit the limit on the maximum number of search results.
		 * `maxResults` on [`TextSearchOptions`](#TextSearchOptions) specifies the max number of results.
		 * - If exactly that number of matches exist, this should be false.
		 * - If `maxResults` matches are returned and more exist, this should be true.
		 * - If search hits an internal limit which is less than `maxResults`, this should be true.
		 */
		limitHit?: boolean;
	}

R
Rob Lourens 已提交
501 502 503
	/**
	 * A preview of the text result.
	 */
504
	export interface TextSearchMatchPreview {
505
		/**
R
Rob Lourens 已提交
506
		 * The matching lines of text, or a portion of the matching line that contains the match.
507 508 509 510 511
		 */
		text: string;

		/**
		 * The Range within `text` corresponding to the text of the match.
512
		 * The number of matches must match the TextSearchMatch's range property.
513
		 */
514
		matches: Range | Range[];
515 516 517 518 519
	}

	/**
	 * A match from a text search
	 */
520
	export interface TextSearchMatch {
521 522 523
		/**
		 * The uri for the matching document.
		 */
524
		uri: Uri;
525 526

		/**
527
		 * The range of the match within the document, or multiple ranges for multiple matches.
528
		 */
529
		ranges: Range | Range[];
R
Rob Lourens 已提交
530

531
		/**
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
		 * A preview of the text match.
		 */
		preview: TextSearchMatchPreview;
	}

	/**
	 * A line of context surrounding a TextSearchMatch.
	 */
	export interface TextSearchContext {
		/**
		 * The uri for the matching document.
		 */
		uri: Uri;

		/**
		 * One line of text.
		 * previewOptions.charsPerLine applies to this
		 */
		text: string;

		/**
		 * The line number of this line of context.
554
		 */
555
		lineNumber: number;
556 557
	}

558 559
	export type TextSearchResult = TextSearchMatch | TextSearchContext;

R
Rob Lourens 已提交
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
	/**
	 * A TextSearchProvider provides search results for text results inside files in the workspace.
	 */
	export interface TextSearchProvider {
		/**
		 * Provide results that match the given text pattern.
		 * @param query The parameters for this query.
		 * @param options A set of options to consider while searching.
		 * @param progress A progress callback that must be invoked for all results.
		 * @param token A cancellation token.
		 */
		provideTextSearchResults(query: TextSearchQuery, options: TextSearchOptions, progress: Progress<TextSearchResult>, token: CancellationToken): ProviderResult<TextSearchComplete>;
	}

	//#endregion

	//#region FileSearchProvider: https://github.com/microsoft/vscode/issues/73524

	/**
	 * The parameters of a query for file search.
	 */
	export interface FileSearchQuery {
		/**
		 * The search pattern to match against file paths.
		 */
		pattern: string;
	}

	/**
	 * Options that apply to file search.
	 */
	export interface FileSearchOptions extends SearchOptions {
		/**
		 * The maximum number of results to be returned.
		 */
		maxResults?: number;

		/**
		 * A CancellationToken that represents the session for this search query. If the provider chooses to, this object can be used as the key for a cache,
		 * and searches with the same session object can search the same cache. When the token is cancelled, the session is complete and the cache can be cleared.
		 */
		session?: CancellationToken;
	}

604
	/**
R
Rob Lourens 已提交
605 606 607 608 609 610 611
	 * A FileSearchProvider provides search results for files in the given folder that match a query string. It can be invoked by quickopen or other extensions.
	 *
	 * A FileSearchProvider is the more powerful of two ways to implement file search in VS Code. Use a FileSearchProvider if you wish to search within a folder for
	 * all files that match the user's query.
	 *
	 * The FileSearchProvider will be invoked on every keypress in quickopen. When `workspace.findFiles` is called, it will be invoked with an empty query string,
	 * and in that case, every file in the folder should be returned.
612
	 */
613
	export interface FileSearchProvider {
614 615 616 617 618 619
		/**
		 * Provide the set of files that match a certain file path pattern.
		 * @param query The parameters for this query.
		 * @param options A set of options to consider while searching files.
		 * @param token A cancellation token.
		 */
620
		provideFileSearchResults(query: FileSearchQuery, options: FileSearchOptions, token: CancellationToken): ProviderResult<Uri[]>;
621
	}
622

R
Rob Lourens 已提交
623
	export namespace workspace {
624
		/**
R
Rob Lourens 已提交
625 626 627 628 629 630 631
		 * Register a search provider.
		 *
		 * Only one provider can be registered per scheme.
		 *
		 * @param scheme The provider will be invoked for workspace folders that have this file scheme.
		 * @param provider The provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
632
		 */
R
Rob Lourens 已提交
633 634 635 636 637 638 639 640 641 642 643 644
		export function registerFileSearchProvider(scheme: string, provider: FileSearchProvider): Disposable;

		/**
		 * Register a text search provider.
		 *
		 * Only one provider can be registered per scheme.
		 *
		 * @param scheme The provider will be invoked for workspace folders that have this file scheme.
		 * @param provider The provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerTextSearchProvider(scheme: string, provider: TextSearchProvider): Disposable;
645 646
	}

R
Rob Lourens 已提交
647 648 649 650
	//#endregion

	//#region findTextInFiles: https://github.com/microsoft/vscode/issues/59924

651 652 653
	/**
	 * Options that can be set on a findTextInFiles search.
	 */
R
Rob Lourens 已提交
654
	export interface FindTextInFilesOptions {
655 656 657 658 659
		/**
		 * A [glob pattern](#GlobPattern) that defines the files to search for. The glob pattern
		 * will be matched against the file paths of files relative to their workspace. Use a [relative pattern](#RelativePattern)
		 * to restrict the search results to a [workspace folder](#WorkspaceFolder).
		 */
660
		include?: GlobPattern;
661 662 663 664 665 666 667 668 669 670 671

		/**
		 * A [glob pattern](#GlobPattern) that defines files and folders to exclude. The glob pattern
		 * will be matched against the file paths of resulting matches relative to their workspace. When `undefined` only default excludes will
		 * apply, when `null` no excludes will apply.
		 */
		exclude?: GlobPattern | null;

		/**
		 * The maximum number of results to search for
		 */
R
Rob Lourens 已提交
672
		maxResults?: number;
673 674 675 676 677

		/**
		 * Whether external files that exclude files, like .gitignore, should be respected.
		 * See the vscode setting `"search.useIgnoreFiles"`.
		 */
R
Rob Lourens 已提交
678
		useIgnoreFiles?: boolean;
679

P
pkoushik 已提交
680 681 682 683
		/**
		 * Whether global files that exclude files, like .gitignore, should be respected.
		 * See the vscode setting `"search.useGlobalIgnoreFiles"`.
		 */
684
		useGlobalIgnoreFiles?: boolean;
P
pkoushik 已提交
685

686 687 688 689
		/**
		 * Whether symlinks should be followed while searching.
		 * See the vscode setting `"search.followSymlinks"`.
		 */
R
Rob Lourens 已提交
690
		followSymlinks?: boolean;
691 692 693 694 695

		/**
		 * Interpret files using this encoding.
		 * See the vscode setting `"files.encoding"`
		 */
R
Rob Lourens 已提交
696
		encoding?: string;
697

R
Rob Lourens 已提交
698 699 700
		/**
		 * Options to specify the size of the result text preview.
		 */
701
		previewOptions?: TextSearchPreviewOptions;
702 703 704 705 706 707 708 709 710 711

		/**
		 * Number of lines of context to include before each match.
		 */
		beforeContext?: number;

		/**
		 * Number of lines of context to include after each match.
		 */
		afterContext?: number;
R
Rob Lourens 已提交
712 713
	}

714
	export namespace workspace {
715 716 717 718 719 720 721
		/**
		 * Search text in files across all [workspace folders](#workspace.workspaceFolders) in the workspace.
		 * @param query The query parameters for the search - the search string, whether it's case-sensitive, or a regex, or matches whole words.
		 * @param callback A callback, called for each result
		 * @param token A token that can be used to signal cancellation to the underlying search engine.
		 * @return A thenable that resolves when the search is complete.
		 */
722
		export function findTextInFiles(query: TextSearchQuery, callback: (result: TextSearchResult) => void, token?: CancellationToken): Thenable<TextSearchComplete>;
723 724 725 726 727 728 729 730 731

		/**
		 * Search text in files across all [workspace folders](#workspace.workspaceFolders) in the workspace.
		 * @param query The query parameters for the search - the search string, whether it's case-sensitive, or a regex, or matches whole words.
		 * @param options An optional set of query options. Include and exclude patterns, maxResults, etc.
		 * @param callback A callback, called for each result
		 * @param token A token that can be used to signal cancellation to the underlying search engine.
		 * @return A thenable that resolves when the search is complete.
		 */
732
		export function findTextInFiles(query: TextSearchQuery, options: FindTextInFilesOptions, callback: (result: TextSearchResult) => void, token?: CancellationToken): Thenable<TextSearchComplete>;
733 734
	}

J
Johannes Rieken 已提交
735
	//#endregion
736

J
Johannes Rieken 已提交
737
	//#region diff command: https://github.com/microsoft/vscode/issues/84899
P
Pine Wu 已提交
738

J
Joao Moreno 已提交
739 740 741
	/**
	 * The contiguous set of modified lines in a diff.
	 */
J
Joao Moreno 已提交
742 743 744 745 746 747 748
	export interface LineChange {
		readonly originalStartLineNumber: number;
		readonly originalEndLineNumber: number;
		readonly modifiedStartLineNumber: number;
		readonly modifiedEndLineNumber: number;
	}

749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
	export namespace commands {

		/**
		 * Registers a diff information command that can be invoked via a keyboard shortcut,
		 * a menu item, an action, or directly.
		 *
		 * Diff information commands are different from ordinary [commands](#commands.registerCommand) as
		 * they only execute when there is an active diff editor when the command is called, and the diff
		 * information has been computed. Also, the command handler of an editor command has access to
		 * the diff information.
		 *
		 * @param command A unique identifier for the command.
		 * @param callback A command handler function with access to the [diff information](#LineChange).
		 * @param thisArg The `this` context used when invoking the handler function.
		 * @return Disposable which unregisters this command on disposal.
		 */
		export function registerDiffInformationCommand(command: string, callback: (diff: LineChange[], ...args: any[]) => any, thisArg?: any): Disposable;
	}
767

J
Johannes Rieken 已提交
768 769
	//#endregion

J
Johannes Rieken 已提交
770
	//#region file-decorations: https://github.com/microsoft/vscode/issues/54938
771

772
	export class Decoration {
773
		letter?: string;
774 775 776
		title?: string;
		color?: ThemeColor;
		priority?: number;
777
		bubble?: boolean;
778 779
	}

780
	export interface DecorationProvider {
781
		onDidChangeDecorations: Event<undefined | Uri | Uri[]>;
782
		provideDecoration(uri: Uri, token: CancellationToken): ProviderResult<Decoration>;
783 784 785
	}

	export namespace window {
786
		export function registerDecorationProvider(provider: DecorationProvider): Disposable;
787 788 789
	}

	//#endregion
790

791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
	//#region Debug:

	export interface DebugConfigurationProvider {

		/**
		 * This hook is directly called after 'resolveDebugConfiguration' but with all variables substituted.
		 * It can be used to resolve or verify a [debug configuration](#DebugConfiguration) by filling in missing values or by adding/changing/removing attributes.
		 * If more than one debug configuration provider is registered for the same type, the 'resolveDebugConfigurationWithSubstitutedVariables' calls are chained
		 * in arbitrary order and the initial debug configuration is piped through the chain.
		 * Returning the value 'undefined' prevents the debug session from starting.
		 * Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.
		 *
		 * @param folder The workspace folder from which the configuration originates from or `undefined` for a folderless setup.
		 * @param debugConfiguration The [debug configuration](#DebugConfiguration) to resolve.
		 * @param token A cancellation token.
		 * @return The resolved debug configuration or undefined or null.
		 */
		resolveDebugConfigurationWithSubstitutedVariables?(folder: WorkspaceFolder | undefined, debugConfiguration: DebugConfiguration, token?: CancellationToken): ProviderResult<DebugConfiguration>;
	}
810

A
Andre Weinand 已提交
811 812
	// deprecated

813
	export interface DebugConfigurationProvider {
814
		/**
A
Andre Weinand 已提交
815 816
		 * Deprecated, use DebugAdapterDescriptorFactory.provideDebugAdapter instead.
		 * @deprecated Use DebugAdapterDescriptorFactory.createDebugAdapterDescriptor instead
817 818
		 */
		debugAdapterExecutable?(folder: WorkspaceFolder | undefined, token?: CancellationToken): ProviderResult<DebugAdapterExecutable>;
819 820
	}

J
Johannes Rieken 已提交
821 822
	//#endregion

R
Rob Lourens 已提交
823
	//#region LogLevel: https://github.com/microsoft/vscode/issues/85992
J
Johannes Rieken 已提交
824

825 826 827 828 829 830 831 832 833 834 835 836 837
	/**
	 * The severity level of a log message
	 */
	export enum LogLevel {
		Trace = 1,
		Debug = 2,
		Info = 3,
		Warning = 4,
		Error = 5,
		Critical = 6,
		Off = 7
	}

M
Matt Bierner 已提交
838 839 840 841 842
	export namespace env {
		/**
		 * Current logging level.
		 */
		export const logLevel: LogLevel;
843 844 845 846 847

		/**
		 * An [event](#Event) that fires when the log level has changed.
		 */
		export const onDidChangeLogLevel: Event<LogLevel>;
M
Matt Bierner 已提交
848 849
	}

J
Johannes Rieken 已提交
850 851 852
	//#endregion

	//#region Joao: SCM validation
853

J
Joao Moreno 已提交
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
	/**
	 * Represents the validation type of the Source Control input.
	 */
	export enum SourceControlInputBoxValidationType {

		/**
		 * Something not allowed by the rules of a language or other means.
		 */
		Error = 0,

		/**
		 * Something suspicious but allowed.
		 */
		Warning = 1,

		/**
		 * Something to inform about but not a problem.
		 */
		Information = 2
	}

	export interface SourceControlInputBoxValidation {

		/**
		 * The validation message to display.
		 */
		readonly message: string;

		/**
		 * The validation type.
		 */
		readonly type: SourceControlInputBoxValidationType;
	}

	/**
	 * Represents the input box in the Source Control viewlet.
	 */
	export interface SourceControlInputBox {

		/**
		 * A validation function for the input box. It's possible to change
		 * the validation provider simply by setting this property to a different function.
		 */
		validateInput?(value: string, cursorPosition: number): ProviderResult<SourceControlInputBoxValidation | undefined | null>;
	}
M
Matt Bierner 已提交
899

J
Johannes Rieken 已提交
900 901
	//#endregion

902 903 904 905 906 907 908 909 910 911 912 913 914
	//#region Joao: SCM selected provider

	export interface SourceControl {

		/**
		 * Whether the source control is selected.
		 */
		readonly selected: boolean;

		/**
		 * An event signaling when the selection state changes.
		 */
		readonly onDidChangeSelection: Event<boolean>;
915 916 917 918
	}

	//#endregion

919 920 921 922 923 924 925 926
	//#region Joao: SCM Input Box

	/**
	 * Represents the input box in the Source Control viewlet.
	 */
	export interface SourceControlInputBox {

		/**
J
Joao Moreno 已提交
927 928
			* Controls whether the input box is visible (default is `true`).
			*/
929 930 931 932 933
		visible: boolean;
	}

	//#endregion

D
Daniel Imms 已提交
934
	//#region Terminal data write event https://github.com/microsoft/vscode/issues/78502
935

936 937 938 939 940 941 942 943 944 945 946
	export interface TerminalDataWriteEvent {
		/**
		 * The [terminal](#Terminal) for which the data was written.
		 */
		readonly terminal: Terminal;
		/**
		 * The data being written.
		 */
		readonly data: string;
	}

D
Daniel Imms 已提交
947 948 949 950 951 952 953 954 955 956 957 958 959
	namespace window {
		/**
		 * An event which fires when the terminal's pty slave pseudo-device is written to. In other
		 * words, this provides access to the raw data stream from the process running within the
		 * terminal, including VT sequences.
		 */
		export const onDidWriteTerminalData: Event<TerminalDataWriteEvent>;
	}

	//#endregion

	//#region Terminal exit status https://github.com/microsoft/vscode/issues/62103

D
Daniel Imms 已提交
960 961 962 963 964 965 966 967 968 969 970
	export interface TerminalExitStatus {
		/**
		 * The exit code that a terminal exited with, it can have the following values:
		 * - Zero: the terminal process or custom execution succeeded.
		 * - Non-zero: the terminal process or custom execution failed.
		 * - `undefined`: the user forcefully closed the terminal or a custom execution exited
		 *   without providing an exit code.
		 */
		readonly code: number | undefined;
	}

D
Daniel Imms 已提交
971
	export interface Terminal {
972
		/**
D
Daniel Imms 已提交
973 974 975 976 977 978 979 980 981 982 983
		 * The exit status of the terminal, this will be undefined while the terminal is active.
		 *
		 * **Example:** Show a notification with the exit code when the terminal exits with a
		 * non-zero exit code.
		 * ```typescript
		 * window.onDidCloseTerminal(t => {
		 *   if (t.exitStatus && t.exitStatus.code) {
		 *   	vscode.window.showInformationMessage(`Exit code: ${t.exitStatus.code}`);
		 *   }
		 * });
		 * ```
984
		 */
D
Daniel Imms 已提交
985
		readonly exitStatus: TerminalExitStatus | undefined;
986 987
	}

D
Daniel Imms 已提交
988 989 990 991
	//#endregion

	//#region Terminal creation options https://github.com/microsoft/vscode/issues/63052

D
Daniel Imms 已提交
992
	export interface Terminal {
993 994 995 996 997 998
		/**
		 * The object used to initialize the terminal, this is useful for things like detecting the
		 * shell type of shells not launched by the extension or detecting what folder the shell was
		 * launched in.
		 */
		readonly creationOptions: Readonly<TerminalOptions | ExtensionTerminalOptions>;
D
Daniel Imms 已提交
999 1000
	}

J
Johannes Rieken 已提交
1001
	//#endregion
D
Daniel Imms 已提交
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017

	//#region Terminal dimensions property and change event https://github.com/microsoft/vscode/issues/55718

	/**
	 * An [event](#Event) which fires when a [Terminal](#Terminal)'s dimensions change.
	 */
	export interface TerminalDimensionsChangeEvent {
		/**
		 * The [terminal](#Terminal) for which the dimensions have changed.
		 */
		readonly terminal: Terminal;
		/**
		 * The new value for the [terminal's dimensions](#Terminal.dimensions).
		 */
		readonly dimensions: TerminalDimensions;
	}
1018

D
Daniel Imms 已提交
1019 1020 1021 1022 1023 1024 1025 1026
	namespace window {
		/**
		 * An event which fires when the [dimensions](#Terminal.dimensions) of the terminal change.
		 */
		export const onDidChangeTerminalDimensions: Event<TerminalDimensionsChangeEvent>;
	}

	export interface Terminal {
1027
		/**
1028 1029 1030
		 * The current dimensions of the terminal. This will be `undefined` immediately after the
		 * terminal is created as the dimensions are not known until shortly after the terminal is
		 * created.
1031
		 */
1032
		readonly dimensions: TerminalDimensions | undefined;
D
Daniel Imms 已提交
1033 1034
	}

1035 1036
	//#endregion

1037 1038 1039 1040 1041 1042 1043
	//#region Joh -> exclusive document filters

	export interface DocumentFilter {
		exclusive?: boolean;
	}

	//#endregion
C
Christof Marti 已提交
1044

1045 1046 1047 1048 1049 1050 1051 1052
	//#region Alex - OnEnter enhancement
	export interface OnEnterRule {
		/**
		 * This rule will only execute if the text above the this line matches this regular expression.
		 */
		oneLineAboveText?: RegExp;
	}
	//#endregion
1053

1054
	//#region Tree View: https://github.com/microsoft/vscode/issues/61313
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
	/**
	 * Label describing the [Tree item](#TreeItem)
	 */
	export interface TreeItemLabel {

		/**
		 * A human-readable string describing the [Tree item](#TreeItem).
		 */
		label: string;

		/**
S
Sandeep Somavarapu 已提交
1066
		 * Ranges in the label to highlight. A range is defined as a tuple of two number where the
S
Sandeep Somavarapu 已提交
1067
		 * first is the inclusive start index and the second the exclusive end index
1068
		 */
S
Sandeep Somavarapu 已提交
1069
		highlights?: [number, number][];
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084

	}

	export class TreeItem2 extends TreeItem {
		/**
		 * Label describing this item. When `falsy`, it is derived from [resourceUri](#TreeItem.resourceUri).
		 */
		label?: string | TreeItemLabel | /* for compilation */ any;

		/**
		 * @param label Label describing this item
		 * @param collapsibleState [TreeItemCollapsibleState](#TreeItemCollapsibleState) of the tree item. Default is [TreeItemCollapsibleState.None](#TreeItemCollapsibleState.None)
		 */
		constructor(label: TreeItemLabel, collapsibleState?: TreeItemCollapsibleState);
	}
1085
	//#endregion
1086

1087
	//#region CustomExecution: https://github.com/microsoft/vscode/issues/81007
1088 1089 1090
	/**
	 * A task to execute
	 */
G
Gabriel DeBacker 已提交
1091
	export class Task2 extends Task {
1092
		detail?: string;
1093
	}
G
Gabriel DeBacker 已提交
1094

1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
	export class CustomExecution2 extends CustomExecution {
		/**
		 * Constructs a CustomExecution task object. The callback will be executed the task is run, at which point the
		 * extension should return the Pseudoterminal it will "run in". The task should wait to do further execution until
		 * [Pseudoterminal.open](#Pseudoterminal.open) is called. Task cancellation should be handled using
		 * [Pseudoterminal.close](#Pseudoterminal.close). When the task is complete fire
		 * [Pseudoterminal.onDidClose](#Pseudoterminal.onDidClose).
		 * @param callback The callback that will be called when the task is started by a user.
		 */
		constructor(callback: (resolvedDefinition?: TaskDefinition) => Thenable<Pseudoterminal>);
	}
1106
	//#endregion
1107

1108
	//#region Task presentation group: https://github.com/microsoft/vscode/issues/47265
1109 1110 1111 1112 1113 1114 1115
	export interface TaskPresentationOptions {
		/**
		 * Controls whether the task is executed in a specific terminal group using split panes.
		 */
		group?: string;
	}
	//#endregion
1116

1117
	//#region Status bar item with ID and Name: https://github.com/microsoft/vscode/issues/74972
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163

	export namespace window {

		/**
		 * Options to configure the status bar item.
		 */
		export interface StatusBarItemOptions {

			/**
			 * A unique identifier of the status bar item. The identifier
			 * is for example used to allow a user to show or hide the
			 * status bar item in the UI.
			 */
			id: string;

			/**
			 * A human readable name of the status bar item. The name is
			 * for example used as a label in the UI to show or hide the
			 * status bar item.
			 */
			name: string;

			/**
			 * The alignment of the status bar item.
			 */
			alignment?: StatusBarAlignment;

			/**
			 * The priority of the status bar item. Higher value means the item should
			 * be shown more to the left.
			 */
			priority?: number;
		}

		/**
		 * Creates a status bar [item](#StatusBarItem).
		 *
		 * @param options The options of the item. If not provided, some default values
		 * will be assumed. For example, the `StatusBarItemOptions.id` will be the id
		 * of the extension and the `StatusBarItemOptions.name` will be the extension name.
		 * @return A new status bar item.
		 */
		export function createStatusBarItem(options?: StatusBarItemOptions): StatusBarItem;
	}

	//#endregion
1164

J
Johannes Rieken 已提交
1165
	//#region Custom editors: https://github.com/microsoft/vscode/issues/77131
1166

M
Matt Bierner 已提交
1167 1168 1169
	/**
	 * Defines the editing functionality of a webview editor. This allows the webview editor to hook into standard
	 * editor events such as `undo` or `save`.
1170 1171
	 *
	 * @param EditType Type of edits. Edit objects must be json serializable.
M
Matt Bierner 已提交
1172
	 */
1173
	interface WebviewCustomEditorEditingDelegate<EditType> {
1174
		/**
1175
		 * Save a resource.
M
Matt Bierner 已提交
1176
		 *
1177
		 * @param resource Resource being saved.
M
Matt Bierner 已提交
1178 1179
		 *
		 * @return Thenable signaling that the save has completed.
1180
		 */
1181
		save(resource: Uri): Thenable<void>;
1182

1183
		/**
1184
		 * Save an existing resource at a new path.
1185 1186 1187
		 *
		 * @param resource Resource being saved.
		 * @param targetResource Location to save to.
1188 1189
		 *
		 * @return Thenable signaling that the save has completed.
1190 1191 1192
		 */
		saveAs(resource: Uri, targetResource: Uri): Thenable<void>;

M
Matt Bierner 已提交
1193
		/**
M
Matt Bierner 已提交
1194
		 * Event triggered by extensions to signal to VS Code that an edit has occurred.
M
Matt Bierner 已提交
1195
		 */
1196
		readonly onEdit: Event<{ readonly resource: Uri, readonly edit: EditType }>;
M
Matt Bierner 已提交
1197 1198

		/**
1199 1200
		 * Apply a set of edits.
		 *
1201
		 * Note that is not invoked when `onEdit` is called as `onEdit` implies also updating the view to reflect the edit.
1202
		 *
1203
		 * @param resource Resource being edited.
1204
		 * @param edit Array of edits. Sorted from oldest to most recent.
1205 1206
		 *
		 * @return Thenable signaling that the change has completed.
M
Matt Bierner 已提交
1207
		 */
1208
		applyEdits(resource: Uri, edits: readonly EditType[]): Thenable<void>;
1209 1210

		/**
1211
		 * Undo a set of edits.
1212
		 *
1213
		 * This is triggered when a user undoes an edit or when revert is called on a file.
1214
		 *
1215
		 * @param resource Resource being edited.
1216
		 * @param edit Array of edits. Sorted from most recent to oldest.
1217 1218
		 *
		 * @return Thenable signaling that the change has completed.
1219
		 */
1220
		undoEdits(resource: Uri, edits: readonly EditType[]): Thenable<void>;
1221
	}
1222

1223
	export interface WebviewCustomEditorProvider {
1224
		/**
M
Matt Bierner 已提交
1225 1226 1227 1228
		 * Resolve a webview editor for a given resource.
		 *
		 * To resolve a webview editor, a provider must fill in its initial html content and hook up all
		 * the event listeners it is interested it. The provider should also take ownership of the passed in `WebviewPanel`.
1229
		 *
1230
		 * @param resource Resource being resolved.
1231 1232
		 * @param webview Webview being resolved. The provider should take ownership of this webview.
		 *
1233
		 * @return Thenable indicating that the webview editor has been resolved.
1234
		 */
1235
		resolveWebviewEditor(
1236
			resource: Uri,
1237
			webview: WebviewPanel,
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
		): Thenable<void>;

		/**
		 * Controls the editing functionality of a webview editor. This allows the webview editor to hook into standard
		 * editor events such as `undo` or `save`.
		 *
		 * WebviewEditors that do not have `editingCapability` are considered to be readonly. Users can still interact
		 * with readonly editors, but these editors will not integrate with VS Code's standard editor functionality.
		 */
		readonly editingDelegate?: WebviewCustomEditorEditingDelegate<unknown>;
1248 1249 1250
	}

	namespace window {
M
Matt Bierner 已提交
1251 1252 1253 1254 1255 1256 1257
		/**
		 * Register a new provider for webview editors of a given type.
		 *
		 * @param viewType  Type of the webview editor provider.
		 * @param provider Resolves webview editors.
		 * @param options Content settings for a webview panels the provider is given.
		 *
1258
		 * @return Disposable that unregisters the `WebviewCustomEditorProvider`.
M
Matt Bierner 已提交
1259
		 */
1260
		export function registerWebviewCustomEditorProvider(
1261
			viewType: string,
1262
			provider: WebviewCustomEditorProvider,
1263
			options?: WebviewPanelOptions,
1264 1265 1266 1267
		): Disposable;
	}

	//#endregion
1268

J
Johannes Rieken 已提交
1269
	//#region insert/replace completions: https://github.com/microsoft/vscode/issues/10266
1270 1271

	export interface CompletionItem {
1272 1273

		/**
1274
		 * A range or a insert and replace range selecting the text that should be replaced by this completion item.
1275
		 *
1276 1277 1278
		 * When omitted, the range of the [current word](#TextDocument.getWordRangeAtPosition) is used as replace-range
		 * and as insert-range the start of the [current word](#TextDocument.getWordRangeAtPosition) to the
		 * current position is used.
1279
		 *
1280 1281 1282
		 * *Note 1:* A range must be a [single line](#Range.isSingleLine) and it must
		 * [contain](#Range.contains) the position at which completion has been [requested](#CompletionItemProvider.provideCompletionItems).
		 * *Note 2:* A insert range must be a prefix of a replace range, that means it must be contained and starting at the same position.
1283
		 */
1284
		range2?: Range | { inserting: Range; replacing: Range; };
1285 1286 1287
	}

	//#endregion
P
Peter Elmers 已提交
1288

J
Johannes Rieken 已提交
1289
	//#region allow QuickPicks to skip sorting: https://github.com/microsoft/vscode/issues/73904
P
Peter Elmers 已提交
1290 1291 1292 1293 1294 1295 1296 1297 1298

	export interface QuickPick<T extends QuickPickItem> extends QuickInput {
		/**
		* An optional flag to sort the final results by index of first query match in label. Defaults to true.
		*/
		sortByLabel: boolean;
	}

	//#endregion
M
Matt Bierner 已提交
1299

J
Johannes Rieken 已提交
1300
	//#region Surfacing reasons why a code action cannot be applied to users: https://github.com/microsoft/vscode/issues/85160
M
Matt Bierner 已提交
1301 1302 1303 1304 1305

	export interface CodeAction {
		/**
		 * Marks that the code action cannot currently be applied.
		 *
M
Matt Bierner 已提交
1306
		 * Disabled code actions will be surfaced in the refactor UI but cannot be applied.
M
Matt Bierner 已提交
1307
		 */
M
Matt Bierner 已提交
1308 1309 1310 1311 1312 1313 1314 1315
		disabled?: {
			/**
			 * Human readable description of why the code action is currently disabled.
			 *
			 * This is displayed in the UI.
			 */
			reason: string;
		};
M
Matt Bierner 已提交
1316 1317 1318
	}

	//#endregion
E
Eric Amodio 已提交
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330

	//#region Allow theme icons in hovers: https://github.com/microsoft/vscode/issues/84695

	export interface MarkdownString {

		/**
		 * Indicates that this markdown string can contain [ThemeIcons](#ThemeIcon), e.g. `$(zap)`.
		 */
		readonly supportThemeIcons?: boolean;
	}

	//#endregion
S
Sandeep Somavarapu 已提交
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445

	//#region Language specific settings: https://github.com/microsoft/vscode/issues/26707

	export type ConfigurationScope = Uri | TextDocument | WorkspaceFolder | { resource: Uri, languageId: string };

	/**
	 * An event describing the change in Configuration
	 */
	export interface ConfigurationChangeEvent {

		/**
		 * Returns `true` if the given section is affected in the provided scope.
		 *
		 * @param section Configuration name, supports _dotted_ names.
		 * @param scope A scope in which to check.
		 * @return `true` if the given section is affected in the provided scope.
		 */
		affectsConfiguration(section: string, scope?: ConfigurationScope): boolean;
	}

	export namespace workspace {

		/**
		 * Get a workspace configuration object.
		 *
		 * When a section-identifier is provided only that part of the configuration
		 * is returned. Dots in the section-identifier are interpreted as child-access,
		 * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting').get('doIt') === true`.
		 *
		 * When a scope is provided configuraiton confined to that scope is returned. Scope can be a resource or a language identifier or both.
		 *
		 * @param section A dot-separated identifier.
		 * @return The full configuration or a subset.
		 */
		export function getConfiguration(section?: string | undefined, scope?: ConfigurationScope | null): WorkspaceConfiguration;

	}

	/**
	 * Represents the configuration. It is a merged view of
	 *
	 * - *Default Settings*
	 * - *Global (User) Settings*
	 * - *Workspace settings*
	 * - *Workspace Folder settings* - From one of the [Workspace Folders](#workspace.workspaceFolders) under which requested resource belongs to.
	 * - *Language settings* - Settings defined under requested language.
	 *
	 * The *effective* value (returned by [`get`](#WorkspaceConfiguration.get)) is computed by overriding or merging the values in the following order.
	 *
	 * ```
	 * `defaultValue`
	 * `globalValue` (if defined)
	 * `workspaceValue` (if defined)
	 * `workspaceFolderValue` (if defined)
	 * `defaultLanguageValue` (if defined)
	 * `globalLanguageValue` (if defined)
	 * `workspaceLanguageValue` (if defined)
	 * `workspaceLanguageValue` (if defined)
	 * ```
	 * **Note:** Only `object` value types are merged and all other value types are overridden.
	 *
	 * Example 1: Overriding
	 *
	 * ```ts
	 * defaultValue = 'on';
	 * globalValue = 'relative'
	 * workspaceFolderValue = 'off'
	 * value = 'off'
	 * ```
	 *
	 * Example 2: Language Values
	 *
	 * ```ts
	 * defaultValue = 'on';
	 * globalValue = 'relative'
	 * workspaceFolderValue = 'off'
	 * globalLanguageValue = 'on'
	 * value = 'on'
	 * ```
	 *
	 * Example 3: Object Values
	 *
	 * ```ts
	 * defaultValue = { "a": 1, "b": 2 };
	 * globalValue = { "b": 3, "c": 4 };
	 * value = { "a": 1, "b": 3, "c": 4 };
	 * ```
	 *
	 * *Note:* Workspace and Workspace Folder configurations contains `launch` and `tasks` settings. Their basename will be
	 * part of the section identifier. The following snippets shows how to retrieve all configurations
	 * from `launch.json`:
	 *
	 * ```ts
	 * // launch.json configuration
	 * const config = workspace.getConfiguration('launch', vscode.workspace.workspaceFolders[0].uri);
	 *
	 * // retrieve values
	 * const values = config.get('configurations');
	 * ```
	 *
	 * Refer to [Settings](https://code.visualstudio.com/docs/getstarted/settings) for more information.
	 */
	export interface WorkspaceConfiguration {

		/**
		 * Retrieve all information about a configuration setting. A configuration value
		 * often consists of a *default* value, a global or installation-wide value,
		 * a workspace-specific value, folder-specific value
		 * and language-specific values (if [WorkspaceConfiguration](#WorkspaceConfiguration) is scoped to a language).
		 *
		 * *Note:* The configuration name must denote a leaf in the configuration tree
		 * (`editor.fontSize` vs `editor`) otherwise no result is returned.
		 *
		 * @param section Configuration name, supports _dotted_ names.
		 * @return Information about a configuration setting or `undefined`.
M
Matt Bierner 已提交
1446
		 */
S
Sandeep Somavarapu 已提交
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
		inspect<T>(section: string): {
			key: string;

			defaultValue?: T;
			globalValue?: T;
			workspaceValue?: T,
			workspaceFolderValue?: T,

			defaultLanguageValue?: T;
			userLanguageValue?: T;
			workspaceLanguageValue?: T;
			workspaceFolderLanguageValue?: T;

		} | undefined;

		/**
		 * Update a configuration value. The updated configuration values are persisted.
		 *
		 * A value can be changed in
		 *
		 * - [Global settings](#ConfigurationTarget.Global): Changes the value for all instances of the editor.
		 * - [Workspace settings](#ConfigurationTarget.Workspace): Changes the value for current workspace, if available.
		 * - [Workspace folder settings](#ConfigurationTarget.WorkspaceFolder): Changes the value for settings from one of the [Workspace Folders](#workspace.workspaceFolders) under which the requested resource belongs to.
		 * - Language settings: Changes the value for the requested languageId.
		 *
		 * *Note:* To remove a configuration value use `undefined`, like so: `config.update('somekey', undefined)`
		 *
		 * @param section Configuration name, supports _dotted_ names.
		 * @param value The new value.
		 * @param configurationTarget The [configuration target](#ConfigurationTarget) or a boolean value.
		 *	- If `true` updates [Global settings](#ConfigurationTarget.Global).
		 *	- If `false` updates [Workspace settings](#ConfigurationTarget.Workspace).
		 *	- If `undefined` or `null` updates to [Workspace folder settings](#ConfigurationTarget.WorkspaceFolder) if configuration is resource specific,
		 * 	otherwise to [Workspace settings](#ConfigurationTarget.Workspace).
		 * @param scopeToLanguage Whether to update the value in the scope of requested languageId or not.
		 *	- If `true` updates the value under the requested languageId.
		 *	- If `undefined` updates the value under the requested languageId only if the configuration is defined for the language.
		 * @throws error while updating
		 *	- configuration which is not registered.
		 *	- window configuration to workspace folder
		 *	- configuration to workspace or workspace folder when no workspace is opened.
		 *	- configuration to workspace folder when there is no workspace folder settings.
		 *	- configuration to workspace folder when [WorkspaceConfiguration](#WorkspaceConfiguration) is not scoped to a resource.
		 */
		update(section: string, value: any, configurationTarget?: ConfigurationTarget | boolean, scopeToLanguage?: boolean): Thenable<void>;
M
Matt Bierner 已提交
1492 1493 1494
	}

	//#endregion
M
Martin Aeschlimann 已提交
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530

	//#region color theme access

	/**
	 * Represents a color theme kind.
	 */
	export enum ColorThemeKind {
		Light = 1,
		Dark = 2,
		HighContrast = 3
	}

	/**
	 * Represents a color theme.
	 */
	export interface ColorTheme {

		/**
		 * The kind of this color theme: light, dark or high contrast.
		 */
		readonly kind: ColorThemeKind;
	}

	export namespace window {
		/**
		 * The currently active color theme as configured in the settings. The active
		 * theme can be changed via the `workbench.colorTheme` setting.
		 */
		export let activeColorTheme: ColorTheme;

		/**
		 * An [event](#Event) which fires when the active theme changes or one of it's colors chnage.
		 */
		export const onDidChangeActiveColorTheme: Event<ColorTheme>;
	}

J
Johannes Rieken 已提交
1531
}