vscode.proposed.d.ts 52.6 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' {

J
Johannes Rieken 已提交
19 20
	// #region auth provider: https://github.com/microsoft/vscode/issues/88309

21
	export interface AuthenticationSession {
22
		id: string;
23
		accessToken(): Promise<string>;
24
		accountName: string;
25
		scopes: string[]
26 27
	}

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
	/**
	 * An [event](#Event) which fires when an [AuthenticationProvider](#AuthenticationProvider) is added or removed.
	 */
	export interface AuthenticationProvidersChangeEvent {
		/**
		 * The ids of the [authenticationProvider](#AuthenticationProvider)s that have been added.
		 */
		readonly added: string[];

		/**
		 * The ids of the [authenticationProvider](#AuthenticationProvider)s that have been removed..
		 */
		readonly removed: string[];
	}

43
	export interface AuthenticationProvider {
44 45 46 47 48
		/**
		 * Used as an identifier for extensions trying to work with a particular
		 * provider: 'Microsoft', 'GitHub', etc. id must be unique, registering
		 * another provider with the same id will fail.
		 */
49 50
		readonly id: string;
		readonly displayName: string;
51 52 53 54 55

		/**
		 * A [enent](#Event) which fires when the array of sessions has changed, or data
		 * within a session has changed.
		 */
56
		readonly onDidChangeSessions: Event<void>;
57

58 59 60
		/**
		 * Returns an array of current sessions.
		 */
61
		getSessions(): Promise<ReadonlyArray<AuthenticationSession>>;
62

63 64 65
		/**
		 * Prompts a user to login.
		 */
66
		login(scopes: string[]): Promise<AuthenticationSession>;
67
		logout(sessionId: string): Promise<void>;
68 69 70 71
	}

	export namespace authentication {
		export function registerAuthenticationProvider(provider: AuthenticationProvider): Disposable;
72 73 74 75

		/**
		 * Fires with the provider id that was registered or unregistered.
		 */
76
		export const onDidChangeAuthenticationProviders: Event<AuthenticationProvidersChangeEvent>;
77

78
		export const providers: ReadonlyArray<AuthenticationProvider>;
79 80
	}

J
Johannes Rieken 已提交
81 82
	//#endregion

83
	//#region Alex - resolvers
A
Alex Dima 已提交
84

A
Tweaks  
Alex Dima 已提交
85 86 87 88
	export interface RemoteAuthorityResolverContext {
		resolveAttempt: number;
	}

