vscode.proposed.d.ts 63.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 22 23 24 25 26 27
	/**
	 * 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.
		 */
28
		readonly added: ReadonlyArray<AuthenticationProviderInformation>;
29 30

		/**
31
		 * The ids of the [authenticationProvider](#AuthenticationProvider)s that have been removed.
32
		 */
33
		readonly removed: ReadonlyArray<AuthenticationProviderInformation>;
34 35
	}

36 37 38
	/**
	* An [event](#Event) which fires when an [AuthenticationSession](#AuthenticationSession) is added, removed, or changed.
	*/
39
	export interface AuthenticationProviderAuthenticationSessionsChangeEvent {
40 41 42
		/**
		 * The ids of the [AuthenticationSession](#AuthenticationSession)s that have been added.
		*/
43
		readonly added: ReadonlyArray<string>;
44 45 46 47

		/**
		 * The ids of the [AuthenticationSession](#AuthenticationSession)s that have been removed.
		 */
48
		readonly removed: ReadonlyArray<string>;
49 50 51 52

		/**
		 * The ids of the [AuthenticationSession](#AuthenticationSession)s that have been changed.
		 */
53
		readonly changed: ReadonlyArray<string>;
54 55
	}

56 57 58 59 60
	/**
	 * **WARNING** When writing an AuthenticationProvider, `id` should be treated as part of your extension's
	 * API, changing it is a breaking change for all extensions relying on the provider. The id is
	 * treated case-sensitively.
	 */
61
	export interface AuthenticationProvider {
62 63
		/**
		 * Used as an identifier for extensions trying to work with a particular
64
		 * provider: 'microsoft', 'github', etc. id must be unique, registering
65 66
		 * another provider with the same id will fail.
		 */
67
		readonly id: string;
68

69
		/**
70
		 * The human-readable name of the provider.
71
		 */
72
		readonly label: string;
73 74 75 76 77

		/**
		 * Whether it is possible to be signed into multiple accounts at once with this provider
		*/
		readonly supportsMultipleAccounts: boolean;
78 79

		/**
80
		 * An [event](#Event) which fires when the array of sessions has changed, or data
81 82
		 * within a session has changed.
		 */
83
		readonly onDidChangeSessions: Event<AuthenticationProviderAuthenticationSessionsChangeEvent>;
84

85 86 87
		/**
		 * Returns an array of current sessions.
		 */
88
		getSessions(): Thenable<ReadonlyArray<AuthenticationSession>>;
89

90 91 92
		/**
		 * Prompts a user to login.
		 */
93
		login(scopes: string[]): Thenable<AuthenticationSession>;
94 95 96 97 98

		/**
		 * Removes the session corresponding to session id.
		 * @param sessionId The session id to log out of
		 */
99
		logout(sessionId: string): Thenable<void>;
100 101 102
	}

	export namespace authentication {
103 104 105 106 107 108 109 110 111
		/**
		 * Register an authentication provider.
		 *
		 * There can only be one provider per id and an error is being thrown when an id
		 * has already been used by another provider.
		 *
		 * @param provider The authentication provider provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
112
		export function registerAuthenticationProvider(provider: AuthenticationProvider): Disposable;
113 114

		/**
115
		 * @deprecated - getSession should now trigger extension activation.
116 117
		 * Fires with the provider id that was registered or unregistered.
		 */
118
		export const onDidChangeAuthenticationProviders: Event<AuthenticationProvidersChangeEvent>;
119

120
		/**
121
		 * @deprecated
122 123
		 * The ids of the currently registered authentication providers.
		 * @returns An array of the ids of authentication providers that are currently registered.
124
		 */
125
		export function getProviderIds(): Thenable<ReadonlyArray<string>>;
126 127

		/**
128
		 * @deprecated
129
		 * An array of the ids of authentication providers that are currently registered.
130
		 */
131
		export const providerIds: ReadonlyArray<string>;
132 133

		/**
134 135 136
		 * An array of the information of authentication providers that are currently registered.
		 */
		export const providers: ReadonlyArray<AuthenticationProviderInformation>;
137

138
		/**
139
		 * @deprecated
140 141 142 143 144 145
		* Logout of a specific session.
		* @param providerId The id of the provider to use
		* @param sessionId The session id to remove
		* provider
		*/
		export function logout(providerId: string, sessionId: string): Thenable<void>;
146 147
	}

J
Johannes Rieken 已提交
148 149
	//#endregion

A
Alex Ross 已提交
150
	//#region @alexdima - resolvers
A
Alex Dima 已提交
151

A
Tweaks  
Alex Dima 已提交
152 153 154 155
	export interface RemoteAuthorityResolverContext {
		resolveAttempt: number;
	}