A
Alex Dima 已提交
89 90 91 92 93 94 95
	export class ResolvedAuthority {
		readonly host: string;
		readonly port: number;

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

96
	export interface ResolvedOptions {
97
		extensionHostEnv?: { [key: string]: string | null };
98 99
	}

100
	export interface TunnelOptions {
A
Alex Ross 已提交
101 102 103 104
		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;
105 106
	}

A
Alex Ross 已提交
107
	export interface TunnelDescription {
A
Alex Ross 已提交
108 109
		remoteAddress: { port: number, host: string };
		//The complete local address(ex. localhost:1234)
A
Alex Ross 已提交
110
		localAddress: string;
A
Alex Ross 已提交
111 112 113
	}

	export interface Tunnel extends TunnelDescription {
A
Alex Ross 已提交
114 115
		// Implementers of Tunnel should fire onDidDispose when dispose is called.
		onDidDispose: Event<void>;
116
		dispose(): void;
117 118 119
	}

	/**
120 121
	 * Used as part of the ResolverResult if the extension has any candidate,
	 * published, or forwarded ports.
122 123 124 125
	 */
	export interface TunnelInformation {
		/**
		 * Tunnels that are detected by the extension. The remotePort is used for display purposes.
A
Alex Ross 已提交
126
		 * The localAddress should be the complete local address (ex. localhost:1234) for connecting to the port. Tunnels provided through
127 128
		 * detected are read-only from the forwarded ports UI.
		 */
A
Alex Ross 已提交
129
		environmentTunnels?: TunnelDescription[];
A
Alex Ross 已提交
130

131 132 133
	}

	export type ResolverResult = ResolvedAuthority & ResolvedOptions & TunnelInformation;
134

A
Tweaks  
Alex Dima 已提交
135 136 137 138 139 140 141
	export class RemoteAuthorityResolverError extends Error {
		static NotAvailable(message?: string, handled?: boolean): RemoteAuthorityResolverError;
		static TemporarilyNotAvailable(message?: string): RemoteAuthorityResolverError;

		constructor(message?: string);
	}

A
Alex Dima 已提交
142
	export interface RemoteAuthorityResolver {
143
		resolve(authority: string, context: RemoteAuthorityResolverContext): ResolverResult | Thenable<ResolverResult>;
144 145 146 147 148
		/**
		 * 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 已提交
149
		tunnelFactory?: (tunnelOptions: TunnelOptions) => Thenable<Tunnel> | undefined;
150 151 152 153 154

		/**
		 * Provides filtering for candidate ports.
		 */
		showCandidatePort?: (host: string, port: number, detail: string) => Thenable<boolean>;
155 156 157 158
	}

	export namespace workspace {
		/**
159
		 * Forwards a port. If the current resolver implements RemoteAuthorityResolver:forwardPort then that will be used to make the tunnel.
A
Alex Ross 已提交
160 161
		 * 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.
162
		 */
A
Alex Ross 已提交
163
		export function openTunnel(tunnelOptions: TunnelOptions): Thenable<Tunnel>;
164 165 166 167 168 169

		/**
		 * Gets an array of the currently available tunnels. This does not include environment tunnels, only tunnels that have been created by the user.
		 * Note that these are of type TunnelDescription and cannot be disposed.
		 */
		export let tunnels: Thenable<TunnelDescription[]>;
A
Alex Ross 已提交
170 171 172

		/**
		 * Fired when the list of tunnels has changed.
173
		 * @deprecated use onDidChangeTunnels instead
A
Alex Ross 已提交
174
		 */
J
Johannes Rieken 已提交
175 176
		// TODO@alexr
		// eslint-disable-next-line vscode-dts-event-naming
A
Alex Ross 已提交
177
		export const onDidTunnelsChange: Event<void>;
178 179 180 181
		/**
		 * Fired when the list of tunnels has changed.
		 */
		export const onDidChangeTunnels: Event<void>;
A
Alex Dima 已提交
182 183
	}

184 185 186 187 188 189 190 191
	export interface ResourceLabelFormatter {
		scheme: string;
		authority?: string;
		formatting: ResourceLabelFormatting;
	}

	export interface ResourceLabelFormatting {
		label: string; // myLabel:/${path}
J
Johannes Rieken 已提交
192 193
		// TODO@isi
		// eslint-disable-next-line vscode-dts-literal-or-types
194 195 196 197 198 199 200
		separator: '/' | '\\' | '';
		tildify?: boolean;
		normalizeDriveLetter?: boolean;
		workspaceSuffix?: string;
		authorityPrefix?: string;
	}

A
Alex Dima 已提交
201 202
	export namespace workspace {
		export function registerRemoteAuthorityResolver(authorityPrefix: string, resolver: RemoteAuthorityResolver): Disposable;
203
		export function registerResourceLabelFormatter(formatter: ResourceLabelFormatter): Disposable;
204
	}
205

206 207
	//#endregion

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

210
	export class SemanticTokensLegend {
A
WIP  
Alexandru Dima 已提交
211 212 213 214 215 216
		public readonly tokenTypes: string[];
		public readonly tokenModifiers: string[];

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

217 218 219 220 221 222 223
	export class SemanticTokensBuilder {
		constructor();
		push(line: number, char: number, length: number, tokenType: number, tokenModifiers: number): void;
		build(): Uint32Array;
	}

	export class SemanticTokens {
A
Alexandru Dima 已提交
224 225 226
		/**
		 * The result id of the tokens.
		 *
227
		 * This is the id that will be passed to `DocumentSemanticTokensProvider.provideDocumentSemanticTokensEdits` (if implemented).
A
Alexandru Dima 已提交
228
		 */
229 230 231 232 233 234 235
		readonly resultId?: string;
		readonly data: Uint32Array;

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

	export class SemanticTokensEdits {
A
Alexandru Dima 已提交
236 237 238
		/**
		 * The result id of the tokens.
		 *
239
		 * This is the id that will be passed to `DocumentSemanticTokensProvider.provideDocumentSemanticTokensEdits` (if implemented).
A
Alexandru Dima 已提交
240
		 */
241 242
		readonly resultId?: string;
		readonly edits: SemanticTokensEdit[];
A
WIP  
Alexandru Dima 已提交
243

244
		constructor(edits: SemanticTokensEdit[], resultId?: string);
A
WIP  
Alexandru Dima 已提交
245 246
	}

247 248 249 250
	export class SemanticTokensEdit {
		readonly start: number;
		readonly deleteCount: number;
		readonly data?: Uint32Array;
A
WIP  
Alexandru Dima 已提交
251

252 253 254
		constructor(start: number, deleteCount: number, data?: Uint32Array);
	}

A
WIP  
Alexandru Dima 已提交
255
	/**
256
	 * The document semantic tokens provider interface defines the contract between extensions and
257
	 * semantic tokens.
A
WIP  
Alexandru Dima 已提交
258
	 */
259
	export interface DocumentSemanticTokensProvider {
A
Alex Dima 已提交
260
		/**
A
Alexandru Dima 已提交
261 262 263 264 265
		 * 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 已提交
266
		 *
A
Alexandru Dima 已提交
267
		 * ---
268
		 * In short, each token takes 5 integers to represent, so a specific token `i` in the file consists of the following array indices:
A
Alex Dima 已提交
269 270 271
		 *  - 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.
272
		 *  - at index `5*i+3` - `tokenType`: will be looked up in `SemanticTokensLegend.tokenTypes`. We currently ask that `tokenType` < 65536.
A
Alex Dima 已提交
273 274
		 *  - at index `5*i+4` - `tokenModifiers`: each set bit will be looked up in `SemanticTokensLegend.tokenModifiers`
		 *
A
Alexandru Dima 已提交
275 276 277
		 * ---
		 * ### How to encode tokens
		 *
278
		 * Here is an example for encoding a file with 3 tokens in a uint32 array:
A
Alex Dima 已提交
279
		 * ```
A
Alex Dima 已提交
280 281 282
		 *    { line: 2, startChar:  5, length: 3, tokenType: "property",  tokenModifiers: ["private", "static"] },
		 *    { line: 2, startChar: 10, length: 4, tokenType: "type",      tokenModifiers: [] },
		 *    { line: 5, startChar:  2, length: 7, tokenType: "class",     tokenModifiers: [] }
A
Alex Dima 已提交
283 284 285
		 * ```
		 *
		 * 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 已提交
286
		 * For this example, we will choose the following legend which must be passed in when registering the provider:
A
Alex Dima 已提交
287
		 * ```
A
Alex Dima 已提交
288
		 *    tokenTypes: ['property', 'type', 'class'],
A
Alexandru Dima 已提交
289
		 *    tokenModifiers: ['private', 'static']
A
Alex Dima 已提交
290 291
		 * ```
		 *
A
Alexandru Dima 已提交
292
		 * 2. The first transformation step is to encode `tokenType` and `tokenModifiers` as integers using the legend. Token types are looked
293
		 * 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 已提交
294 295
		 * 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 已提交
296
		 * ```
A
Alexandru Dima 已提交
297 298 299
		 *    { 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 已提交
300 301
		 * ```
		 *
A
Alex Dima 已提交
302
		 * 3. The next step is to represent each token relative to the previous token in the file. In this case, the second token
A
Alexandru Dima 已提交
303 304 305
		 * 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 已提交
306
		 * ```
A
Alexandru Dima 已提交
307 308 309
		 *    { 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 已提交
310 311
		 * ```
		 *
A
Alexandru Dima 已提交
312
		 * 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 已提交
313 314
		 * ```
		 *    // 1st token,  2nd token,  3rd token
A
Alexandru Dima 已提交
315
		 *    [  2,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]
A
Alex Dima 已提交
316
		 * ```
317
		 */
318
		provideDocumentSemanticTokens(document: TextDocument, token: CancellationToken): ProviderResult<SemanticTokens>;
319 320 321 322

		/**
		 * Instead of always returning all the tokens in a file, it is possible for a `DocumentSemanticTokensProvider` to implement
		 * this method (`updateSemanticTokens`) and then return incremental updates to the previously provided semantic tokens.
A
Alex Dima 已提交
323
		 *
A
Alexandru Dima 已提交
324 325 326 327 328 329 330
		 * ---
		 * ### 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 已提交
331
		 * ```
A
Alex Dima 已提交
332 333 334
		 *    { line: 3, startChar:  5, length: 3, tokenType: "property", tokenModifiers: ["private", "static"] },
		 *    { line: 3, startChar: 10, length: 4, tokenType: "type",     tokenModifiers: [] },
		 *    { line: 6, startChar:  2, length: 7, tokenType: "class",    tokenModifiers: [] }
A
Alex Dima 已提交
335
		 * ```
A
Alexandru Dima 已提交
336
		 * The integer encoding of the tokens does not change substantially because of the delta-encoding of positions:
A
Alex Dima 已提交
337
		 * ```
A
Alexandru Dima 已提交
338 339
		 *    // 1st token,  2nd token,  3rd token
		 *    [  3,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]
A
Alex Dima 已提交
340
		 * ```
A
Alexandru Dima 已提交
341 342
		 * It is possible to express these new tokens in terms of an edit applied to the previous tokens:
		 * ```
343 344
		 *    [  2,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ] // old tokens
		 *    [  3,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ] // new tokens
A
Alex Dima 已提交
345
		 *
A
Alexandru Dima 已提交
346 347
		 *    edit: { start:  0, deleteCount: 1, data: [3] } // replace integer at offset 0 with 3
		 * ```
A
Alexandru Dima 已提交
348
		 *
A
Alexandru Dima 已提交
349 350
		 * Furthermore, let's assume that a new token has appeared on line 4:
		 * ```
A
Alex Dima 已提交
351 352 353 354
		 *    { line: 3, startChar:  5, length: 3, tokenType: "property", tokenModifiers: ["private", "static"] },
		 *    { line: 3, startChar: 10, length: 4, tokenType: "type",      tokenModifiers: [] },
		 *    { line: 4, startChar:  3, length: 5, tokenType: "property", tokenModifiers: ["static"] },
		 *    { line: 6, startChar:  2, length: 7, tokenType: "class",    tokenModifiers: [] }
A
Alexandru Dima 已提交
355 356
		 * ```
		 * The integer encoding of the tokens is:
A
Alex Dima 已提交
357
		 * ```
A
Alexandru Dima 已提交
358 359
		 *    // 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 已提交
360
		 * ```
A
Alexandru Dima 已提交
361
		 * Again, it is possible to express these new tokens in terms of an edit applied to the previous tokens:
A
Alex Dima 已提交
362
		 * ```
363 364
		 *    [  3,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]               // old tokens
		 *    [  3,5,3,0,3,  0,5,4,1,0,  1,3,5,0,2,  2,2,7,2,0, ]  // new tokens
A
Alexandru Dima 已提交
365 366
		 *
		 *    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 已提交
367
		 * ```
A
Alexandru Dima 已提交
368
		 *
369 370 371
		 * *NOTE*: When doing edits, it is possible that multiple edits occur until VS Code decides to invoke the semantic tokens provider.
		 * *NOTE*: If the provider cannot compute `SemanticTokensEdits`, it can "give up" and return all the tokens in the document again.
		 * *NOTE*: All edits in `SemanticTokensEdits` contain indices in the old integers array, so they all refer to the previous result state.
A
Alex Dima 已提交
372
		 */
373 374 375 376 377 378 379 380 381 382
		provideDocumentSemanticTokensEdits?(document: TextDocument, previousResultId: string, token: CancellationToken): ProviderResult<SemanticTokens | SemanticTokensEdits>;
	}

	/**
	 * The document range semantic tokens provider interface defines the contract between extensions and
	 * semantic tokens.
	 */
	export interface DocumentRangeSemanticTokensProvider {
		/**
		 * See [provideDocumentSemanticTokens](#DocumentSemanticTokensProvider.provideDocumentSemanticTokens).
A
Alex Dima 已提交
383
		 */
384
		provideDocumentRangeSemanticTokens(document: TextDocument, range: Range, token: CancellationToken): ProviderResult<SemanticTokens>;
A
WIP  
Alexandru Dima 已提交
385 386 387 388
	}

	export namespace languages {
		/**
389
		 * Register a semantic tokens provider for a whole document.
A
WIP  
Alexandru Dima 已提交
390 391 392 393 394 395
		 *
		 * 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.
396
		 * @param provider A document semantic tokens provider.
A
WIP  
Alexandru Dima 已提交
397 398
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
399 400 401 402
		export function registerDocumentSemanticTokensProvider(selector: DocumentSelector, provider: DocumentSemanticTokensProvider, legend: SemanticTokensLegend): Disposable;

		/**
		 * Register a semantic tokens provider for a document range.
A
WIP  
Alexandru Dima 已提交
403 404 405 406 407 408
		 *
		 * 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.
409
		 * @param provider A document range semantic tokens provider.
A
WIP  
Alexandru Dima 已提交
410 411
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
412
		export function registerDocumentRangeSemanticTokensProvider(selector: DocumentSelector, provider: DocumentRangeSemanticTokensProvider, legend: SemanticTokensLegend): Disposable;
A
WIP  
Alexandru Dima 已提交
413 414 415
	}

	//#endregion
416

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

419 420
	export interface WebviewEditorInset {
		readonly editor: TextEditor;
421 422
		readonly line: number;
		readonly height: number;
423 424 425
		readonly webview: Webview;
		readonly onDidDispose: Event<void>;
		dispose(): void;
426 427
	}

428
	export namespace window {
429
		export function createWebviewTextEditorInset(editor: TextEditor, line: number, height: number, options?: WebviewOptions): WebviewEditorInset;
A
Alex Dima 已提交
430 431 432 433
	}

	//#endregion

J
Johannes Rieken 已提交
434
	//#region read/write in chunks: https://github.com/microsoft/vscode/issues/84515
435 436

	export interface FileSystemProvider {
J
Johannes Rieken 已提交
437
		open?(resource: Uri, options: { create: boolean }): number | Thenable<number>;
438 439 440 441 442 443 444
		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 已提交
445
	//#region TextSearchProvider: https://github.com/microsoft/vscode/issues/59921
446

447 448 449
	/**
	 * The parameters of a query for text search.
	 */
450
	export interface TextSearchQuery {
451 452 453
		/**
		 * The text pattern to search for.
		 */
454
		pattern: string;
455

R
Rob Lourens 已提交
456 457 458 459 460
		/**
		 * Whether or not `pattern` should match multiple lines of text.
		 */
		isMultiline?: boolean;

461 462 463
		/**
		 * Whether or not `pattern` should be interpreted as a regular expression.
		 */
R
Rob Lourens 已提交
464
		isRegExp?: boolean;
465 466 467 468

		/**
		 * Whether or not the search should be case-sensitive.
		 */
R
Rob Lourens 已提交
469
		isCaseSensitive?: boolean;
470 471 472 473

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

477 478 479 480 481 482 483 484 485 486
	/**
	 * 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 已提交
487
	export interface SearchOptions {
488 489 490
		/**
		 * The root folder to search within.
		 */
491
		folder: Uri;
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506

		/**
		 * 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 已提交
507
		useIgnoreFiles: boolean;
508 509 510 511 512

		/**
		 * Whether symlinks should be followed while searching.
		 * See the vscode setting `"search.followSymlinks"`.
		 */
R
Rob Lourens 已提交
513
		followSymlinks: boolean;
P
pkoushik 已提交
514 515 516 517 518 519

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

R
Rob Lourens 已提交
522 523
	/**
	 * Options to specify the size of the result text preview.
R
Rob Lourens 已提交
524
	 * These options don't affect the size of the match itself, just the amount of preview text.
R
Rob Lourens 已提交
525
	 */
526
	export interface TextSearchPreviewOptions {
527
		/**
R
Rob Lourens 已提交
528
		 * The maximum number of lines in the preview.
R
Rob Lourens 已提交
529
		 * Only search providers that support multiline search will ever return more than one line in the match.
530
		 */
R
Rob Lourens 已提交
531
		matchLines: number;
R
Rob Lourens 已提交
532 533 534 535

		/**
		 * The maximum number of characters included per line.
		 */
R
Rob Lourens 已提交
536
		charsPerLine: number;
537 538
	}

539 540 541
	/**
	 * Options that apply to text search.
	 */
R
Rob Lourens 已提交
542
	export interface TextSearchOptions extends SearchOptions {
543
		/**
544
		 * The maximum number of results to be returned.
545
		 */
546 547
		maxResults: number;

R
Rob Lourens 已提交
548 549 550
		/**
		 * Options to specify the size of the result text preview.
		 */
551
		previewOptions?: TextSearchPreviewOptions;
552 553 554 555

		/**
		 * Exclude files larger than `maxFileSize` in bytes.
		 */
556
		maxFileSize?: number;
557 558 559 560 561

		/**
		 * Interpret files using this encoding.
		 * See the vscode setting `"files.encoding"`
		 */
562
		encoding?: string;
563 564 565 566 567 568 569 570 571 572

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

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

575 576 577 578 579 580 581 582 583 584 585 586 587 588
	/**
	 * 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 已提交
589 590 591
	/**
	 * A preview of the text result.
	 */
592
	export interface TextSearchMatchPreview {
593
		/**
R
Rob Lourens 已提交
594
		 * The matching lines of text, or a portion of the matching line that contains the match.
595 596 597 598 599
		 */
		text: string;

		/**
		 * The Range within `text` corresponding to the text of the match.
600
		 * The number of matches must match the TextSearchMatch's range property.
601
		 */
602
		matches: Range | Range[];
603 604 605 606 607
	}

	/**
	 * A match from a text search
	 */
608
	export interface TextSearchMatch {
609 610 611
		/**
		 * The uri for the matching document.
		 */
612
		uri: Uri;
613 614

		/**
615
		 * The range of the match within the document, or multiple ranges for multiple matches.
616
		 */
617
		ranges: Range | Range[];
R
Rob Lourens 已提交
618

619
		/**
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
		 * 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.
642
		 */
643
		lineNumber: number;
644 645
	}

646 647
	export type TextSearchResult = TextSearchMatch | TextSearchContext;

R
Rob Lourens 已提交
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
	/**
	 * 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;
	}

692
	/**
R
Rob Lourens 已提交
693 694 695 696 697 698 699
	 * 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.
700
	 */
701
	export interface FileSearchProvider {
702 703 704 705 706 707
		/**
		 * 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.
		 */
708
		provideFileSearchResults(query: FileSearchQuery, options: FileSearchOptions, token: CancellationToken): ProviderResult<Uri[]>;
709
	}
710

R
Rob Lourens 已提交
711
	export namespace workspace {
712
		/**
R
Rob Lourens 已提交
713 714 715 716 717 718 719
		 * 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.
720
		 */
R
Rob Lourens 已提交
721 722 723 724 725 726 727 728 729 730 731 732
		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;
733 734
	}

R
Rob Lourens 已提交
735 736 737 738
	//#endregion

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

739 740 741
	/**
	 * Options that can be set on a findTextInFiles search.
	 */
R
Rob Lourens 已提交
742
	export interface FindTextInFilesOptions {
743 744 745 746 747
		/**
		 * 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).
		 */
748
		include?: GlobPattern;
749 750 751 752 753 754 755 756 757 758 759

		/**
		 * 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 已提交
760
		maxResults?: number;
761 762 763 764 765

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

P
pkoushik 已提交
768 769 770 771
		/**
		 * Whether global files that exclude files, like .gitignore, should be respected.
		 * See the vscode setting `"search.useGlobalIgnoreFiles"`.
		 */
772
		useGlobalIgnoreFiles?: boolean;
P
pkoushik 已提交
773

774 775 776 777
		/**
		 * Whether symlinks should be followed while searching.
		 * See the vscode setting `"search.followSymlinks"`.
		 */
R
Rob Lourens 已提交
778
		followSymlinks?: boolean;
779 780 781 782 783

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

R
Rob Lourens 已提交
786 787 788
		/**
		 * Options to specify the size of the result text preview.
		 */
789
		previewOptions?: TextSearchPreviewOptions;
790 791 792 793 794 795 796 797 798 799

		/**
		 * 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 已提交
800 801
	}

802
	export namespace workspace {
803 804 805 806 807 808 809
		/**
		 * 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.
		 */
810
		export function findTextInFiles(query: TextSearchQuery, callback: (result: TextSearchResult) => void, token?: CancellationToken): Thenable<TextSearchComplete>;
811 812 813 814 815 816 817 818 819

		/**
		 * 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.
		 */
820
		export function findTextInFiles(query: TextSearchQuery, options: FindTextInFilesOptions, callback: (result: TextSearchResult) => void, token?: CancellationToken): Thenable<TextSearchComplete>;
821 822
	}

J
Johannes Rieken 已提交
823
	//#endregion
824

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

J
Joao Moreno 已提交
827 828 829
	/**
	 * The contiguous set of modified lines in a diff.
	 */
J
Joao Moreno 已提交
830 831 832 833 834 835 836
	export interface LineChange {
		readonly originalStartLineNumber: number;
		readonly originalEndLineNumber: number;
		readonly modifiedStartLineNumber: number;
		readonly modifiedEndLineNumber: number;
	}

837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
	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;
	}
855

J
Johannes Rieken 已提交
856 857
	//#endregion

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

860
	export class Decoration {
861
		letter?: string;
862 863 864
		title?: string;
		color?: ThemeColor;
		priority?: number;
865
		bubble?: boolean;
866 867
	}

868
	export interface DecorationProvider {
869
		onDidChangeDecorations: Event<undefined | Uri | Uri[]>;
870
		provideDecoration(uri: Uri, token: CancellationToken): ProviderResult<Decoration>;
871 872 873
	}

	export namespace window {
874
		export function registerDecorationProvider(provider: DecorationProvider): Disposable;
875 876 877
	}

	//#endregion
878

879 880
	//#region Debug:

A
Andre Weinand 已提交
881 882
	// deprecated

883
	export interface DebugConfigurationProvider {
884
		/**
A
Andre Weinand 已提交
885 886
		 * Deprecated, use DebugAdapterDescriptorFactory.provideDebugAdapter instead.
		 * @deprecated Use DebugAdapterDescriptorFactory.createDebugAdapterDescriptor instead
887 888
		 */
		debugAdapterExecutable?(folder: WorkspaceFolder | undefined, token?: CancellationToken): ProviderResult<DebugAdapterExecutable>;
889 890
	}

J
Johannes Rieken 已提交
891 892
	//#endregion

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

895 896 897 898 899 900 901 902 903 904 905 906 907
	/**
	 * 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 已提交
908 909 910 911 912
	export namespace env {
		/**
		 * Current logging level.
		 */
		export const logLevel: LogLevel;
913 914 915 916 917

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

J
Johannes Rieken 已提交
920 921 922
	//#endregion

	//#region Joao: SCM validation
923

J
Joao Moreno 已提交
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
	/**
	 * 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 已提交
969

J
Johannes Rieken 已提交
970 971
	//#endregion

972 973 974 975 976 977 978 979 980 981 982 983 984
	//#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>;
985 986 987 988
	}

	//#endregion

989 990 991 992 993 994 995 996
	//#region Joao: SCM Input Box

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

		/**
997 998
		 * Controls whether the input box is visible (default is `true`).
		 */
999 1000 1001 1002 1003
		visible: boolean;
	}

	//#endregion

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

1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
	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 已提交
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
	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 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;
	}
1043

D
Daniel Imms 已提交
1044 1045 1046 1047 1048 1049 1050 1051
	namespace window {
		/**
		 * An event which fires when the [dimensions](#Terminal.dimensions) of the terminal change.
		 */
		export const onDidChangeTerminalDimensions: Event<TerminalDimensionsChangeEvent>;
	}

	export interface Terminal {
1052
		/**
1053 1054 1055
		 * 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.
1056
		 */
1057
		readonly dimensions: TerminalDimensions | undefined;
D
Daniel Imms 已提交
1058 1059
	}

1060 1061
	//#endregion

1062 1063 1064 1065 1066 1067 1068
	//#region Joh -> exclusive document filters

	export interface DocumentFilter {
		exclusive?: boolean;
	}

	//#endregion
C
Christof Marti 已提交
1069

1070 1071 1072 1073 1074 1075 1076 1077
	//#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
1078

1079
	//#region Tree View: https://github.com/microsoft/vscode/issues/61313
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
	/**
	 * Label describing the [Tree item](#TreeItem)
	 */
	export interface TreeItemLabel {

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

		/**
S
Sandeep Somavarapu 已提交
1091
		 * Ranges in the label to highlight. A range is defined as a tuple of two number where the
S
Sandeep Somavarapu 已提交
1092
		 * first is the inclusive start index and the second the exclusive end index
1093
		 */
S
Sandeep Somavarapu 已提交
1094
		highlights?: [number, number][];
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109

	}

	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);
	}
1110
	//#endregion
1111

1112
	//#region CustomExecution: https://github.com/microsoft/vscode/issues/81007
1113 1114 1115
	/**
	 * A task to execute
	 */
G
Gabriel DeBacker 已提交
1116
	export class Task2 extends Task {
1117
		detail?: string;
1118
	}
G
Gabriel DeBacker 已提交
1119

1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
	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>);
	}
1131
	//#endregion
1132

1133
	//#region Task presentation group: https://github.com/microsoft/vscode/issues/47265
1134 1135 1136 1137 1138 1139 1140
	export interface TaskPresentationOptions {
		/**
		 * Controls whether the task is executed in a specific terminal group using split panes.
		 */
		group?: string;
	}
	//#endregion
1141

1142
	//#region Status bar item with ID and Name: https://github.com/microsoft/vscode/issues/74972
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188

	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
1189

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

M
Matt Bierner 已提交
1192 1193 1194
	/**
	 * Defines the editing functionality of a webview editor. This allows the webview editor to hook into standard
	 * editor events such as `undo` or `save`.
1195
	 *
1196
	 * @param EditType Type of edits.
M
Matt Bierner 已提交
1197
	 */
1198
	interface WebviewCustomEditorEditingDelegate<EditType> {
1199
		/**
1200
		 * Save a resource.
M
Matt Bierner 已提交
1201
		 *
1202
		 * @param resource Resource being saved.
M
Matt Bierner 已提交
1203 1204
		 *
		 * @return Thenable signaling that the save has completed.
1205
		 */
1206
		save(resource: Uri): Thenable<void>;
1207

1208
		/**
1209
		 * Save an existing resource at a new path.
1210 1211 1212
		 *
		 * @param resource Resource being saved.
		 * @param targetResource Location to save to.
1213 1214
		 *
		 * @return Thenable signaling that the save has completed.
1215 1216 1217
		 */
		saveAs(resource: Uri, targetResource: Uri): Thenable<void>;

M
Matt Bierner 已提交
1218
		/**
M
Matt Bierner 已提交
1219
		 * Event triggered by extensions to signal to VS Code that an edit has occurred.
M
Matt Bierner 已提交
1220
		 */
J
Johannes Rieken 已提交
1221 1222
		// TODO@matt
		// eslint-disable-next-line vscode-dts-event-naming
1223
		readonly onEdit: Event<{ readonly resource: Uri, readonly edit: EditType }>;
M
Matt Bierner 已提交
1224 1225

		/**
1226 1227
		 * Apply a set of edits.
		 *
1228
		 * Note that is not invoked when `onEdit` is called as `onEdit` implies also updating the view to reflect the edit.
1229
		 *
1230
		 * @param resource Resource being edited.
1231
		 * @param edit Array of edits. Sorted from oldest to most recent.
1232 1233
		 *
		 * @return Thenable signaling that the change has completed.
M
Matt Bierner 已提交
1234
		 */
1235
		applyEdits(resource: Uri, edits: readonly EditType[]): Thenable<void>;
1236 1237

		/**
1238
		 * Undo a set of edits.
1239
		 *
1240
		 * This is triggered when a user undoes an edit or when revert is called on a file.
1241
		 *
1242
		 * @param resource Resource being edited.
1243
		 * @param edit Array of edits. Sorted from most recent to oldest.
1244 1245
		 *
		 * @return Thenable signaling that the change has completed.
1246
		 */
1247
		undoEdits(resource: Uri, edits: readonly EditType[]): Thenable<void>;
M
Matt Bierner 已提交
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268

		/**
		 * Back up `resource` in its current state.
		 *
		 * Backups are used for hot exit and to prevent data loss. Your `backup` method should persist the resource in
		 * its current state, i.e. with the edits applied. Most commonly this means saving the resource to disk in
		 * the `ExtensionContext.storagePath`. When VS Code reloads and your custom editor is opened for a resource,
		 * your extension should first check to see if any backups exist for the resource. If there is a backup, your
		 * extension should load the file contents from there instead of from the resource in the workspace.
		 *
		 * `backup` is triggered whenever an edit it made. Calls to `backup` are debounced so that if multiple edits are
		 * made in quick succession, `backup` is only triggered after the last one. `backup` is not invoked when
		 * `auto save` is enabled (since auto save already persists resource ).
		 *
		 * @param resource The resource to back up.
		 * @param cancellation Token that signals the current backup since a new backup is coming in. It is up to your
		 * extension to decided how to respond to cancellation. If for example your extension is backing up a large file
		 * in an operation that takes time to complete, your extension may decide to finish the ongoing backup rather
		 * than cancelling it to ensure that VS Code has some valid backup.
		 */
		backup?(resource: Uri, cancellation: CancellationToken): Thenable<boolean>;
1269
	}