A
Alex Dima 已提交
156 157 158 159 160 161 162
	export class ResolvedAuthority {
		readonly host: string;
		readonly port: number;

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

163
	export interface ResolvedOptions {
R
rebornix 已提交
164
		extensionHostEnv?: { [key: string]: string | null; };
165 166
	}

167
	export interface TunnelOptions {
R
rebornix 已提交
168
		remoteAddress: { port: number, host: string; };
A
Alex Ross 已提交
169 170 171
		// The desired local port. If this port can't be used, then another will be chosen.
		localAddressPort?: number;
		label?: string;
172 173
	}

A
Alex Ross 已提交
174
	export interface TunnelDescription {
R
rebornix 已提交
175
		remoteAddress: { port: number, host: string; };
A
Alex Ross 已提交
176
		//The complete local address(ex. localhost:1234)
R
rebornix 已提交
177
		localAddress: { port: number, host: string; } | string;
A
Alex Ross 已提交
178 179 180
	}

	export interface Tunnel extends TunnelDescription {
A
Alex Ross 已提交
181 182
		// Implementers of Tunnel should fire onDidDispose when dispose is called.
		onDidDispose: Event<void>;
183
		dispose(): void;
184 185 186
	}

	/**
187 188
	 * Used as part of the ResolverResult if the extension has any candidate,
	 * published, or forwarded ports.
189 190 191 192
	 */
	export interface TunnelInformation {
		/**
		 * Tunnels that are detected by the extension. The remotePort is used for display purposes.
A
Alex Ross 已提交
193
		 * The localAddress should be the complete local address (ex. localhost:1234) for connecting to the port. Tunnels provided through
194 195
		 * detected are read-only from the forwarded ports UI.
		 */
A
Alex Ross 已提交
196
		environmentTunnels?: TunnelDescription[];
A
Alex Ross 已提交
197

198 199 200
	}

	export type ResolverResult = ResolvedAuthority & ResolvedOptions & TunnelInformation;
201

A
Tweaks  
Alex Dima 已提交
202 203 204 205 206 207 208
	export class RemoteAuthorityResolverError extends Error {
		static NotAvailable(message?: string, handled?: boolean): RemoteAuthorityResolverError;
		static TemporarilyNotAvailable(message?: string): RemoteAuthorityResolverError;

		constructor(message?: string);
	}

A
Alex Dima 已提交
209
	export interface RemoteAuthorityResolver {
210
		resolve(authority: string, context: RemoteAuthorityResolverContext): ResolverResult | Thenable<ResolverResult>;
211 212 213 214 215
		/**
		 * 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 已提交
216
		tunnelFactory?: (tunnelOptions: TunnelOptions) => Thenable<Tunnel> | undefined;
217 218 219 220 221

		/**
		 * Provides filtering for candidate ports.
		 */
		showCandidatePort?: (host: string, port: number, detail: string) => Thenable<boolean>;
222 223 224 225
	}

	export namespace workspace {
		/**
226
		 * Forwards a port. If the current resolver implements RemoteAuthorityResolver:forwardPort then that will be used to make the tunnel.
A
Alex Ross 已提交
227
		 * By default, openTunnel only support localhost; however, RemoteAuthorityResolver:tunnelFactory can be used to support other ips.
228 229 230
		 *
		 * @throws When run in an environment without a remote.
		 *
A
Alex Ross 已提交
231
		 * @param tunnelOptions The `localPort` is a suggestion only. If that port is not available another will be chosen.
232
		 */
A
Alex Ross 已提交
233
		export function openTunnel(tunnelOptions: TunnelOptions): Thenable<Tunnel>;
234 235 236 237 238 239

		/**
		 * 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 已提交
240

241 242 243 244
		/**
		 * Fired when the list of tunnels has changed.
		 */
		export const onDidChangeTunnels: Event<void>;
A
Alex Dima 已提交
245 246
	}

247 248 249 250 251 252 253 254
	export interface ResourceLabelFormatter {
		scheme: string;
		authority?: string;
		formatting: ResourceLabelFormatting;
	}

	export interface ResourceLabelFormatting {
		label: string; // myLabel:/${path}
I
isidor 已提交
255
		// For historic reasons we use an or string here. Once we finalize this API we should start using enums instead and adopt it in extensions.
J
Johannes Rieken 已提交
256
		// eslint-disable-next-line vscode-dts-literal-or-types
257 258 259 260 261
		separator: '/' | '\\' | '';
		tildify?: boolean;
		normalizeDriveLetter?: boolean;
		workspaceSuffix?: string;
		authorityPrefix?: string;
262
		stripPathStartingSeparator?: boolean;
263 264
	}

A
Alex Dima 已提交
265 266
	export namespace workspace {
		export function registerRemoteAuthorityResolver(authorityPrefix: string, resolver: RemoteAuthorityResolver): Disposable;
267
		export function registerResourceLabelFormatter(formatter: ResourceLabelFormatter): Disposable;
268
	}
269

270 271
	//#endregion

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

274 275
	export interface WebviewEditorInset {
		readonly editor: TextEditor;
276 277
		readonly line: number;
		readonly height: number;
278 279 280
		readonly webview: Webview;
		readonly onDidDispose: Event<void>;
		dispose(): void;
281 282
	}

283
	export namespace window {
284
		export function createWebviewTextEditorInset(editor: TextEditor, line: number, height: number, options?: WebviewOptions): WebviewEditorInset;
A
Alex Dima 已提交
285 286 287 288
	}

	//#endregion

J
Johannes Rieken 已提交
289
	//#region read/write in chunks: https://github.com/microsoft/vscode/issues/84515
290 291

	export interface FileSystemProvider {
R
rebornix 已提交
292
		open?(resource: Uri, options: { create: boolean; }): number | Thenable<number>;
293 294 295 296 297 298 299
		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 已提交
300
	//#region TextSearchProvider: https://github.com/microsoft/vscode/issues/59921
301

302 303 304
	/**
	 * The parameters of a query for text search.
	 */
305
	export interface TextSearchQuery {
306 307 308
		/**
		 * The text pattern to search for.
		 */
309
		pattern: string;
310

R
Rob Lourens 已提交
311 312 313 314 315
		/**
		 * Whether or not `pattern` should match multiple lines of text.
		 */
		isMultiline?: boolean;

316 317 318
		/**
		 * Whether or not `pattern` should be interpreted as a regular expression.
		 */
R
Rob Lourens 已提交
319
		isRegExp?: boolean;
320 321 322 323

		/**
		 * Whether or not the search should be case-sensitive.
		 */
R
Rob Lourens 已提交
324
		isCaseSensitive?: boolean;
325 326 327 328

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

332 333
	/**
	 * A file glob pattern to match file paths against.
334
	 * TODO@roblourens merge this with the GlobPattern docs/definition in vscode.d.ts.
335 336 337 338 339 340 341
	 * @see [GlobPattern](#GlobPattern)
	 */
	export type GlobString = string;

	/**
	 * Options common to file and text search
	 */
R
Rob Lourens 已提交
342
	export interface SearchOptions {
343 344 345
		/**
		 * The root folder to search within.
		 */
346
		folder: Uri;
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361

		/**
		 * 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 已提交
362
		useIgnoreFiles: boolean;
363 364 365 366 367

		/**
		 * Whether symlinks should be followed while searching.
		 * See the vscode setting `"search.followSymlinks"`.
		 */
R
Rob Lourens 已提交
368
		followSymlinks: boolean;
P
pkoushik 已提交
369 370 371 372 373 374

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

R
Rob Lourens 已提交
377 378
	/**
	 * Options to specify the size of the result text preview.
R
Rob Lourens 已提交
379
	 * These options don't affect the size of the match itself, just the amount of preview text.
R
Rob Lourens 已提交
380
	 */
381
	export interface TextSearchPreviewOptions {
382
		/**
R
Rob Lourens 已提交
383
		 * The maximum number of lines in the preview.
R
Rob Lourens 已提交
384
		 * Only search providers that support multiline search will ever return more than one line in the match.
385
		 */
R
Rob Lourens 已提交
386
		matchLines: number;
R
Rob Lourens 已提交
387 388 389 390

		/**
		 * The maximum number of characters included per line.
		 */
R
Rob Lourens 已提交
391
		charsPerLine: number;
392 393
	}

394 395 396
	/**
	 * Options that apply to text search.
	 */
R
Rob Lourens 已提交
397
	export interface TextSearchOptions extends SearchOptions {
398
		/**
399
		 * The maximum number of results to be returned.
400
		 */
401 402
		maxResults: number;

R
Rob Lourens 已提交
403 404 405
		/**
		 * Options to specify the size of the result text preview.
		 */
406
		previewOptions?: TextSearchPreviewOptions;
407 408 409 410

		/**
		 * Exclude files larger than `maxFileSize` in bytes.
		 */
411
		maxFileSize?: number;
412 413 414 415 416

		/**
		 * Interpret files using this encoding.
		 * See the vscode setting `"files.encoding"`
		 */
417
		encoding?: string;
418 419 420 421 422 423 424 425 426 427

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

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

430 431 432 433 434 435 436 437 438 439 440 441 442 443
	/**
	 * 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 已提交
444 445 446
	/**
	 * A preview of the text result.
	 */
447
	export interface TextSearchMatchPreview {
448
		/**
R
Rob Lourens 已提交
449
		 * The matching lines of text, or a portion of the matching line that contains the match.
450 451 452 453 454
		 */
		text: string;

		/**
		 * The Range within `text` corresponding to the text of the match.
455
		 * The number of matches must match the TextSearchMatch's range property.
456
		 */
457
		matches: Range | Range[];
458 459 460 461 462
	}

	/**
	 * A match from a text search
	 */
463
	export interface TextSearchMatch {
464 465 466
		/**
		 * The uri for the matching document.
		 */
467
		uri: Uri;
468 469

		/**
470
		 * The range of the match within the document, or multiple ranges for multiple matches.
471
		 */
472
		ranges: Range | Range[];
R
Rob Lourens 已提交
473

474
		/**
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
		 * 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.
497
		 */
498
		lineNumber: number;
499 500
	}

501 502
	export type TextSearchResult = TextSearchMatch | TextSearchContext;

R
Rob Lourens 已提交
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
	/**
	 * 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;
	}

547
	/**
R
Rob Lourens 已提交
548 549 550 551 552 553 554
	 * 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.
555
	 */
556
	export interface FileSearchProvider {
557 558 559 560 561 562
		/**
		 * 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.
		 */
563
		provideFileSearchResults(query: FileSearchQuery, options: FileSearchOptions, token: CancellationToken): ProviderResult<Uri[]>;
564
	}
565

R
Rob Lourens 已提交
566
	export namespace workspace {
567
		/**
R
Rob Lourens 已提交
568 569 570 571 572 573 574
		 * 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.
575
		 */
R
Rob Lourens 已提交
576 577 578 579 580 581 582 583 584 585 586 587
		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;
588 589
	}

R
Rob Lourens 已提交
590 591 592 593
	//#endregion

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

594 595 596
	/**
	 * Options that can be set on a findTextInFiles search.
	 */
R
Rob Lourens 已提交
597
	export interface FindTextInFilesOptions {
598 599 600 601 602
		/**
		 * 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).
		 */
603
		include?: GlobPattern;
604 605 606

		/**
		 * A [glob pattern](#GlobPattern) that defines files and folders to exclude. The glob pattern
607 608
		 * will be matched against the file paths of resulting matches relative to their workspace. When `undefined`, default excludes will
		 * apply.
609
		 */
610 611 612 613
		exclude?: GlobPattern;

		/**
		 * Whether to use the default and user-configured excludes. Defaults to true.
614
		 */
615
		useDefaultExcludes?: boolean;
616 617 618 619

		/**
		 * The maximum number of results to search for
		 */
R
Rob Lourens 已提交
620
		maxResults?: number;
621 622 623 624 625

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

P
pkoushik 已提交
628 629 630 631
		/**
		 * Whether global files that exclude files, like .gitignore, should be respected.
		 * See the vscode setting `"search.useGlobalIgnoreFiles"`.
		 */
632
		useGlobalIgnoreFiles?: boolean;
P
pkoushik 已提交
633

634 635 636 637
		/**
		 * Whether symlinks should be followed while searching.
		 * See the vscode setting `"search.followSymlinks"`.
		 */
R
Rob Lourens 已提交
638
		followSymlinks?: boolean;
639 640 641 642 643

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

R
Rob Lourens 已提交
646 647 648
		/**
		 * Options to specify the size of the result text preview.
		 */
649
		previewOptions?: TextSearchPreviewOptions;
650 651 652 653 654 655 656 657 658 659

		/**
		 * 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 已提交
660 661
	}

662
	export namespace workspace {
663 664 665 666 667 668 669
		/**
		 * 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.
		 */
670
		export function findTextInFiles(query: TextSearchQuery, callback: (result: TextSearchResult) => void, token?: CancellationToken): Thenable<TextSearchComplete>;
671 672 673 674 675 676 677 678 679

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

J
Johannes Rieken 已提交
683
	//#endregion
684

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

J
Joao Moreno 已提交
687 688 689
	/**
	 * The contiguous set of modified lines in a diff.
	 */
J
Joao Moreno 已提交
690 691 692 693 694 695 696
	export interface LineChange {
		readonly originalStartLineNumber: number;
		readonly originalEndLineNumber: number;
		readonly modifiedStartLineNumber: number;
		readonly modifiedEndLineNumber: number;
	}

697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
	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;
	}
715

J
Johannes Rieken 已提交
716 717
	//#endregion

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

720
	export class Decoration {
721
		letter?: string;
722 723 724
		title?: string;
		color?: ThemeColor;
		priority?: number;
725
		bubble?: boolean;
726 727
	}

728
	export interface DecorationProvider {
729
		onDidChangeDecorations: Event<undefined | Uri | Uri[]>;
730
		provideDecoration(uri: Uri, token: CancellationToken): ProviderResult<Decoration>;
731 732 733
	}

	export namespace window {
734
		export function registerDecorationProvider(provider: DecorationProvider): Disposable;
735 736 737
	}

	//#endregion
738

739
	//#region debug
740

741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
	/**
	 * A DebugProtocolVariableContainer is an opaque stand-in type for the intersection of the Scope and Variable types defined in the Debug Adapter Protocol.
	 * See https://microsoft.github.io/debug-adapter-protocol/specification#Types_Scope and https://microsoft.github.io/debug-adapter-protocol/specification#Types_Variable.
	 */
	export interface DebugProtocolVariableContainer {
		// Properties: the intersection of DAP's Scope and Variable types.
	}

	/**
	 * A DebugProtocolVariable is an opaque stand-in type for the Variable type defined in the Debug Adapter Protocol.
	 * See https://microsoft.github.io/debug-adapter-protocol/specification#Types_Variable.
	 */
	export interface DebugProtocolVariable {
		// Properties: see details [here](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_Variable).
	}

757
	// deprecated debug API
A
Andre Weinand 已提交
758

759
	export interface DebugConfigurationProvider {
760
		/**
A
Andre Weinand 已提交
761 762
		 * Deprecated, use DebugAdapterDescriptorFactory.provideDebugAdapter instead.
		 * @deprecated Use DebugAdapterDescriptorFactory.createDebugAdapterDescriptor instead
763 764
		 */
		debugAdapterExecutable?(folder: WorkspaceFolder | undefined, token?: CancellationToken): ProviderResult<DebugAdapterExecutable>;
765 766
	}

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

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

771
	/**
772
	 * @deprecated DO NOT USE, will be removed
773 774 775 776 777 778 779 780 781 782 783
	 */
	export enum LogLevel {
		Trace = 1,
		Debug = 2,
		Info = 3,
		Warning = 4,
		Error = 5,
		Critical = 6,
		Off = 7
	}

M
Matt Bierner 已提交
784 785
	export namespace env {
		/**
786
		 * @deprecated DO NOT USE, will be removed
M
Matt Bierner 已提交
787 788
		 */
		export const logLevel: LogLevel;
789 790

		/**
791
		 * @deprecated DO NOT USE, will be removed
792 793
		 */
		export const onDidChangeLogLevel: Event<LogLevel>;
M
Matt Bierner 已提交
794 795
	}

J
Johannes Rieken 已提交
796 797
	//#endregion

798
	//#region @joaomoreno: SCM validation
799

J
Joao Moreno 已提交
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
	/**
	 * 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 已提交
845

J
Johannes Rieken 已提交
846 847
	//#endregion

848
	//#region @joaomoreno: SCM selected provider
849 850 851 852 853 854 855 856 857 858 859 860

	export interface SourceControl {

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

		/**
		 * An event signaling when the selection state changes.
		 */
		readonly onDidChangeSelection: Event<boolean>;
861 862 863 864
	}

	//#endregion

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

867 868 869 870 871 872 873 874 875 876 877
	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 已提交
878 879
	namespace window {
		/**
D
Daniel Imms 已提交
880 881 882
		 * An event which fires when the terminal's child pseudo-device is written to (the shell).
		 * In other words, this provides access to the raw data stream from the process running
		 * within the terminal, including VT sequences.
D
Daniel Imms 已提交
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
		 */
		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;
	}
904

D
Daniel Imms 已提交
905
	export namespace window {
D
Daniel Imms 已提交
906 907 908 909 910 911 912
		/**
		 * An event which fires when the [dimensions](#Terminal.dimensions) of the terminal change.
		 */
		export const onDidChangeTerminalDimensions: Event<TerminalDimensionsChangeEvent>;
	}

	export interface Terminal {
913
		/**
914 915 916
		 * 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.
917
		 */
918
		readonly dimensions: TerminalDimensions | undefined;
D
Daniel Imms 已提交
919 920
	}

921 922
	//#endregion

923
	//#region @jrieken -> exclusive document filters
924 925 926 927 928 929

	export interface DocumentFilter {
		exclusive?: boolean;
	}

	//#endregion
C
Christof Marti 已提交
930

931
	//#region @alexdima - OnEnter enhancement
932 933 934 935 936 937 938
	export interface OnEnterRule {
		/**
		 * This rule will only execute if the text above the this line matches this regular expression.
		 */
		oneLineAboveText?: RegExp;
	}
	//#endregion
939

940
	//#region Tree View: https://github.com/microsoft/vscode/issues/61313
941 942 943 944 945 946 947 948 949 950 951
	/**
	 * Label describing the [Tree item](#TreeItem)
	 */
	export interface TreeItemLabel {

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

		/**
S
Sandeep Somavarapu 已提交
952
		 * Ranges in the label to highlight. A range is defined as a tuple of two number where the
S
Sandeep Somavarapu 已提交
953
		 * first is the inclusive start index and the second the exclusive end index
954
		 */
S
Sandeep Somavarapu 已提交
955
		highlights?: [number, number][];
956 957 958

	}

A
Alex Ross 已提交
959 960 961 962 963
	// https://github.com/microsoft/vscode/issues/100741
	export interface TreeDataProvider<T> {
		resolveTreeItem?(element: T, item: TreeItem2): TreeItem2 | Thenable<TreeItem2>;
	}

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

970 971 972 973 974
		/**
		 * Content to be shown when you hover over the tree item.
		 */
		tooltip?: string | MarkdownString | /* for compilation */ any;

975 976 977 978 979 980
		/**
		 * @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);
	}
981
	//#endregion
982

983
	//#region Task presentation group: https://github.com/microsoft/vscode/issues/47265
984 985 986 987 988 989 990
	export interface TaskPresentationOptions {
		/**
		 * Controls whether the task is executed in a specific terminal group using split panes.
		 */
		group?: string;
	}
	//#endregion
991

992
	//#region Status bar item with ID and Name: https://github.com/microsoft/vscode/issues/74972
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014

	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;

1015 1016 1017 1018 1019
			/**
			 * Accessibility information used when screen reader interacts with this status bar item.
			 */
			accessibilityInformation?: AccessibilityInformation;

1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
			/**
			 * 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
1044

A
Alexandru Dima 已提交
1045
	//#region OnTypeRename: https://github.com/microsoft/vscode/issues/88424
1046

M
Matt Bierner 已提交
1047
	/**
P
Pine Wu 已提交
1048 1049
	 * The rename provider interface defines the contract between extensions and
	 * the live-rename feature.
1050
	 */
A
Alexandru Dima 已提交
1051
	export interface OnTypeRenameProvider {
1052
		/**
P
Pine Wu 已提交
1053
		 * Provide a list of ranges that can be live renamed together.
1054
		 *
P
Pine Wu 已提交
1055 1056 1057 1058
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
		 * @param token A cancellation token.
		 * @return A list of ranges that can be live-renamed togehter. The ranges must have
1059 1060 1061
		 * identical length and contain identical text content. The ranges cannot overlap. Optional a word pattern
		 * that overrides the word pattern defined when registering the provider. Live rename stops as soon as the renamed content
		 * no longer matches the word pattern.
1062
		 */
1063
		provideOnTypeRenameRanges(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<{ ranges: Range[]; wordPattern?: RegExp; }>;
1064 1065
	}

A
Alexandru Dima 已提交
1066
	namespace languages {
P
Pine Wu 已提交
1067 1068 1069 1070 1071 1072 1073 1074 1075
		/**
		 * Register a rename provider that works on type.
		 *
		 * 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.
		 * @param provider An on type rename provider.
1076
		 * @param wordPattern Word pattern for this provider.
P
Pine Wu 已提交
1077 1078
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
1079
		export function registerOnTypeRenameProvider(selector: DocumentSelector, provider: OnTypeRenameProvider, wordPattern?: RegExp): Disposable;
A
Alexandru Dima 已提交
1080 1081 1082 1083
	}

	//#endregion

1084
	//#region Custom editor move https://github.com/microsoft/vscode/issues/86146
1085

1086
	// TODO: Also for custom editor
1087

1088
	export interface CustomTextEditorProvider {
M
Matt Bierner 已提交
1089

1090 1091 1092 1093 1094 1095 1096 1097
		/**
		 * Handle when the underlying resource for a custom editor is renamed.
		 *
		 * This allows the webview for the editor be preserved throughout the rename. If this method is not implemented,
		 * VS Code will destory the previous custom editor and create a replacement one.
		 *
		 * @param newDocument New text document to use for the custom editor.
		 * @param existingWebviewPanel Webview panel for the custom editor.
1098
		 * @param token A cancellation token that indicates the result is no longer needed.
1099 1100 1101
		 *
		 * @return Thenable indicating that the webview editor has been moved.
		 */
1102
		moveCustomTextEditor?(newDocument: TextDocument, existingWebviewPanel: WebviewPanel, token: CancellationToken): Thenable<void>;
1103 1104 1105
	}

	//#endregion
1106

J
Johannes Rieken 已提交
1107
	//#region allow QuickPicks to skip sorting: https://github.com/microsoft/vscode/issues/73904
P
Peter Elmers 已提交
1108 1109 1110

	export interface QuickPick<T extends QuickPickItem> extends QuickInput {
		/**
1111 1112
		 * An optional flag to sort the final results by index of first query match in label. Defaults to true.
		 */
P
Peter Elmers 已提交
1113 1114 1115 1116
		sortByLabel: boolean;
	}

	//#endregion
M
Matt Bierner 已提交
1117

1118
	//#region @rebornix: Notebook
R
rebornix 已提交
1119

R
rebornix 已提交
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
	export enum CellKind {
		Markdown = 1,
		Code = 2
	}

	export enum CellOutputKind {
		Text = 1,
		Error = 2,
		Rich = 3
	}

R
rebornix 已提交
1131
	export interface CellStreamOutput {
R
rebornix 已提交
1132
		outputKind: CellOutputKind.Text;
R
rebornix 已提交
1133 1134 1135
		text: string;
	}

R
rebornix 已提交
1136
	export interface CellErrorOutput {
R
rebornix 已提交
1137
		outputKind: CellOutputKind.Error;
R
rebornix 已提交
1138 1139 1140 1141 1142 1143 1144
		/**
		 * Exception Name
		 */
		ename: string;
		/**
		 * Exception Value
		 */
R
rebornix 已提交
1145
		evalue: string;
R
rebornix 已提交
1146 1147 1148
		/**
		 * Exception call stack
		 */
R
rebornix 已提交
1149 1150 1151
		traceback: string[];
	}

R
rebornix 已提交
1152 1153 1154 1155 1156 1157 1158
	export interface NotebookCellOutputMetadata {
		/**
		 * Additional attributes of a cell metadata.
		 */
		custom?: { [key: string]: any };
	}

R
rebornix 已提交
1159
	export interface CellDisplayOutput {
R
rebornix 已提交
1160
		outputKind: CellOutputKind.Rich;
R
rebornix 已提交
1161 1162 1163 1164 1165 1166
		/**
		 * { mime_type: value }
		 *
		 * Example:
		 * ```json
		 * {
R
rebornix 已提交
1167
		 *   "outputKind": vscode.CellOutputKind.Rich,
R
rebornix 已提交
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
		 *   "data": {
		 *      "text/html": [
		 *          "<h1>Hello</h1>"
		 *       ],
		 *      "text/plain": [
		 *        "<IPython.lib.display.IFrame at 0x11dee3e80>"
		 *      ]
		 *   }
		 * }
		 */
R
rebornix 已提交
1178
		data: { [key: string]: any; };
R
rebornix 已提交
1179 1180

		readonly metadata?: NotebookCellOutputMetadata;
R
rebornix 已提交
1181 1182
	}

R
rebornix 已提交
1183
	export type CellOutput = CellStreamOutput | CellErrorOutput | CellDisplayOutput;
R
rebornix 已提交
1184

R
Rob Lourens 已提交
1185 1186 1187 1188 1189 1190 1191
	export enum NotebookCellRunState {
		Running = 1,
		Idle = 2,
		Success = 3,
		Error = 4
	}

R
Rob Lourens 已提交
1192 1193 1194 1195 1196
	export enum NotebookRunState {
		Running = 1,
		Idle = 2
	}

R
rebornix 已提交
1197
	export interface NotebookCellMetadata {
1198
		/**
1199
		 * Controls whether a cell's editor is editable/readonly.
1200
		 */
R
rebornix 已提交
1201
		editable?: boolean;
R
rebornix 已提交
1202 1203 1204 1205 1206

		/**
		 * Controls if the cell is executable.
		 * This metadata is ignored for markdown cell.
		 */
R
rebornix 已提交
1207
		runnable?: boolean;
R
rebornix 已提交
1208

1209 1210 1211 1212 1213 1214
		/**
		 * Controls if the cell has a margin to support the breakpoint UI.
		 * This metadata is ignored for markdown cell.
		 */
		breakpointMargin?: boolean;

1215 1216 1217 1218 1219 1220
		/**
		 * Whether the [execution order](#NotebookCellMetadata.executionOrder) indicator will be displayed.
		 * Defaults to true.
		 */
		hasExecutionOrder?: boolean;

R
rebornix 已提交
1221
		/**
1222
		 * The order in which this cell was executed.
R
rebornix 已提交
1223
		 */
1224
		executionOrder?: number;
R
Rob Lourens 已提交
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234

		/**
		 * A status message to be shown in the cell's status bar
		 */
		statusMessage?: string;

		/**
		 * The cell's current run state
		 */
		runState?: NotebookCellRunState;
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244

		/**
		 * If the cell is running, the time at which the cell started running
		 */
		runStartTime?: number;

		/**
		 * The total duration of the cell's last run
		 */
		lastRunDuration?: number;
R
rebornix 已提交
1245

1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
		/**
		 * Whether a code cell's editor is collapsed
		 */
		inputCollapsed?: boolean;

		/**
		 * Whether a code cell's outputs are collapsed
		 */
		outputCollapsed?: boolean;

R
rebornix 已提交
1256 1257 1258
		/**
		 * Additional attributes of a cell metadata.
		 */
R
rebornix 已提交
1259
		custom?: { [key: string]: any };
R
rebornix 已提交
1260 1261
	}

R
rebornix 已提交
1262
	export interface NotebookCell {
1263
		readonly notebook: NotebookDocument;
1264
		readonly uri: Uri;
R
rebornix 已提交
1265
		readonly cellKind: CellKind;
1266
		readonly document: TextDocument;
1267
		readonly language: string;
R
rebornix 已提交
1268
		outputs: CellOutput[];
R
rebornix 已提交
1269
		metadata: NotebookCellMetadata;
R
rebornix 已提交
1270 1271 1272
	}

	export interface NotebookDocumentMetadata {
1273 1274
		/**
		 * Controls if users can add or delete cells
1275
		 * Defaults to true
1276
		 */
1277
		editable?: boolean;
R
rebornix 已提交
1278

1279 1280 1281 1282 1283 1284
		/**
		 * Controls whether the full notebook can be run at once.
		 * Defaults to true
		 */
		runnable?: boolean;

1285 1286
		/**
		 * Default value for [cell editable metadata](#NotebookCellMetadata.editable).
1287
		 * Defaults to true.
1288
		 */
1289
		cellEditable?: boolean;
R
rebornix 已提交
1290 1291 1292

		/**
		 * Default value for [cell runnable metadata](#NotebookCellMetadata.runnable).
1293
		 * Defaults to true.
R
rebornix 已提交
1294
		 */
1295
		cellRunnable?: boolean;
R
rebornix 已提交
1296

1297
		/**
1298
		 * Default value for [cell hasExecutionOrder metadata](#NotebookCellMetadata.hasExecutionOrder).
1299 1300
		 * Defaults to true.
		 */
1301
		cellHasExecutionOrder?: boolean;
R
rebornix 已提交
1302 1303

		displayOrder?: GlobPattern[];
R
rebornix 已提交
1304 1305

		/**
1306
		 * Additional attributes of the document metadata.
R
rebornix 已提交
1307
		 */
1308
		custom?: { [key: string]: any };
R
Rob Lourens 已提交
1309 1310 1311 1312 1313

		/**
		 * The document's current run state
		 */
		runState?: NotebookRunState;
R
rebornix 已提交
1314 1315
	}

R
rebornix 已提交
1316 1317
	export interface NotebookDocument {
		readonly uri: Uri;
1318
		readonly version: number;
R
rebornix 已提交
1319
		readonly fileName: string;
R
rebornix 已提交
1320
		readonly viewType: string;
R
rebornix 已提交
1321
		readonly isDirty: boolean;
R
rebornix 已提交
1322
		readonly isUntitled: boolean;
1323
		readonly cells: ReadonlyArray<NotebookCell>;
R
rebornix 已提交
1324
		languages: string[];
R
rebornix 已提交
1325
		displayOrder?: GlobPattern[];
1326
		metadata: NotebookDocumentMetadata;
R
rebornix 已提交
1327 1328
	}

1329
	export interface NotebookConcatTextDocument {
J
Johannes Rieken 已提交
1330
		uri: Uri;
1331 1332
		isClosed: boolean;
		dispose(): void;
1333
		onDidChange: Event<void>;
1334 1335 1336
		version: number;
		getText(): string;
		getText(range: Range): string;
1337

1338 1339
		offsetAt(position: Position): number;
		positionAt(offset: number): Position;
1340 1341 1342
		validateRange(range: Range): Range;
		validatePosition(position: Position): Position;

1343 1344
		locationAt(positionOrRange: Position | Range): Location;
		positionAt(location: Location): Position;
1345
		contains(uri: Uri): boolean
R
rebornix 已提交
1346 1347
	}

1348 1349 1350 1351 1352 1353
	export interface WorkspaceEdit {
		replaceCells(uri: Uri, start: number, end: number, cells: NotebookCellData[], metadata?: WorkspaceEditEntryMetadata): void;
		replaceCellOutput(uri: Uri, index: number, outputs: CellOutput[], metadata?: WorkspaceEditEntryMetadata): void;
		replaceCellMetadata(uri: Uri, index: number, cellMetadata: NotebookCellMetadata, metadata?: WorkspaceEditEntryMetadata): void;
	}

R
rebornix 已提交
1354
	export interface NotebookEditorCellEdit {
1355

1356 1357
		replaceCells(start: number, end: number, cells: NotebookCellData[]): void;
		replaceOutput(index: number, outputs: CellOutput[]): void;
1358
		replaceMetadata(index: number, metadata: NotebookCellMetadata): void;
1359

1360
		/** @deprecated */
R
rebornix 已提交
1361
		insert(index: number, content: string | string[], language: string, type: CellKind, outputs: CellOutput[], metadata: NotebookCellMetadata | undefined): void;
1362
		/** @deprecated */
R
rebornix 已提交
1363 1364 1365
		delete(index: number): void;
	}

R
rebornix 已提交
1366
	export interface NotebookEditor {
R
rebornix 已提交
1367 1368 1369
		/**
		 * The document associated with this notebook editor.
		 */
R
rebornix 已提交
1370
		readonly document: NotebookDocument;
R
rebornix 已提交
1371 1372 1373 1374 1375

		/**
		 * The primary selected cell on this notebook editor.
		 */
		readonly selection?: NotebookCell;
1376

R
rebornix 已提交
1377 1378 1379
		/**
		 * The column in which this editor shows.
		 */
J
Johannes Rieken 已提交
1380
		readonly viewColumn?: ViewColumn;
1381

R
rebornix 已提交
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
		/**
		 * Whether the panel is active (focused by the user).
		 */
		readonly active: boolean;

		/**
		 * Whether the panel is visible.
		 */
		readonly visible: boolean;

R
rebornix 已提交
1392 1393 1394 1395 1396
		/**
		 * Fired when the panel is disposed.
		 */
		readonly onDidDispose: Event<void>;

1397 1398 1399 1400 1401
		/**
		 * Active kernel used in the editor
		 */
		readonly kernel?: NotebookKernel;

1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414
		/**
		 * Fired when the output hosting webview posts a message.
		 */
		readonly onDidReceiveMessage: Event<any>;
		/**
		 * Post a message to the output hosting webview.
		 *
		 * Messages are only delivered if the editor is live.
		 *
		 * @param message Body of the message. This must be a string or other json serilizable object.
		 */
		postMessage(message: any): Thenable<boolean>;

R
rebornix 已提交
1415 1416 1417 1418 1419
		/**
		 * Convert a uri for the local file system to one that can be used inside outputs webview.
		 */
		asWebviewUri(localResource: Uri): Uri;

R
rebornix 已提交
1420
		edit(callback: (editBuilder: NotebookEditorCellEdit) => void): Thenable<boolean>;
R
rebornix 已提交
1421 1422
	}

R
rebornix 已提交
1423
	export interface NotebookOutputSelector {
R
rebornix 已提交
1424
		mimeTypes?: string[];
R
rebornix 已提交
1425 1426
	}

1427 1428 1429 1430
	export interface NotebookRenderRequest {
		output: CellDisplayOutput;
		mimeType: string;
		outputId: string;
R
rebornix 已提交
1431 1432
	}

1433
	export interface NotebookCellsChangeData {
R
rebornix 已提交
1434 1435
		readonly start: number;
		readonly deletedCount: number;
1436
		readonly deletedItems: NotebookCell[];
R
rebornix 已提交
1437
		readonly items: NotebookCell[];
R
rebornix 已提交
1438 1439
	}

R
rebornix 已提交
1440
	export interface NotebookCellsChangeEvent {
R
rebornix 已提交
1441 1442 1443 1444 1445

		/**
		 * The affected document.
		 */
		readonly document: NotebookDocument;
1446
		readonly changes: ReadonlyArray<NotebookCellsChangeData>;
R
rebornix 已提交
1447 1448
	}

R
rebornix 已提交
1449
	export interface NotebookCellMoveEvent {
R
rebornix 已提交
1450 1451

		/**
R
rebornix 已提交
1452
		 * The affected document.
R
rebornix 已提交
1453
		 */
R
rebornix 已提交
1454
		readonly document: NotebookDocument;
R
rebornix 已提交
1455
		readonly index: number;
R
rebornix 已提交
1456
		readonly newIndex: number;
R
rebornix 已提交
1457 1458
	}

1459
	export interface NotebookCellOutputsChangeEvent {
R
rebornix 已提交
1460 1461 1462 1463 1464

		/**
		 * The affected document.
		 */
		readonly document: NotebookDocument;
1465
		readonly cells: NotebookCell[];
R
rebornix 已提交
1466 1467 1468
	}

	export interface NotebookCellLanguageChangeEvent {
R
rebornix 已提交
1469 1470

		/**
R
rebornix 已提交
1471
		 * The affected document.
R
rebornix 已提交
1472
		 */
R
rebornix 已提交
1473 1474 1475
		readonly document: NotebookDocument;
		readonly cell: NotebookCell;
		readonly language: string;
R
rebornix 已提交
1476 1477
	}

1478 1479 1480
	export interface NotebookCellMetadataChangeEvent {
		readonly document: NotebookDocument;
		readonly cell: NotebookCell;
R
rebornix 已提交
1481 1482
	}

1483 1484 1485 1486 1487
	export interface NotebookEditorSelectionChangeEvent {
		readonly notebookEditor: NotebookEditor;
		readonly selection?: NotebookCell;
	}

R
rebornix 已提交
1488 1489 1490
	export interface NotebookCellData {
		readonly cellKind: CellKind;
		readonly source: string;
1491 1492 1493
		readonly language: string;
		readonly outputs: CellOutput[];
		readonly metadata: NotebookCellMetadata | undefined;
R
rebornix 已提交
1494 1495 1496 1497 1498 1499 1500 1501
	}

	export interface NotebookData {
		readonly cells: NotebookCellData[];
		readonly languages: string[];
		readonly metadata: NotebookDocumentMetadata;
	}

1502 1503 1504 1505 1506 1507 1508 1509
	interface NotebookDocumentContentChangeEvent {

		/**
		 * The document that the edit is for.
		 */
		readonly document: NotebookDocument;
	}

R
rebornix 已提交
1510 1511 1512 1513 1514 1515
	interface NotebookDocumentEditEvent {

		/**
		 * The document that the edit is for.
		 */
		readonly document: NotebookDocument;
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540

		/**
		 * Undo the edit operation.
		 *
		 * This is invoked by VS Code when the user undoes this edit. To implement `undo`, your
		 * extension should restore the document and editor to the state they were in just before this
		 * edit was added to VS Code's internal edit stack by `onDidChangeCustomDocument`.
		 */
		undo(): Thenable<void> | void;

		/**
		 * Redo the edit operation.
		 *
		 * This is invoked by VS Code when the user redoes this edit. To implement `redo`, your
		 * extension should restore the document and editor to the state they were in just after this
		 * edit was added to VS Code's internal edit stack by `onDidChangeCustomDocument`.
		 */
		redo(): Thenable<void> | void;

		/**
		 * Display name describing the edit.
		 *
		 * This will be shown to users in the UI for undo/redo operations.
		 */
		readonly label?: string;
R
rebornix 已提交
1541 1542
	}

1543 1544 1545 1546
	interface NotebookDocumentBackup {
		/**
		 * Unique identifier for the backup.
		 *
R
rebornix 已提交
1547
		 * This id is passed back to your extension in `openCustomDocument` when opening a notebook editor from a backup.
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
		 */
		readonly id: string;

		/**
		 * Delete the current backup.
		 *
		 * This is called by VS Code when it is clear the current backup is no longer needed, such as when a new backup
		 * is made or when the file is saved.
		 */
		delete(): void;
	}

	interface NotebookDocumentBackupContext {
		readonly destination: Uri;
	}

	interface NotebookDocumentOpenContext {
		readonly backupId?: string;
	}

1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
	/**
	 * Communication object passed to the {@link NotebookContentProvider} and
	 * {@link NotebookOutputRenderer} to communicate with the webview.
	 */
	export interface NotebookCommunication {
		/**
		 * ID of the editor this object communicates with. A single notebook
		 * document can have multiple attached webviews and editors, when the
		 * notebook is split for instance. The editor ID lets you differentiate
		 * between them.
		 */
		readonly editorId: string;

		/**
		 * Fired when the output hosting webview posts a message.
		 */
		readonly onDidReceiveMessage: Event<any>;
		/**
		 * Post a message to the output hosting webview.
		 *
		 * Messages are only delivered if the editor is live.
		 *
		 * @param message Body of the message. This must be a string or other json serilizable object.
		 */
		postMessage(message: any): Thenable<boolean>;

		/**
		 * Convert a uri for the local file system to one that can be used inside outputs webview.
		 */
		asWebviewUri(localResource: Uri): Uri;
R
rebornix 已提交
1598 1599
	}

R
rebornix 已提交
1600
	export interface NotebookContentProvider {
1601 1602 1603 1604
		/**
		 * Content providers should always use [file system providers](#FileSystemProvider) to
		 * resolve the raw content for `uri` as the resouce is not necessarily a file on disk.
		 */
1605
		openNotebook(uri: Uri, openContext: NotebookDocumentOpenContext): NotebookData | Promise<NotebookData>;
1606
		resolveNotebook(document: NotebookDocument, webview: NotebookCommunication): Promise<void>;
R
rebornix 已提交
1607 1608
		saveNotebook(document: NotebookDocument, cancellation: CancellationToken): Promise<void>;
		saveNotebookAs(targetResource: Uri, document: NotebookDocument, cancellation: CancellationToken): Promise<void>;
R
rebornix 已提交
1609
		readonly onDidChangeNotebook: Event<NotebookDocumentContentChangeEvent | NotebookDocumentEditEvent>;
R
rebornix 已提交
1610
		backupNotebook(document: NotebookDocument, context: NotebookDocumentBackupContext, cancellation: CancellationToken): Promise<NotebookDocumentBackup>;
R
rebornix 已提交
1611 1612
	}

R
rebornix 已提交
1613
	export interface NotebookKernel {
R
rebornix 已提交
1614
		readonly id?: string;
R
rebornix 已提交
1615
		label: string;
R
rebornix 已提交
1616 1617
		description?: string;
		isPreferred?: boolean;
R
rebornix 已提交
1618
		preloads?: Uri[];
R
Rob Lourens 已提交
1619 1620 1621 1622
		executeCell(document: NotebookDocument, cell: NotebookCell): void;
		cancelCellExecution(document: NotebookDocument, cell: NotebookCell): void;
		executeAllCells(document: NotebookDocument): void;
		cancelAllCellsExecution(document: NotebookDocument): void;
R
rebornix 已提交
1623 1624
	}

R
rebornix 已提交
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
	export interface NotebookDocumentFilter {
		viewType?: string;
		filenamePattern?: GlobPattern;
		excludeFileNamePattern?: GlobPattern;
	}

	export interface NotebookKernelProvider<T extends NotebookKernel = NotebookKernel> {
		onDidChangeKernels?: Event<void>;
		provideKernels(document: NotebookDocument, token: CancellationToken): ProviderResult<T[]>;
		resolveKernel?(kernel: T, document: NotebookDocument, webview: NotebookCommunication, token: CancellationToken): ProviderResult<void>;
R
rebornix 已提交
1635 1636
	}

1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
	/**
	 * Represents the alignment of status bar items.
	 */
	export enum NotebookCellStatusBarAlignment {

		/**
		 * Aligned to the left side.
		 */
		Left = 1,

		/**
		 * Aligned to the right side.
		 */
		Right = 2
	}

	export interface NotebookCellStatusBarItem {
		readonly cell: NotebookCell;
		readonly alignment: NotebookCellStatusBarAlignment;
		readonly priority?: number;
		text: string;
		tooltip: string | undefined;
		command: string | Command | undefined;
		accessibilityInformation?: AccessibilityInformation;
		show(): void;
		hide(): void;
		dispose(): void;
	}

R
rebornix 已提交
1666
	export namespace notebook {
R
rebornix 已提交
1667
		export function registerNotebookContentProvider(
R
rebornix 已提交
1668
			notebookType: string,
1669 1670
			provider: NotebookContentProvider,
			options?: {
R
rebornix 已提交
1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
				/**
				 * Controls if outputs change will trigger notebook document content change and if it will be used in the diff editor
				 * Default to false. If the content provider doesn't persisit the outputs in the file document, this should be set to true.
				 */
				transientOutputs: boolean;
				/**
				 * Controls if a meetadata property change will trigger notebook document content change and if it will be used in the diff editor
				 * Default to false. If the content provider doesn't persisit a metadata property in the file document, it should be set to true.
				 */
				transientMetadata: { [K in keyof NotebookCellMetadata]?: boolean }
1681
			}
R
rebornix 已提交
1682 1683
		): Disposable;

R
rebornix 已提交
1684 1685 1686 1687 1688
		export function registerNotebookKernelProvider(
			selector: NotebookDocumentFilter,
			provider: NotebookKernelProvider
		): Disposable;

R
rebornix 已提交
1689 1690 1691 1692 1693 1694
		export function registerNotebookKernel(
			id: string,
			selectors: GlobPattern[],
			kernel: NotebookKernel
		): Disposable;

R
rebornix 已提交
1695
		export const onDidOpenNotebookDocument: Event<NotebookDocument>;
R
rebornix 已提交
1696
		export const onDidCloseNotebookDocument: Event<NotebookDocument>;
R
rebornix 已提交
1697
		export const onDidSaveNotebookDocument: Event<NotebookDocument>;
R
rebornix 已提交
1698

1699 1700 1701 1702
		/**
		 * All currently known notebook documents.
		 */
		export const notebookDocuments: ReadonlyArray<NotebookDocument>;
R
rebornix 已提交
1703

1704
		export const visibleNotebookEditors: NotebookEditor[];
R
rebornix 已提交
1705
		export const onDidChangeVisibleNotebookEditors: Event<NotebookEditor[]>;
1706

1707
		export const activeNotebookEditor: NotebookEditor | undefined;
R
rebornix 已提交
1708
		export const onDidChangeActiveNotebookEditor: Event<NotebookEditor | undefined>;
1709
		export const onDidChangeNotebookEditorSelection: Event<NotebookEditorSelectionChangeEvent>;
R
rebornix 已提交
1710
		export const onDidChangeNotebookCells: Event<NotebookCellsChangeEvent>;
1711
		export const onDidChangeCellOutputs: Event<NotebookCellOutputsChangeEvent>;
R
rebornix 已提交
1712
		export const onDidChangeCellLanguage: Event<NotebookCellLanguageChangeEvent>;
1713
		export const onDidChangeCellMetadata: Event<NotebookCellMetadataChangeEvent>;
1714
		/**
J
Johannes Rieken 已提交
1715 1716
		 * Create a document that is the concatenation of all  notebook cells. By default all code-cells are included
		 * but a selector can be provided to narrow to down the set of cells.
1717 1718 1719 1720 1721
		 *
		 * @param notebook
		 * @param selector
		 */
		export function createConcatTextDocument(notebook: NotebookDocument, selector?: DocumentSelector): NotebookConcatTextDocument;
M
Martin Aeschlimann 已提交
1722

R
rebornix 已提交
1723
		export const onDidChangeActiveNotebookKernel: Event<{ document: NotebookDocument, kernel: NotebookKernel | undefined }>;
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734

		/**
		 * Creates a notebook cell status bar [item](#NotebookCellStatusBarItem).
		 * It will be disposed automatically when the notebook document is closed or the cell is deleted.
		 *
		 * @param cell The cell on which this item should be shown.
		 * @param alignment The alignment of the item.
		 * @param priority The priority of the item. Higher values mean the item should be shown more to the left.
		 * @return A new status bar item.
		 */
		export function createCellStatusBarItem(cell: NotebookCell, alignment?: NotebookCellStatusBarAlignment, priority?: number): NotebookCellStatusBarItem;
M
Martin Aeschlimann 已提交
1735 1736
	}

1737 1738 1739 1740
	//#endregion

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

P
label2  
Pine Wu 已提交
1741 1742 1743 1744
	export interface CompletionItem {
		/**
		 * Will be merged into CompletionItem#label
		 */
P
Pine Wu 已提交
1745
		label2?: CompletionItemLabel;
P
label2  
Pine Wu 已提交
1746 1747
	}

1748 1749
	export interface CompletionItemLabel {
		/**
P
Pine Wu 已提交
1750
		 * The function or variable. Rendered leftmost.
1751
		 */
P
Pine Wu 已提交
1752
		name: string;
1753

P
Pine Wu 已提交
1754
		/**
1755
		 * The parameters without the return type. Render after `name`.
P
Pine Wu 已提交
1756
		 */
1757
		parameters?: string;
P
Pine Wu 已提交
1758 1759

		/**
P
Pine Wu 已提交
1760
		 * The fully qualified name, like package name or file path. Rendered after `signature`.
P
Pine Wu 已提交
1761 1762
		 */
		qualifier?: string;
1763

P
Pine Wu 已提交
1764
		/**
P
Pine Wu 已提交
1765
		 * The return-type of a function or type of a property/variable. Rendered rightmost.
P
Pine Wu 已提交
1766
		 */
P
Pine Wu 已提交
1767
		type?: string;
1768 1769 1770 1771
	}

	//#endregion

1772
	//#region @eamodio - timeline: https://github.com/microsoft/vscode/issues/84297
1773 1774 1775

	export class TimelineItem {
		/**
1776
		 * A timestamp (in milliseconds since 1 January 1970 00:00:00) for when the timeline item occurred.
1777
		 */
E
Eric Amodio 已提交
1778
		timestamp: number;
1779 1780

		/**
1781
		 * A human-readable string describing the timeline item.
1782 1783 1784 1785
		 */
		label: string;

		/**
1786
		 * Optional id for the timeline item. It must be unique across all the timeline items provided by this source.
1787
		 *
1788
		 * If not provided, an id is generated using the timeline item's timestamp.
1789 1790 1791 1792
		 */
		id?: string;

		/**
1793
		 * The icon path or [ThemeIcon](#ThemeIcon) for the timeline item.
1794
		 */
R
rebornix 已提交
1795
		iconPath?: Uri | { light: Uri; dark: Uri; } | ThemeIcon;
1796 1797

		/**
1798
		 * A human readable string describing less prominent details of the timeline item.
1799 1800 1801 1802 1803 1804
		 */
		description?: string;

		/**
		 * The tooltip text when you hover over the timeline item.
		 */
1805
		detail?: string;
1806 1807 1808 1809 1810 1811 1812

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

		/**
1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828
		 * 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`.
1829 1830 1831
		 */
		contextValue?: string;

1832 1833 1834 1835 1836
		/**
		 * Accessibility information used when screen reader interacts with this timeline item.
		 */
		accessibilityInformation?: AccessibilityInformation;

1837 1838
		/**
		 * @param label A human-readable string describing the timeline item
E
Eric Amodio 已提交
1839
		 * @param timestamp A timestamp (in milliseconds since 1 January 1970 00:00:00) for when the timeline item occurred
1840
		 */
E
Eric Amodio 已提交
1841
		constructor(label: string, timestamp: number);
1842 1843
	}

1844
	export interface TimelineChangeEvent {
E
Eric Amodio 已提交
1845
		/**
1846
		 * The [uri](#Uri) of the resource for which the timeline changed.
E
Eric Amodio 已提交
1847
		 */
E
Eric Amodio 已提交
1848
		uri: Uri;
1849

E
Eric Amodio 已提交
1850
		/**
1851
		 * A flag which indicates whether the entire timeline should be reset.
E
Eric Amodio 已提交
1852
		 */
1853 1854
		reset?: boolean;
	}
E
Eric Amodio 已提交
1855

1856 1857 1858
	export interface Timeline {
		readonly paging?: {
			/**
E
Eric Amodio 已提交
1859
			 * A provider-defined cursor specifying the starting point of timeline items which are after the ones returned.
E
Eric Amodio 已提交
1860
			 * Use `undefined` to signal that there are no more items to be returned.
1861
			 */
E
Eric Amodio 已提交
1862
			readonly cursor: string | undefined;
R
rebornix 已提交
1863
		};
E
Eric Amodio 已提交
1864 1865

		/**
1866
		 * An array of [timeline items](#TimelineItem).
E
Eric Amodio 已提交
1867
		 */
1868
		readonly items: readonly TimelineItem[];
E
Eric Amodio 已提交
1869 1870
	}

1871
	export interface TimelineOptions {
E
Eric Amodio 已提交
1872
		/**
E
Eric Amodio 已提交
1873
		 * A provider-defined cursor specifying the starting point of the timeline items that should be returned.
E
Eric Amodio 已提交
1874
		 */
1875
		cursor?: string;
E
Eric Amodio 已提交
1876 1877

		/**
1878 1879
		 * An optional maximum number timeline items or the all timeline items newer (inclusive) than the timestamp or id that should be returned.
		 * If `undefined` all timeline items should be returned.
E
Eric Amodio 已提交
1880
		 */
R
rebornix 已提交
1881
		limit?: number | { timestamp: number; id?: string; };
E
Eric Amodio 已提交
1882 1883
	}

1884
	export interface TimelineProvider {
1885
		/**
1886 1887
		 * 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`.
1888
		 */
E
Eric Amodio 已提交
1889
		onDidChange?: Event<TimelineChangeEvent | undefined>;
1890 1891

		/**
1892
		 * An identifier of the source of the timeline items. This can be used to filter sources.
1893
		 */
1894
		readonly id: string;
1895

E
Eric Amodio 已提交
1896
		/**
1897
		 * 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 已提交
1898
		 */
1899
		readonly label: string;
1900 1901

		/**
E
Eric Amodio 已提交
1902
		 * Provide [timeline items](#TimelineItem) for a [Uri](#Uri).
1903
		 *
1904
		 * @param uri The [uri](#Uri) of the file to provide the timeline for.
1905
		 * @param options A set of options to determine how results should be returned.
1906
		 * @param token A cancellation token.
E
Eric Amodio 已提交
1907
		 * @return The [timeline result](#TimelineResult) or a thenable that resolves to such. The lack of a result
1908 1909
		 * can be signaled by returning `undefined`, `null`, or an empty array.
		 */
1910
		provideTimeline(uri: Uri, options: TimelineOptions, token: CancellationToken): ProviderResult<Timeline>;
1911 1912 1913 1914 1915 1916 1917 1918 1919 1920
	}

	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.
		 *
1921
		 * @param scheme A scheme or schemes that defines which documents this provider is applicable to. Can be `*` to target all documents.
1922 1923
		 * @param provider A timeline provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Eric Amodio 已提交
1924
		*/
1925
		export function registerTimelineProvider(scheme: string | string[], provider: TimelineProvider): Disposable;
1926 1927 1928
	}

	//#endregion
1929

1930
	//#region https://github.com/microsoft/vscode/issues/91555
1931

1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945
	export enum StandardTokenType {
		Other = 0,
		Comment = 1,
		String = 2,
		RegEx = 4
	}

	export interface TokenInformation {
		type: StandardTokenType;
		range: Range;
	}

	export namespace languages {
		export function getTokenInformationAtPosition(document: TextDocument, position: Position): Promise<TokenInformation>;
1946 1947 1948
	}

	//#endregion
1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973

	//#region Support `scmResourceState` in `when` clauses #86180 https://github.com/microsoft/vscode/issues/86180

	export interface SourceControlResourceState {
		/**
		 * Context value of the resource state. This can be used to contribute resource specific actions.
		 * For example, if a resource is given a context value as `diffable`. When contributing actions to `scm/resourceState/context`
		 * using `menus` extension point, you can specify context value for key `scmResourceState` in `when` expressions, like `scmResourceState == diffable`.
		 * ```
		 *	"contributes": {
		 *		"menus": {
		 *			"scm/resourceState/context": [
		 *				{
		 *					"command": "extension.diff",
		 *					"when": "scmResourceState == diffable"
		 *				}
		 *			]
		 *		}
		 *	}
		 * ```
		 * This will show action `extension.diff` only for resources with `contextValue` is `diffable`.
		 */
		readonly contextValue?: string;
	}

1974
	//#endregion
1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993

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

	export enum ExtensionRuntime {
		/**
		 * The extension is running in a NodeJS extension host. Runtime access to NodeJS APIs is available.
		 */
		Node = 1,
		/**
		 * The extension is running in a Webworker extension host. Runtime access is limited to Webworker APIs.
		 */
		Webworker = 2
	}

	export interface ExtensionContext {
		readonly extensionRuntime: ExtensionRuntime;
	}

	//#endregion
1994 1995 1996 1997 1998


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

	export interface TextDocument {
1999 2000 2001 2002 2003

		/**
		 * The [notebook](#NotebookDocument) that contains this document as a notebook cell or `undefined` when
		 * the document is not contained by a notebook (this should be the more frequent case).
		 */
2004 2005 2006
		notebook: NotebookDocument | undefined;
	}
	//#endregion
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143


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

	/**
	 * A webview based view.
	 */
	export interface WebviewView {
		/**
		 * Identifies the type of the webview view, such as `'hexEditor.dataView'`.
		 */
		readonly viewType: string;

		/**
		 * The underlying webview for the view.
		 */
		readonly webview: Webview;

		/**
		 * View title displayed in the UI.
		 *
		 * The view title is initially taken from the extension `package.json` contribution.
		 */
		title?: string;

		/**
		 * Event fired when the view is disposed.
		 *
		 * Views are disposed of in a few cases:
		 *
		 * - When a view is collapsed and `retainContextWhenHidden` has not been set.
		 * - When a view is hidden by a user.
		 *
		 * Trying to use the view after it has been disposed throws an exception.
		 */
		readonly onDidDispose: Event<void>;

		/**
		 * Tracks if the webview is currently visible.
		 *
		 * Views are visible when they are on the screen and expanded.
		 */
		readonly visible: boolean;

		/**
		 * Event fired when the visibility of the view changes
		 */
		readonly onDidChangeVisibility: Event<void>;
	}

	interface WebviewViewResolveContext<T = unknown> {
		/**
		 * Persisted state from the webview content.
		 *
		 * To save resources, VS Code normally deallocates webview views that are not visible. For example, if the user
		 * collapse a view or switching to another top level activity, the underlying webview document is deallocates.
		 *
		 * You can prevent this behavior by setting `retainContextWhenHidden` in the `WebviewOptions`. However this
		 * increases resource usage and should be avoided wherever possible. Instead, you can use persisted state to
		 * save off a webview's state so that it can be quickly recreated as needed.
		 *
		 * To save off a persisted state, inside the webview call `acquireVsCodeApi().setState()` with
		 * any json serializable object. To restore the state again, call `getState()`. For example:
		 *
		 * ```js
		 * // Within the webview
		 * const vscode = acquireVsCodeApi();
		 *
		 * // Get existing state
		 * const oldState = vscode.getState() || { value: 0 };
		 *
		 * // Update state
		 * setState({ value: oldState.value + 1 })
		 * ```
		 *
		 * VS Code ensures that the persisted state is saved correctly when a webview is hidden and across
		 * editor restarts.
		 */
		readonly state: T | undefined;
	}

	/**
	 * Provider for creating `WebviewView` elements.
	 */
	export interface WebviewViewProvider {
		/**
		 * Revolves a webview view.
		 *
		 * `resolveWebviewView` is called when a view first becomes visible. This may happen when the view is
		 * first loaded or when the user hides and then shows a view again.
		 *
		 * @param webviewView Webview panel to restore. The serializer should take ownership of this panel. The
		 *    provider must set the webview's `.html` and hook up all webview events it is interested in.
		 * @param context Additional metadata about the view being resolved.
		 * @param token Cancellation token indicating that the view being provided is no longer needed.
		 *
		 * @return Optional thenable indicating that the view has been fully resolved.
		 */
		resolveWebviewView(webviewView: WebviewView, context: WebviewViewResolveContext, token: CancellationToken): Thenable<void> | void;
	}

	namespace window {
		/**
		 * Register a new provider for webview views.
		 *
		 * @param viewId Unique id of the view. This should match the `id` from the
		 *   `views` contribution in the package.json.
		 * @param provider Provider for the webview views.
		 *
		 * @return Disposable that unregisters the provider.
		 */
		export function registerWebviewViewProvider(viewId: string, provider: WebviewViewProvider, options?: {
			/**
			 * Content settings for the webview created for this view.
			 */
			readonly webviewOptions?: {
				/**
				 * Controls if the webview panel's content (iframe) is kept around even when the panel
				 * is no longer visible.
				 *
				 * Normally the webview's html context is created when the panel becomes visible
				 * and destroyed when it is hidden. Extensions that have complex state
				 * or UI can set the `retainContextWhenHidden` to make VS Code keep the webview
				 * context around, even when the webview moves to a background tab. When a webview using
				 * `retainContextWhenHidden` becomes hidden, its scripts and other dynamic content are suspended.
				 * When the panel becomes visible again, the context is automatically restored
				 * in the exact same state it was in originally. You cannot send messages to a
				 * hidden webview, even with `retainContextWhenHidden` enabled.
				 *
				 * `retainContextWhenHidden` has a high memory overhead and should only be used if
				 * your panel's context cannot be quickly saved and restored.
				 */
				readonly retainContextWhenHidden?: boolean;
			};
		}): Disposable;
	}
	//#endregion
J
Johannes Rieken 已提交
2144
}