1270

1271
	export interface WebviewCustomEditorProvider {
1272
		/**
M
Matt Bierner 已提交
1273 1274 1275 1276
		 * 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`.
1277
		 *
1278
		 * @param resource Resource being resolved.
1279 1280
		 * @param webview Webview being resolved. The provider should take ownership of this webview.
		 *
1281
		 * @return Thenable indicating that the webview editor has been resolved.
1282
		 */
1283
		resolveWebviewEditor(
1284
			resource: Uri,
1285
			webview: WebviewPanel,
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
		): 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>;
1296 1297 1298
	}

	namespace window {
M
Matt Bierner 已提交
1299 1300 1301 1302 1303 1304 1305
		/**
		 * 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.
		 *
1306
		 * @return Disposable that unregisters the `WebviewCustomEditorProvider`.
M
Matt Bierner 已提交
1307
		 */
1308
		export function registerWebviewCustomEditorProvider(
1309
			viewType: string,
1310
			provider: WebviewCustomEditorProvider,
1311
			options?: WebviewPanelOptions,
1312 1313 1314 1315
		): Disposable;
	}

	//#endregion
1316

P
Peter Elmers 已提交
1317

J
Johannes Rieken 已提交
1318
	//#region allow QuickPicks to skip sorting: https://github.com/microsoft/vscode/issues/73904
P
Peter Elmers 已提交
1319 1320 1321

	export interface QuickPick<T extends QuickPickItem> extends QuickInput {
		/**
1322 1323
		 * An optional flag to sort the final results by index of first query match in label. Defaults to true.
		 */
P
Peter Elmers 已提交
1324 1325 1326 1327
		sortByLabel: boolean;
	}

	//#endregion
M
Matt Bierner 已提交
1328

E
Eric Amodio 已提交
1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
	//#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 已提交
1340

M
Martin Aeschlimann 已提交
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
	//#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>;
	}

1376 1377 1378 1379 1380
	//#endregion


	//#region https://github.com/microsoft/vscode/issues/39441

P
label2  
Pine Wu 已提交
1381 1382 1383 1384
	export interface CompletionItem {
		/**
		 * Will be merged into CompletionItem#label
		 */
P
Pine Wu 已提交
1385
		label2?: CompletionItemLabel;
P
label2  
Pine Wu 已提交
1386 1387
	}

1388 1389
	export interface CompletionItemLabel {
		/**
P
Pine Wu 已提交
1390
		 * The function or variable. Rendered leftmost.
1391
		 */
P
Pine Wu 已提交
1392
		name: string;
1393

P
Pine Wu 已提交
1394
		/**
P
Pine Wu 已提交
1395
		 * The signature without the return type. Render after `name`.
P
Pine Wu 已提交
1396 1397 1398 1399
		 */
		signature?: string;

		/**
P
Pine Wu 已提交
1400
		 * The fully qualified name, like package name or file path. Rendered after `signature`.
P
Pine Wu 已提交
1401 1402
		 */
		qualifier?: string;
1403

P
Pine Wu 已提交
1404
		/**
P
Pine Wu 已提交
1405
		 * The return-type of a function or type of a property/variable. Rendered rightmost.
P
Pine Wu 已提交
1406
		 */
P
Pine Wu 已提交
1407
		type?: string;
1408 1409 1410 1411
	}

	//#endregion

1412 1413 1414

	//#region https://github.com/microsoft/vscode/issues/77728

J
Johannes Rieken 已提交
1415 1416 1417 1418 1419
	/**
	 * Additional data for entries of a workspace edit. Supports to label entries and marks entries
	 * as needing confirmation by the user. The editor groups edits with equal labels into tree nodes,
	 * for instance all edits labelled with "Changes in Strings" would be a tree node.
	 */
1420
	export interface WorkspaceEditMetadata {
J
Johannes Rieken 已提交
1421 1422 1423 1424

		/**
		 * A flag which indicates that user confirmation is needed.
		 */
1425
		needsConfirmation: boolean;
J
Johannes Rieken 已提交
1426 1427 1428 1429

		/**
		 * A human-readable string which is rendered prominent.
		 */
1430
		label: string;
J
Johannes Rieken 已提交
1431 1432 1433 1434

		/**
		 * A human-readable string which is rendered less prominent in the same line.
		 */
1435
		description?: string;
J
Johannes Rieken 已提交
1436 1437 1438 1439

		/**
		 * The icon path or [ThemeIcon](#ThemeIcon) for the edit.
		 */
1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454
		iconPath?: Uri | { light: Uri; dark: Uri } | ThemeIcon;
	}

	export interface WorkspaceEdit {

		insert(uri: Uri, position: Position, newText: string, metadata?: WorkspaceEditMetadata): void;
		delete(uri: Uri, range: Range, metadata?: WorkspaceEditMetadata): void;
		replace(uri: Uri, range: Range, newText: string, metadata?: WorkspaceEditMetadata): void;

		createFile(uri: Uri, options?: { overwrite?: boolean, ignoreIfExists?: boolean }, metadata?: WorkspaceEditMetadata): void;
		deleteFile(uri: Uri, options?: { recursive?: boolean, ignoreIfNotExists?: boolean }, metadata?: WorkspaceEditMetadata): void;
		renameFile(oldUri: Uri, newUri: Uri, options?: { overwrite?: boolean, ignoreIfExists?: boolean }, metadata?: WorkspaceEditMetadata): void;
	}

	//#endregion
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469

	//#region Diagnostic links https://github.com/microsoft/vscode/issues/11847

	export interface Diagnostic {
		/**
		 * Will be merged into `Diagnostic#code`
		 */
		code2?: {
			/**
			 * A code or identifier for this diagnostic.
			 * Should be used for later processing, e.g. when providing [code actions](#CodeActionContext).
			 */
			value: string | number;

			/**
P
Pine Wu 已提交
1470
			 * A target URI to open with more information about the diagnostic error.
1471
			 */
P
Pine Wu 已提交
1472
			target: Uri;
1473 1474 1475 1476
		}
	}

	//#endregion
1477 1478 1479 1480 1481

	//#region eamodio - timeline: https://github.com/microsoft/vscode/issues/84297

	export class TimelineItem {
		/**
1482
		 * A timestamp (in milliseconds since 1 January 1970 00:00:00) for when the timeline item occurred.
1483
		 */
E
Eric Amodio 已提交
1484
		timestamp: number;
1485 1486

		/**
1487
		 * A human-readable string describing the timeline item.
1488 1489 1490 1491
		 */
		label: string;

		/**
1492 1493 1494 1495 1496 1497
		 * Optional id for the timeline item.
		 */
		/**
		 * Optional id for the timeline item that has to be unique across your timeline source.
		 *
		 * If not provided, an id is generated using the timeline item's label.
1498 1499 1500 1501
		 */
		id?: string;

		/**
1502
		 * The icon path or [ThemeIcon](#ThemeIcon) for the timeline item.
1503
		 */
1504
		iconPath?: Uri | { light: Uri; dark: Uri } | ThemeIcon;
1505 1506

		/**
1507
		 * A human readable string describing less prominent details of the timeline item.
1508 1509 1510 1511 1512 1513
		 */
		description?: string;

		/**
		 * The tooltip text when you hover over the timeline item.
		 */
1514
		detail?: string;
1515 1516 1517 1518 1519 1520 1521

		/**
		 * The [command](#Command) that should be executed when the timeline item is selected.
		 */
		command?: Command;

		/**
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537
		 * Context value of the timeline item. This can be used to contribute specific actions to the item.
		 * For example, a timeline item is given a context value as `commit`. When contributing actions to `timeline/item/context`
		 * using `menus` extension point, you can specify context value for key `timelineItem` in `when` expression like `timelineItem == commit`.
		 * ```
		 *	"contributes": {
		 *		"menus": {
		 *			"timeline/item/context": [
		 *				{
		 *					"command": "extension.copyCommitId",
		 *					"when": "timelineItem == commit"
		 *				}
		 *			]
		 *		}
		 *	}
		 * ```
		 * This will show the `extension.copyCommitId` action only for items where `contextValue` is `commit`.
1538 1539 1540 1541 1542
		 */
		contextValue?: string;

		/**
		 * @param label A human-readable string describing the timeline item
E
Eric Amodio 已提交
1543
		 * @param timestamp A timestamp (in milliseconds since 1 January 1970 00:00:00) for when the timeline item occurred
1544
		 */
E
Eric Amodio 已提交
1545
		constructor(label: string, timestamp: number);
1546 1547
	}

1548
	export interface TimelineChangeEvent {
E
Eric Amodio 已提交
1549
		/**
1550 1551
		 * The [uri](#Uri) of the resource for which the timeline changed.
		 * If the [uri](#Uri) is `undefined` that signals that the timeline source for all resources changed.
E
Eric Amodio 已提交
1552
		 */
1553 1554
		uri?: Uri;
	}
1555

1556
	export interface TimelineProvider {
1557
		/**
1558 1559
		 * An optional event to signal that the timeline for a source has changed.
		 * To signal that the timeline for all resources (uris) has changed, do not pass any argument or pass `undefined`.
1560
		 */
1561
		onDidChange?: Event<TimelineChangeEvent>;
1562 1563

		/**
1564
		 * An identifier of the source of the timeline items. This can be used to filter sources.
1565
		 */
1566
		id: string;
1567

E
Eric Amodio 已提交
1568
		/**
1569
		 * A human-readable string describing the source of the timeline items. This can be used as the display label when filtering sources.
E
Eric Amodio 已提交
1570
		 */
1571
		label: string;
1572 1573

		/**
E
Eric Amodio 已提交
1574
		 * Provide [timeline items](#TimelineItem) for a [Uri](#Uri).
1575
		 *
1576
		 * @param uri The [uri](#Uri) of the file to provide the timeline for.
1577 1578 1579 1580
		 * @param token A cancellation token.
		 * @return An array of timeline items or a thenable that resolves to such. The lack of a result
		 * can be signaled by returning `undefined`, `null`, or an empty array.
		 */
E
Eric Amodio 已提交
1581
		provideTimeline(uri: Uri, token: CancellationToken): ProviderResult<TimelineItem[]>;
1582 1583 1584 1585 1586 1587 1588 1589 1590 1591
	}

	export namespace workspace {
		/**
		 * Register a timeline provider.
		 *
		 * Multiple providers can be registered. In that case, providers are asked in
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
		 *
1592
		 * @param scheme A scheme or schemes that defines which documents this provider is applicable to. Can be `*` to target all documents.
1593 1594
		 * @param provider A timeline provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Eric Amodio 已提交
1595
		*/
1596
		export function registerTimelineProvider(scheme: string | string[], provider: TimelineProvider): Disposable;
1597 1598 1599
	}

	//#endregion
1600 1601


J
Johannes Rieken 已提交
1602
	//#region https://github.com/microsoft/vscode/issues/90208
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613

	export interface ExtensionContext {
		/**
		 * Get the uri of a resource contained in the extension.
		 *
		 * @param relativePath A relative path to a resource contained in the extension.
		 * @return The uri of the resource.
		 */
		asExtensionUri(relativePath: string): Uri;
	}

1614 1615 1616 1617 1618 1619 1620 1621 1622 1623
	export interface Extension<T> {
		/**
		 * Get the uri of a resource contained in the extension.
		 *
		 * @param relativePath A relative path to a resource contained in the extension.
		 * @return The uri of the resource.
		 */
		asExtensionUri(relativePath: string): Uri;
	}

1624
	//#endregion
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637

	//#region https://github.com/microsoft/vscode/issues/86788

	export interface CodeActionProviderMetadata {
		/**
		 * Static documentation for a class of code actions.
		 *
		 * The documentation is shown at the
		 */
		readonly documentation?: ReadonlyArray<{ readonly kind: CodeActionKind, readonly command: Command }>;
	}

	//#endregion
J
Johannes Rieken 已提交
1638
}