vscode.proposed.d.ts 59.8 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
import { MarkdownString } from 'vscode';

8 9 10 11 12 13 14 15 16 17
/**
 * 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.
 */
18

19 20
declare module 'vscode' {

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

23
	export class AuthenticationSession {
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
		/**
		 * The identifier of the authentication session.
		 */
		readonly id: string;

		/**
		 * The access token.
		 */
		readonly accessToken: string;

		/**
		 * The account associated with the session.
		 */
		readonly account: {
			/**
			 * The human-readable name of the account.
			 */
			readonly displayName: string;

			/**
			 * The unique identifier of the account.
			 */
			readonly id: string;
		};

		/**
		 * The permissions granted by the session's access token. Available scopes
		 * are defined by the authentication provider.
		 */
		readonly scopes: string[];

		constructor(id: string, accessToken: string, account: { displayName: string, id: string }, scopes: string[]);
	}

58 59 60 61 62 63 64 65 66 67
	/**
	 * 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[];

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

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
	/**
	 * Options to be used when getting a session from an [AuthenticationProvider](#AuthenticationProvider).
	 */
	export interface AuthenticationGetSessionOptions {
		/**
		 *  Whether login should be performed if there is no matching session. Defaults to false.
		 */
		createIfNone?: boolean;

		/**
		 * Whether the existing user session preference should be cleared. Set to allow the user to switch accounts.
		 * Defaults to false.
		 */
		clearSessionPreference?: boolean;
	}

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
	/**
	* An [event](#Event) which fires when an [AuthenticationSession](#AuthenticationSession) is added, removed, or changed.
	*/
	export interface AuthenticationSessionsChangeEvent {
		/**
		 * The ids of the [AuthenticationSession](#AuthenticationSession)s that have been added.
		*/
		readonly added: string[];

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

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

109 110 111 112 113
	/**
	 * **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.
	 */
114
	export interface AuthenticationProvider {
115 116
		/**
		 * Used as an identifier for extensions trying to work with a particular
117
		 * provider: 'microsoft', 'github', etc. id must be unique, registering
118 119
		 * another provider with the same id will fail.
		 */
120
		readonly id: string;
121

122
		/**
123
		 * The human-readable name of the provider.
124
		 */
125 126 127 128 129 130
		readonly displayName: string;

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

132
		/**
133
		 * An [event](#Event) which fires when the array of sessions has changed, or data
134 135
		 * within a session has changed.
		 */
136
		readonly onDidChangeSessions: Event<AuthenticationSessionsChangeEvent>;
137

138 139 140
		/**
		 * Returns an array of current sessions.
		 */
141
		getSessions(): Thenable<ReadonlyArray<AuthenticationSession>>;
142

143 144 145
		/**
		 * Prompts a user to login.
		 */
146
		login(scopes: string[]): Thenable<AuthenticationSession>;
147 148 149 150 151

		/**
		 * Removes the session corresponding to session id.
		 * @param sessionId The session id to log out of
		 */
152
		logout(sessionId: string): Thenable<void>;
153 154 155
	}

	export namespace authentication {
156 157 158 159 160 161 162 163 164
		/**
		 * 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.
		 */
165
		export function registerAuthenticationProvider(provider: AuthenticationProvider): Disposable;
166 167 168 169

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

172 173 174 175 176 177
		/**
		 * The ids of the currently registered authentication providers.
		 * @returns An array of the ids of authentication providers that are currently registered.
		 */
		export function getProviderIds(): Thenable<ReadonlyArray<string>>;

178
		/**
179
		 * @deprecated
180
		 * An array of the ids of authentication providers that are currently registered.
181
		 */
182
		export const providerIds: string[];
183

184 185
		/**
		 * Returns whether a provider has any sessions matching the requested scopes. This request
186
		 * is transparent to the user, no UI is shown. Rejects if a provider with providerId is not
187 188 189 190
		 * registered.
		 * @param providerId The id of the provider
		 * @param scopes A list of scopes representing the permissions requested. These are dependent on the authentication
		 * provider
191
		 * @returns A thenable that resolve to whether the provider has sessions with the requested scopes.
192 193 194 195 196 197 198 199 200 201 202
		 */
		export function hasSessions(providerId: string, scopes: string[]): Thenable<boolean>;

		/**
		 * Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
		 * registered, or if the user does not consent to sharing authentication information with
		 * the extension. If there are multiple sessions with the same scopes, the user will be shown a
		 * quickpick to select which account they would like to use.
		 * @param providerId The id of the provider to use
		 * @param scopes A list of scopes representing the permissions requested. These are dependent on the authentication provider
		 * @param options The [getSessionOptions](#GetSessionOptions) to use
R
Rachel Macfarlane 已提交
203
		 * @returns A thenable that resolves to an authentication session
204
		 */
205
		export function getSession(providerId: string, scopes: string[], options: AuthenticationGetSessionOptions & { createIfNone: true }): Thenable<AuthenticationSession>;
206

R
Rachel Macfarlane 已提交
207 208 209 210 211 212 213 214
		/**
		 * Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
		 * registered, or if the user does not consent to sharing authentication information with
		 * the extension. If there are multiple sessions with the same scopes, the user will be shown a
		 * quickpick to select which account they would like to use.
		 * @param providerId The id of the provider to use
		 * @param scopes A list of scopes representing the permissions requested. These are dependent on the authentication provider
		 * @param options The [getSessionOptions](#GetSessionOptions) to use
R
Rachel Macfarlane 已提交
215
		 * @returns A thenable that resolves to an authentication session if available, or undefined if there are no sessions
R
Rachel Macfarlane 已提交
216
		 */
217
		export function getSession(providerId: string, scopes: string[], options: AuthenticationGetSessionOptions): Thenable<AuthenticationSession | undefined>;
218

219
		/**
220
		 * @deprecated
221 222 223 224 225 226 227
		* 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>;

228
		/**
229
		* An [event](#Event) which fires when the array of sessions has changed, or data
230 231 232
		* within a session has changed for a provider. Fires with the ids of the providers
		* that have had session data change.
		*/
R
rebornix 已提交
233
		export const onDidChangeSessions: Event<{ [providerId: string]: AuthenticationSessionsChangeEvent; }>;
234 235
	}

J
Johannes Rieken 已提交
236 237
	//#endregion

A
Alex Ross 已提交
238
	//#region @alexdima - resolvers
A
Alex Dima 已提交
239

A
Tweaks  
Alex Dima 已提交
240 241 242 243
	export interface RemoteAuthorityResolverContext {
		resolveAttempt: number;
	}

A
Alex Dima 已提交
244 245 246 247 248 249 250
	export class ResolvedAuthority {
		readonly host: string;
		readonly port: number;

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

251
	export interface ResolvedOptions {
R
rebornix 已提交
252
		extensionHostEnv?: { [key: string]: string | null; };
253 254
	}

255
	export interface TunnelOptions {
R
rebornix 已提交
256
		remoteAddress: { port: number, host: string; };
A
Alex Ross 已提交
257 258 259
		// The desired local port. If this port can't be used, then another will be chosen.
		localAddressPort?: number;
		label?: string;
260 261
	}

A
Alex Ross 已提交
262
	export interface TunnelDescription {
R
rebornix 已提交
263
		remoteAddress: { port: number, host: string; };
A
Alex Ross 已提交
264
		//The complete local address(ex. localhost:1234)
R
rebornix 已提交
265
		localAddress: { port: number, host: string; } | string;
A
Alex Ross 已提交
266 267 268
	}

	export interface Tunnel extends TunnelDescription {
A
Alex Ross 已提交
269 270
		// Implementers of Tunnel should fire onDidDispose when dispose is called.
		onDidDispose: Event<void>;
271
		dispose(): void;
272 273 274
	}

	/**
275 276
	 * Used as part of the ResolverResult if the extension has any candidate,
	 * published, or forwarded ports.
277 278 279 280
	 */
	export interface TunnelInformation {
		/**
		 * Tunnels that are detected by the extension. The remotePort is used for display purposes.
A
Alex Ross 已提交
281
		 * The localAddress should be the complete local address (ex. localhost:1234) for connecting to the port. Tunnels provided through
282 283
		 * detected are read-only from the forwarded ports UI.
		 */
A
Alex Ross 已提交
284
		environmentTunnels?: TunnelDescription[];
A
Alex Ross 已提交
285

286 287 288
	}

	export type ResolverResult = ResolvedAuthority & ResolvedOptions & TunnelInformation;
289

A
Tweaks  
Alex Dima 已提交
290 291 292 293 294 295 296
	export class RemoteAuthorityResolverError extends Error {
		static NotAvailable(message?: string, handled?: boolean): RemoteAuthorityResolverError;
		static TemporarilyNotAvailable(message?: string): RemoteAuthorityResolverError;

		constructor(message?: string);
	}

A
Alex Dima 已提交
297
	export interface RemoteAuthorityResolver {
298
		resolve(authority: string, context: RemoteAuthorityResolverContext): ResolverResult | Thenable<ResolverResult>;
299 300 301 302 303
		/**
		 * 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 已提交
304
		tunnelFactory?: (tunnelOptions: TunnelOptions) => Thenable<Tunnel> | undefined;
305 306 307 308 309

		/**
		 * Provides filtering for candidate ports.
		 */
		showCandidatePort?: (host: string, port: number, detail: string) => Thenable<boolean>;
310 311 312 313
	}

	export namespace workspace {
		/**
314
		 * Forwards a port. If the current resolver implements RemoteAuthorityResolver:forwardPort then that will be used to make the tunnel.
A
Alex Ross 已提交
315 316
		 * 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.
317
		 */
A
Alex Ross 已提交
318
		export function openTunnel(tunnelOptions: TunnelOptions): Thenable<Tunnel>;
319 320 321 322 323 324

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

326 327 328 329
		/**
		 * Fired when the list of tunnels has changed.
		 */
		export const onDidChangeTunnels: Event<void>;
A
Alex Dima 已提交
330 331
	}

332 333 334 335 336 337 338 339
	export interface ResourceLabelFormatter {
		scheme: string;
		authority?: string;
		formatting: ResourceLabelFormatting;
	}

	export interface ResourceLabelFormatting {
		label: string; // myLabel:/${path}
340
		// TODO@isidorn
J
Johannes Rieken 已提交
341
		// eslint-disable-next-line vscode-dts-literal-or-types
342 343 344 345 346 347 348
		separator: '/' | '\\' | '';
		tildify?: boolean;
		normalizeDriveLetter?: boolean;
		workspaceSuffix?: string;
		authorityPrefix?: string;
	}

A
Alex Dima 已提交
349 350
	export namespace workspace {
		export function registerRemoteAuthorityResolver(authorityPrefix: string, resolver: RemoteAuthorityResolver): Disposable;
351
		export function registerResourceLabelFormatter(formatter: ResourceLabelFormatter): Disposable;
352
	}
353

354 355
	//#endregion

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

358 359
	export interface WebviewEditorInset {
		readonly editor: TextEditor;
360 361
		readonly line: number;
		readonly height: number;
362 363 364
		readonly webview: Webview;
		readonly onDidDispose: Event<void>;
		dispose(): void;
365 366
	}

367
	export namespace window {
368
		export function createWebviewTextEditorInset(editor: TextEditor, line: number, height: number, options?: WebviewOptions): WebviewEditorInset;
A
Alex Dima 已提交
369 370 371 372
	}

	//#endregion

J
Johannes Rieken 已提交
373
	//#region read/write in chunks: https://github.com/microsoft/vscode/issues/84515
374 375

	export interface FileSystemProvider {
R
rebornix 已提交
376
		open?(resource: Uri, options: { create: boolean; }): number | Thenable<number>;
377 378 379 380 381 382 383
		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 已提交
384
	//#region TextSearchProvider: https://github.com/microsoft/vscode/issues/59921
385

386 387 388
	/**
	 * The parameters of a query for text search.
	 */
389
	export interface TextSearchQuery {
390 391 392
		/**
		 * The text pattern to search for.
		 */
393
		pattern: string;
394

R
Rob Lourens 已提交
395 396 397 398 399
		/**
		 * Whether or not `pattern` should match multiple lines of text.
		 */
		isMultiline?: boolean;

400 401 402
		/**
		 * Whether or not `pattern` should be interpreted as a regular expression.
		 */
R
Rob Lourens 已提交
403
		isRegExp?: boolean;
404 405 406 407

		/**
		 * Whether or not the search should be case-sensitive.
		 */
R
Rob Lourens 已提交
408
		isCaseSensitive?: boolean;
409 410 411 412

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

416 417
	/**
	 * A file glob pattern to match file paths against.
418
	 * TODO@roblourens merge this with the GlobPattern docs/definition in vscode.d.ts.
419 420 421 422 423 424 425
	 * @see [GlobPattern](#GlobPattern)
	 */
	export type GlobString = string;

	/**
	 * Options common to file and text search
	 */
R
Rob Lourens 已提交
426
	export interface SearchOptions {
427 428 429
		/**
		 * The root folder to search within.
		 */
430
		folder: Uri;
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445

		/**
		 * 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 已提交
446
		useIgnoreFiles: boolean;
447 448 449 450 451

		/**
		 * Whether symlinks should be followed while searching.
		 * See the vscode setting `"search.followSymlinks"`.
		 */
R
Rob Lourens 已提交
452
		followSymlinks: boolean;
P
pkoushik 已提交
453 454 455 456 457 458

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

R
Rob Lourens 已提交
461 462
	/**
	 * Options to specify the size of the result text preview.
R
Rob Lourens 已提交
463
	 * These options don't affect the size of the match itself, just the amount of preview text.
R
Rob Lourens 已提交
464
	 */
465
	export interface TextSearchPreviewOptions {
466
		/**
R
Rob Lourens 已提交
467
		 * The maximum number of lines in the preview.
R
Rob Lourens 已提交
468
		 * Only search providers that support multiline search will ever return more than one line in the match.
469
		 */
R
Rob Lourens 已提交
470
		matchLines: number;
R
Rob Lourens 已提交
471 472 473 474

		/**
		 * The maximum number of characters included per line.
		 */
R
Rob Lourens 已提交
475
		charsPerLine: number;
476 477
	}

478 479 480
	/**
	 * Options that apply to text search.
	 */
R
Rob Lourens 已提交
481
	export interface TextSearchOptions extends SearchOptions {
482
		/**
483
		 * The maximum number of results to be returned.
484
		 */
485 486
		maxResults: number;

R
Rob Lourens 已提交
487 488 489
		/**
		 * Options to specify the size of the result text preview.
		 */
490
		previewOptions?: TextSearchPreviewOptions;
491 492 493 494

		/**
		 * Exclude files larger than `maxFileSize` in bytes.
		 */
495
		maxFileSize?: number;
496 497 498 499 500

		/**
		 * Interpret files using this encoding.
		 * See the vscode setting `"files.encoding"`
		 */
501
		encoding?: string;
502 503 504 505 506 507 508 509 510 511

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

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

514 515 516 517 518 519 520 521 522 523 524 525 526 527
	/**
	 * 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 已提交
528 529 530
	/**
	 * A preview of the text result.
	 */
531
	export interface TextSearchMatchPreview {
532
		/**
R
Rob Lourens 已提交
533
		 * The matching lines of text, or a portion of the matching line that contains the match.
534 535 536 537 538
		 */
		text: string;

		/**
		 * The Range within `text` corresponding to the text of the match.
539
		 * The number of matches must match the TextSearchMatch's range property.
540
		 */
541
		matches: Range | Range[];
542 543 544 545 546
	}

	/**
	 * A match from a text search
	 */
547
	export interface TextSearchMatch {
548 549 550
		/**
		 * The uri for the matching document.
		 */
551
		uri: Uri;
552 553

		/**
554
		 * The range of the match within the document, or multiple ranges for multiple matches.
555
		 */
556
		ranges: Range | Range[];
R
Rob Lourens 已提交
557

558
		/**
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
		 * 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.
581
		 */
582
		lineNumber: number;
583 584
	}

585 586
	export type TextSearchResult = TextSearchMatch | TextSearchContext;

R
Rob Lourens 已提交
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
	/**
	 * 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;
	}

631
	/**
R
Rob Lourens 已提交
632 633 634 635 636 637 638
	 * 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.
639
	 */
640
	export interface FileSearchProvider {
641 642 643 644 645 646
		/**
		 * 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.
		 */
647
		provideFileSearchResults(query: FileSearchQuery, options: FileSearchOptions, token: CancellationToken): ProviderResult<Uri[]>;
648
	}
649

R
Rob Lourens 已提交
650
	export namespace workspace {
651
		/**
R
Rob Lourens 已提交
652 653 654 655 656 657 658
		 * 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.
659
		 */
R
Rob Lourens 已提交
660 661 662 663 664 665 666 667 668 669 670 671
		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;
672 673
	}

R
Rob Lourens 已提交
674 675 676 677
	//#endregion

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

678 679 680
	/**
	 * Options that can be set on a findTextInFiles search.
	 */
R
Rob Lourens 已提交
681
	export interface FindTextInFilesOptions {
682 683 684 685 686
		/**
		 * 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).
		 */
687
		include?: GlobPattern;
688 689 690

		/**
		 * A [glob pattern](#GlobPattern) that defines files and folders to exclude. The glob pattern
691 692
		 * will be matched against the file paths of resulting matches relative to their workspace. When `undefined`, default excludes will
		 * apply.
693
		 */
694 695 696 697 698 699
		exclude?: GlobPattern;

		/**
		 * Whether to use the default and user-configured excludes. Defaults to true.
		 */
		useDefaultExcludes?: boolean;
700 701 702 703

		/**
		 * The maximum number of results to search for
		 */
R
Rob Lourens 已提交
704
		maxResults?: number;
705 706 707 708 709

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

P
pkoushik 已提交
712 713 714 715
		/**
		 * Whether global files that exclude files, like .gitignore, should be respected.
		 * See the vscode setting `"search.useGlobalIgnoreFiles"`.
		 */
716
		useGlobalIgnoreFiles?: boolean;
P
pkoushik 已提交
717

718 719 720 721
		/**
		 * Whether symlinks should be followed while searching.
		 * See the vscode setting `"search.followSymlinks"`.
		 */
R
Rob Lourens 已提交
722
		followSymlinks?: boolean;
723 724 725 726 727

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

R
Rob Lourens 已提交
730 731 732
		/**
		 * Options to specify the size of the result text preview.
		 */
733
		previewOptions?: TextSearchPreviewOptions;
734 735 736 737 738 739 740 741 742 743

		/**
		 * 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 已提交
744 745
	}

746
	export namespace workspace {
747 748 749 750 751 752 753
		/**
		 * 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.
		 */
754
		export function findTextInFiles(query: TextSearchQuery, callback: (result: TextSearchResult) => void, token?: CancellationToken): Thenable<TextSearchComplete>;
755 756 757 758 759 760 761 762 763

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

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

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

J
Joao Moreno 已提交
771 772 773
	/**
	 * The contiguous set of modified lines in a diff.
	 */
J
Joao Moreno 已提交
774 775 776 777 778 779 780
	export interface LineChange {
		readonly originalStartLineNumber: number;
		readonly originalEndLineNumber: number;
		readonly modifiedStartLineNumber: number;
		readonly modifiedEndLineNumber: number;
	}

781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
	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;
	}
799

J
Johannes Rieken 已提交
800 801
	//#endregion

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

804
	export class Decoration {
805
		letter?: string;
806 807 808
		title?: string;
		color?: ThemeColor;
		priority?: number;
809
		bubble?: boolean;
810 811
	}

812
	export interface DecorationProvider {
813
		onDidChangeDecorations: Event<undefined | Uri | Uri[]>;
814
		provideDecoration(uri: Uri, token: CancellationToken): ProviderResult<Decoration>;
815 816 817
	}

	export namespace window {
818
		export function registerDecorationProvider(provider: DecorationProvider): Disposable;
819 820 821
	}

	//#endregion
822

823
	//#region debug
824

I
isidor 已提交
825 826 827
	export interface DebugSessionOptions {
		/**
		 * Controls whether this session should run without debugging, thus ignoring breakpoints.
828
		 * When this property is not specified, the value from the parent session (if there is one) is used.
I
isidor 已提交
829 830
		 */
		noDebug?: boolean;
831 832

		/**
I
isidor 已提交
833 834 835
		 * Controls if the debug session's parent session is shown in the CALL STACK view even if it has only a single child.
		 * By default, debug sessions with a single child are hidden in the CALL STACK view to make the tree more compact.
		 * If noCompact is true, then the debug session will never hide its parent.
836 837
		 */
		noCompact?: boolean;
I
isidor 已提交
838 839
	}

840
	// deprecated debug API
A
Andre Weinand 已提交
841

842
	export interface DebugConfigurationProvider {
843
		/**
A
Andre Weinand 已提交
844 845
		 * Deprecated, use DebugAdapterDescriptorFactory.provideDebugAdapter instead.
		 * @deprecated Use DebugAdapterDescriptorFactory.createDebugAdapterDescriptor instead
846 847
		 */
		debugAdapterExecutable?(folder: WorkspaceFolder | undefined, token?: CancellationToken): ProviderResult<DebugAdapterExecutable>;
848 849
	}

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

852 853 854
	//#region LogLevel: https://github.com/microsoft/vscode/issues/85992

	/**
855
	 * @deprecated DO NOT USE, will be removed
856 857 858 859 860 861 862 863 864 865 866 867 868
	 */
	export enum LogLevel {
		Trace = 1,
		Debug = 2,
		Info = 3,
		Warning = 4,
		Error = 5,
		Critical = 6,
		Off = 7
	}

	export namespace env {
		/**
869
		 * @deprecated DO NOT USE, will be removed
870 871 872 873
		 */
		export const logLevel: LogLevel;

		/**
874
		 * @deprecated DO NOT USE, will be removed
875 876 877 878 879 880
		 */
		export const onDidChangeLogLevel: Event<LogLevel>;
	}

	//#endregion

881
	//#region @joaomoreno: SCM validation
882

J
Joao Moreno 已提交
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
	/**
	 * 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 已提交
928

J
Johannes Rieken 已提交
929 930
	//#endregion

931
	//#region @joaomoreno: SCM selected provider
932 933 934 935 936 937 938 939 940 941 942 943

	export interface SourceControl {

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

		/**
		 * An event signaling when the selection state changes.
		 */
		readonly onDidChangeSelection: Event<boolean>;
944 945 946 947
	}

	//#endregion

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

950 951 952 953 954 955 956 957 958 959 960
	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 已提交
961 962
	namespace window {
		/**
D
Daniel Imms 已提交
963 964 965
		 * 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 已提交
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
		 */
		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;
	}
987

D
Daniel Imms 已提交
988
	export namespace window {
D
Daniel Imms 已提交
989 990 991 992 993 994 995
		/**
		 * An event which fires when the [dimensions](#Terminal.dimensions) of the terminal change.
		 */
		export const onDidChangeTerminalDimensions: Event<TerminalDimensionsChangeEvent>;
	}

	export interface Terminal {
996
		/**
997 998 999
		 * 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.
1000
		 */
1001
		readonly dimensions: TerminalDimensions | undefined;
D
Daniel Imms 已提交
1002 1003
	}

1004 1005
	//#endregion

1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
	//#region Terminal link handlers https://github.com/microsoft/vscode/issues/91606

	export namespace window {
		/**
		 * Register a [TerminalLinkHandler](#TerminalLinkHandler) that can be used to intercept and
		 * handle links that are activated within terminals.
		 * @param handler The link handler being registered.
		 * @return A disposable that unregisters the link handler.
		 */
		export function registerTerminalLinkHandler(handler: TerminalLinkHandler): Disposable;
	}

	/**
	 * Describes how to handle terminal links.
	 */
	export interface TerminalLinkHandler {
		/**
		 * Handles a link that is activated within the terminal.
		 *
		 * @param terminal The terminal the link was activated on.
		 * @param link The text of the link activated.
		 * @return Whether the link was handled, if the link was handled this link will not be
		 * considered by any other extension or by the default built-in link handler.
		 */
		handleLink(terminal: Terminal, link: string): ProviderResult<boolean>;
	}

	//#endregion

1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
	//#region Terminal link provider https://github.com/microsoft/vscode/issues/91606

	export namespace window {
		export function registerTerminalLinkProvider(provider: TerminalLinkProvider): Disposable;
	}

	export interface TerminalLinkContext {
		/**
		 * This is the text from the unwrapped line in the terminal.
		 */
		line: string;

		/**
		 * The terminal the link belongs to.
		 */
		terminal: Terminal;
	}

1053
	export interface TerminalLinkProvider<T extends TerminalLink = TerminalLink> {
D
Daniel Imms 已提交
1054
		/**
1055 1056 1057
		 * Provide terminal links for the given context. Note that this can be called multiple times
		 * even before previous calls resolve, make sure to not share global objects (eg. `RegExp`)
		 * that could have problems when asynchronous usage may overlap.
D
Daniel Imms 已提交
1058 1059
		 * @param context Information about what links are being provided for.
		 */
1060 1061 1062 1063 1064
		provideTerminalLinks(context: TerminalLinkContext): ProviderResult<T[]>

		/**
		 * Handle an activated terminal link.
		 */
D
Daniel Imms 已提交
1065
		handleTerminalLink(link: T): void;
1066 1067 1068 1069
	}

	export interface TerminalLink {
		/**
1070
		 * The 0-based start index of the link on [TerminalLinkContext.line](#TerminalLinkContext.line].
1071 1072 1073 1074
		 */
		startIndex: number;

		/**
1075
		 * The 0-based end index of the link on [TerminalLinkContext.line](#TerminalLinkContext.line].
1076
		 */
1077
		endIndex: number;
1078 1079 1080 1081

		/**
		 * The tooltip text when you hover over this link.
		 *
1082 1083 1084
		 * If a tooltip is provided, is will be displayed in a string that includes instructions on
		 * how to trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary
		 * depending on OS, user settings, and localization.
1085 1086 1087 1088 1089 1090
		 */
		tooltip?: string;
	}

	//#endregion

1091
	//#region @jrieken -> exclusive document filters
1092 1093 1094 1095 1096 1097

	export interface DocumentFilter {
		exclusive?: boolean;
	}

	//#endregion
C
Christof Marti 已提交
1098

1099
	//#region @alexdima - OnEnter enhancement
1100 1101 1102 1103 1104 1105 1106
	export interface OnEnterRule {
		/**
		 * This rule will only execute if the text above the this line matches this regular expression.
		 */
		oneLineAboveText?: RegExp;
	}
	//#endregion
1107

1108
	//#region Tree View: https://github.com/microsoft/vscode/issues/61313
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
	/**
	 * Label describing the [Tree item](#TreeItem)
	 */
	export interface TreeItemLabel {

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

		/**
S
Sandeep Somavarapu 已提交
1120
		 * Ranges in the label to highlight. A range is defined as a tuple of two number where the
S
Sandeep Somavarapu 已提交
1121
		 * first is the inclusive start index and the second the exclusive end index
1122
		 */
S
Sandeep Somavarapu 已提交
1123
		highlights?: [number, number][];
1124 1125 1126

	}

A
Alex Ross 已提交
1127 1128 1129 1130 1131
	// https://github.com/microsoft/vscode/issues/100741
	export interface TreeDataProvider<T> {
		resolveTreeItem?(element: T, item: TreeItem2): TreeItem2 | Thenable<TreeItem2>;
	}

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

1138 1139 1140 1141 1142
		/**
		 * Content to be shown when you hover over the tree item.
		 */
		tooltip?: string | MarkdownString | /* for compilation */ any;

1143 1144 1145 1146 1147 1148
		/**
		 * @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);
	}
1149
	//#endregion
1150

1151
	//#region CustomExecution: https://github.com/microsoft/vscode/issues/81007
1152 1153 1154
	/**
	 * A task to execute
	 */
G
Gabriel DeBacker 已提交
1155
	export class Task2 extends Task {
1156
		detail?: string;
1157
	}
G
Gabriel DeBacker 已提交
1158

1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
	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>);
	}
1170
	//#endregion
1171

1172
	//#region Task presentation group: https://github.com/microsoft/vscode/issues/47265
1173 1174 1175 1176 1177 1178 1179
	export interface TaskPresentationOptions {
		/**
		 * Controls whether the task is executed in a specific terminal group using split panes.
		 */
		group?: string;
	}
	//#endregion
1180

1181
	//#region Status bar item with ID and Name: https://github.com/microsoft/vscode/issues/74972
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203

	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;

1204 1205 1206 1207 1208
			/**
			 * Accessibility information used when screen reader interacts with this status bar item.
			 */
			accessibilityInformation?: AccessibilityInformation;

1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
			/**
			 * 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
1233

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

P
Pine Wu 已提交
1236 1237 1238 1239
	/**
	 * The rename provider interface defines the contract between extensions and
	 * the live-rename feature.
	 */
A
Alexandru Dima 已提交
1240
	export interface OnTypeRenameProvider {
P
Pine Wu 已提交
1241 1242 1243 1244 1245 1246 1247 1248 1249
		/**
		 * Provide a list of ranges that can be live renamed together.
		 *
		 * @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
		 * identical length and contain identical text content. The ranges cannot overlap.
		 */
A
Alexandru Dima 已提交
1250 1251 1252 1253
		provideOnTypeRenameRanges(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Range[]>;
	}

	namespace languages {
P
Pine Wu 已提交
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
		/**
		 * 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.
		 * @param stopPattern Stop on type renaming when input text matches the regular expression. Defaults to `^\s`.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerOnTypeRenameProvider(selector: DocumentSelector, provider: OnTypeRenameProvider, stopPattern?: RegExp): Disposable;
A
Alexandru Dima 已提交
1267 1268 1269 1270
	}

	//#endregion

1271
	//#region Custom editor move https://github.com/microsoft/vscode/issues/86146
1272

1273
	// TODO: Also for custom editor
1274

1275
	export interface CustomTextEditorProvider {
M
Matt Bierner 已提交
1276

1277 1278 1279 1280 1281 1282 1283 1284
		/**
		 * 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.
1285
		 * @param token A cancellation token that indicates the result is no longer needed.
1286 1287 1288
		 *
		 * @return Thenable indicating that the webview editor has been moved.
		 */
1289
		moveCustomTextEditor?(newDocument: TextDocument, existingWebviewPanel: WebviewPanel, token: CancellationToken): Thenable<void>;
1290 1291 1292
	}

	//#endregion
1293

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

	export interface QuickPick<T extends QuickPickItem> extends QuickInput {
		/**
1298 1299
		 * An optional flag to sort the final results by index of first query match in label. Defaults to true.
		 */
P
Peter Elmers 已提交
1300 1301
		sortByLabel: boolean;
	}
E
Eric Amodio 已提交
1302 1303

	//#endregion
S
Sandeep Somavarapu 已提交
1304

1305
	//#region @rebornix: Notebook
R
rebornix 已提交
1306

R
rebornix 已提交
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
	export enum CellKind {
		Markdown = 1,
		Code = 2
	}

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

R
rebornix 已提交
1318
	export interface CellStreamOutput {
R
rebornix 已提交
1319
		outputKind: CellOutputKind.Text;
R
rebornix 已提交
1320 1321 1322
		text: string;
	}

R
rebornix 已提交
1323
	export interface CellErrorOutput {
R
rebornix 已提交
1324
		outputKind: CellOutputKind.Error;
R
rebornix 已提交
1325 1326 1327 1328 1329 1330 1331
		/**
		 * Exception Name
		 */
		ename: string;
		/**
		 * Exception Value
		 */
R
rebornix 已提交
1332
		evalue: string;
R
rebornix 已提交
1333 1334 1335
		/**
		 * Exception call stack
		 */
R
rebornix 已提交
1336 1337 1338
		traceback: string[];
	}

R
rebornix 已提交
1339 1340 1341 1342 1343 1344 1345
	export interface NotebookCellOutputMetadata {
		/**
		 * Additional attributes of a cell metadata.
		 */
		custom?: { [key: string]: any };
	}

R
rebornix 已提交
1346
	export interface CellDisplayOutput {
R
rebornix 已提交
1347
		outputKind: CellOutputKind.Rich;
R
rebornix 已提交
1348 1349 1350 1351 1352 1353
		/**
		 * { mime_type: value }
		 *
		 * Example:
		 * ```json
		 * {
R
rebornix 已提交
1354
		 *   "outputKind": vscode.CellOutputKind.Rich,
R
rebornix 已提交
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
		 *   "data": {
		 *      "text/html": [
		 *          "<h1>Hello</h1>"
		 *       ],
		 *      "text/plain": [
		 *        "<IPython.lib.display.IFrame at 0x11dee3e80>"
		 *      ]
		 *   }
		 * }
		 */
R
rebornix 已提交
1365
		data: { [key: string]: any; };
R
rebornix 已提交
1366 1367

		readonly metadata?: NotebookCellOutputMetadata;
R
rebornix 已提交
1368 1369
	}

R
rebornix 已提交
1370
	export type CellOutput = CellStreamOutput | CellErrorOutput | CellDisplayOutput;
R
rebornix 已提交
1371

R
Rob Lourens 已提交
1372 1373 1374 1375 1376 1377 1378
	export enum NotebookCellRunState {
		Running = 1,
		Idle = 2,
		Success = 3,
		Error = 4
	}

R
rebornix 已提交
1379
	export interface NotebookCellMetadata {
1380 1381 1382
		/**
		 * Controls if the content of a cell is editable or not.
		 */
R
rebornix 已提交
1383
		editable?: boolean;
R
rebornix 已提交
1384 1385 1386 1387 1388

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

1391 1392 1393 1394 1395 1396
		/**
		 * Controls if the cell has a margin to support the breakpoint UI.
		 * This metadata is ignored for markdown cell.
		 */
		breakpointMargin?: boolean;

1397 1398 1399 1400 1401 1402
		/**
		 * Whether the [execution order](#NotebookCellMetadata.executionOrder) indicator will be displayed.
		 * Defaults to true.
		 */
		hasExecutionOrder?: boolean;

R
rebornix 已提交
1403
		/**
1404
		 * The order in which this cell was executed.
R
rebornix 已提交
1405
		 */
1406
		executionOrder?: number;
R
Rob Lourens 已提交
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416

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

		/**
		 * The cell's current run state
		 */
		runState?: NotebookCellRunState;
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426

		/**
		 * 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 已提交
1427 1428 1429 1430

		/**
		 * Additional attributes of a cell metadata.
		 */
R
rebornix 已提交
1431
		custom?: { [key: string]: any };
R
rebornix 已提交
1432 1433
	}

R
rebornix 已提交
1434
	export interface NotebookCell {
1435
		readonly notebook: NotebookDocument;
1436
		readonly uri: Uri;
R
rebornix 已提交
1437
		readonly cellKind: CellKind;
1438
		readonly document: TextDocument;
R
rebornix 已提交
1439
		language: string;
R
rebornix 已提交
1440
		outputs: CellOutput[];
R
rebornix 已提交
1441
		metadata: NotebookCellMetadata;
R
rebornix 已提交
1442 1443 1444
	}

	export interface NotebookDocumentMetadata {
1445 1446
		/**
		 * Controls if users can add or delete cells
1447
		 * Defaults to true
1448
		 */
1449
		editable?: boolean;
R
rebornix 已提交
1450

1451 1452 1453 1454 1455 1456
		/**
		 * Controls whether the full notebook can be run at once.
		 * Defaults to true
		 */
		runnable?: boolean;

1457 1458
		/**
		 * Default value for [cell editable metadata](#NotebookCellMetadata.editable).
1459
		 * Defaults to true.
1460
		 */
1461
		cellEditable?: boolean;
R
rebornix 已提交
1462 1463 1464

		/**
		 * Default value for [cell runnable metadata](#NotebookCellMetadata.runnable).
1465
		 * Defaults to true.
R
rebornix 已提交
1466
		 */
1467
		cellRunnable?: boolean;
R
rebornix 已提交
1468

1469
		/**
1470
		 * Default value for [cell hasExecutionOrder metadata](#NotebookCellMetadata.hasExecutionOrder).
1471 1472
		 * Defaults to true.
		 */
1473
		cellHasExecutionOrder?: boolean;
R
rebornix 已提交
1474 1475

		displayOrder?: GlobPattern[];
R
rebornix 已提交
1476 1477

		/**
1478
		 * Additional attributes of the document metadata.
R
rebornix 已提交
1479
		 */
1480
		custom?: { [key: string]: any };
R
rebornix 已提交
1481 1482
	}

R
rebornix 已提交
1483 1484 1485
	export interface NotebookDocument {
		readonly uri: Uri;
		readonly fileName: string;
R
rebornix 已提交
1486
		readonly viewType: string;
R
rebornix 已提交
1487
		readonly isDirty: boolean;
R
rebornix 已提交
1488
		readonly cells: NotebookCell[];
R
rebornix 已提交
1489
		languages: string[];
R
rebornix 已提交
1490
		displayOrder?: GlobPattern[];
1491
		metadata: NotebookDocumentMetadata;
1492 1493
	}

1494
	export interface NotebookConcatTextDocument {
1495 1496
		isClosed: boolean;
		dispose(): void;
1497
		onDidChange: Event<void>;
1498 1499 1500
		version: number;
		getText(): string;
		getText(range: Range): string;
1501

1502 1503
		offsetAt(position: Position): number;
		positionAt(offset: number): Position;
1504 1505 1506
		validateRange(range: Range): Range;
		validatePosition(position: Position): Position;

1507 1508
		locationAt(positionOrRange: Position | Range): Location;
		positionAt(location: Location): Position;
1509
		contains(uri: Uri): boolean
R
rebornix 已提交
1510 1511
	}

R
rebornix 已提交
1512
	export interface NotebookEditorCellEdit {
R
rebornix 已提交
1513
		insert(index: number, content: string | string[], language: string, type: CellKind, outputs: CellOutput[], metadata: NotebookCellMetadata | undefined): void;
R
rebornix 已提交
1514 1515 1516
		delete(index: number): void;
	}

R
rebornix 已提交
1517
	export interface NotebookEditor {
R
rebornix 已提交
1518 1519 1520
		/**
		 * The document associated with this notebook editor.
		 */
R
rebornix 已提交
1521
		readonly document: NotebookDocument;
R
rebornix 已提交
1522 1523 1524 1525 1526

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

R
rebornix 已提交
1528 1529 1530
		/**
		 * The column in which this editor shows.
		 */
R
rebornix 已提交
1531
		viewColumn?: ViewColumn;
1532

R
rebornix 已提交
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
		/**
		 * Whether the panel is active (focused by the user).
		 */
		readonly active: boolean;

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

R
rebornix 已提交
1543 1544 1545 1546 1547
		/**
		 * Fired when the panel is disposed.
		 */
		readonly onDidDispose: Event<void>;

1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
		/**
		 * 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 已提交
1561 1562 1563 1564 1565
		/**
		 * Convert a uri for the local file system to one that can be used inside outputs webview.
		 */
		asWebviewUri(localResource: Uri): Uri;

R
rebornix 已提交
1566
		edit(callback: (editBuilder: NotebookEditorCellEdit) => void): Thenable<boolean>;
R
rebornix 已提交
1567 1568
	}

R
rebornix 已提交
1569
	export interface NotebookOutputSelector {
R
rebornix 已提交
1570
		mimeTypes?: string[];
R
rebornix 已提交
1571 1572
	}

1573 1574 1575 1576 1577 1578
	export interface NotebookRenderRequest {
		output: CellDisplayOutput;
		mimeType: string;
		outputId: string;
	}

R
rebornix 已提交
1579
	export interface NotebookOutputRenderer {
R
rebornix 已提交
1580 1581 1582
		/**
		 *
		 * @returns HTML fragment. We can probably return `CellOutput` instead of string ?
1583
		 *
R
rebornix 已提交
1584
		 */
1585 1586
		render(document: NotebookDocument, request: NotebookRenderRequest): string;

1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600
		/**
		 * Call before HTML from the renderer is executed, and will be called for
		 * every editor associated with notebook documents where the renderer
		 * is or was used.
		 *
		 * The communication object will only send and receive messages to the
		 * render API, retrieved via `acquireNotebookRendererApi`, acquired with
		 * this specific renderer's ID.
		 *
		 * If you need to keep an association between the communication object
		 * and the document for use in the `render()` method, you can use a WeakMap.
		 */
		resolveNotebook?(document: NotebookDocument, communication: NotebookCommunication): void;

1601
		readonly preloads?: Uri[];
R
rebornix 已提交
1602 1603
	}

1604
	export interface NotebookCellsChangeData {
R
rebornix 已提交
1605 1606
		readonly start: number;
		readonly deletedCount: number;
1607
		readonly deletedItems: NotebookCell[];
R
rebornix 已提交
1608 1609 1610
		readonly items: NotebookCell[];
	}

R
rebornix 已提交
1611
	export interface NotebookCellsChangeEvent {
R
rebornix 已提交
1612 1613 1614 1615 1616

		/**
		 * The affected document.
		 */
		readonly document: NotebookDocument;
1617
		readonly changes: ReadonlyArray<NotebookCellsChangeData>;
R
rebornix 已提交
1618 1619
	}

R
rebornix 已提交
1620
	export interface NotebookCellMoveEvent {
R
rebornix 已提交
1621 1622

		/**
R
rebornix 已提交
1623
		 * The affected document.
R
rebornix 已提交
1624
		 */
R
rebornix 已提交
1625
		readonly document: NotebookDocument;
R
rebornix 已提交
1626
		readonly index: number;
R
rebornix 已提交
1627
		readonly newIndex: number;
R
rebornix 已提交
1628 1629
	}

1630
	export interface NotebookCellOutputsChangeEvent {
R
rebornix 已提交
1631 1632 1633 1634 1635

		/**
		 * The affected document.
		 */
		readonly document: NotebookDocument;
1636
		readonly cells: NotebookCell[];
R
rebornix 已提交
1637 1638 1639
	}

	export interface NotebookCellLanguageChangeEvent {
R
rebornix 已提交
1640 1641

		/**
R
rebornix 已提交
1642
		 * The affected document.
R
rebornix 已提交
1643
		 */
R
rebornix 已提交
1644 1645 1646
		readonly document: NotebookDocument;
		readonly cell: NotebookCell;
		readonly language: string;
R
rebornix 已提交
1647 1648
	}

R
rebornix 已提交
1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
	export interface NotebookCellData {
		readonly cellKind: CellKind;
		readonly source: string;
		language: string;
		outputs: CellOutput[];
		metadata: NotebookCellMetadata;
	}

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

1663 1664 1665 1666 1667 1668 1669 1670
	interface NotebookDocumentContentChangeEvent {

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

R
rebornix 已提交
1671 1672 1673 1674 1675 1676
	interface NotebookDocumentEditEvent {

		/**
		 * The document that the edit is for.
		 */
		readonly document: NotebookDocument;
1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701

		/**
		 * 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 已提交
1702 1703
	}

1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
	interface NotebookDocumentBackup {
		/**
		 * Unique identifier for the backup.
		 *
		 * This id is passed back to your extension in `openCustomDocument` when opening a custom editor from a backup.
		 */
		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;
	}

1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760
	/**
	 * 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 已提交
1761
	export interface NotebookContentProvider {
1762
		openNotebook(uri: Uri, openContext: NotebookDocumentOpenContext): NotebookData | Promise<NotebookData>;
1763
		resolveNotebook(document: NotebookDocument, webview: NotebookCommunication): Promise<void>;
R
rebornix 已提交
1764 1765
		saveNotebook(document: NotebookDocument, cancellation: CancellationToken): Promise<void>;
		saveNotebookAs(targetResource: Uri, document: NotebookDocument, cancellation: CancellationToken): Promise<void>;
R
rebornix 已提交
1766
		readonly onDidChangeNotebook: Event<NotebookDocumentContentChangeEvent | NotebookDocumentEditEvent>;
R
rebornix 已提交
1767
		backupNotebook(document: NotebookDocument, context: NotebookDocumentBackupContext, cancellation: CancellationToken): Promise<NotebookDocumentBackup>;
R
rebornix 已提交
1768

R
rebornix 已提交
1769
		kernel?: NotebookKernel;
R
rebornix 已提交
1770 1771
	}

R
rebornix 已提交
1772
	export interface NotebookKernel {
R
rebornix 已提交
1773
		label: string;
R
rebornix 已提交
1774 1775 1776 1777 1778
		preloads?: Uri[];
		executeCell(document: NotebookDocument, cell: NotebookCell, token: CancellationToken): Promise<void>;
		executeAllCells(document: NotebookDocument, token: CancellationToken): Promise<void>;
	}

R
rebornix 已提交
1779
	export namespace notebook {
R
rebornix 已提交
1780 1781 1782 1783 1784
		export function registerNotebookContentProvider(
			notebookType: string,
			provider: NotebookContentProvider
		): Disposable;

R
rebornix 已提交
1785 1786 1787 1788 1789 1790
		export function registerNotebookKernel(
			id: string,
			selectors: GlobPattern[],
			kernel: NotebookKernel
		): Disposable;

R
rebornix 已提交
1791
		export function registerNotebookOutputRenderer(
R
rebornix 已提交
1792
			id: string,
R
rebornix 已提交
1793 1794 1795 1796
			outputSelector: NotebookOutputSelector,
			renderer: NotebookOutputRenderer
		): Disposable;

R
rebornix 已提交
1797
		export const onDidOpenNotebookDocument: Event<NotebookDocument>;
R
rebornix 已提交
1798
		export const onDidCloseNotebookDocument: Event<NotebookDocument>;
1799 1800 1801 1802 1803 1804

		/**
		 * All currently known notebook documents.
		 */
		export const notebookDocuments: ReadonlyArray<NotebookDocument>;

R
rebornix 已提交
1805 1806
		export let visibleNotebookEditors: NotebookEditor[];
		export const onDidChangeVisibleNotebookEditors: Event<NotebookEditor[]>;
R
rebornix 已提交
1807

R
rebornix 已提交
1808
		export let activeNotebookEditor: NotebookEditor | undefined;
R
rebornix 已提交
1809
		export const onDidChangeActiveNotebookEditor: Event<NotebookEditor | undefined>;
R
rebornix 已提交
1810
		export const onDidChangeNotebookCells: Event<NotebookCellsChangeEvent>;
1811
		export const onDidChangeCellOutputs: Event<NotebookCellOutputsChangeEvent>;
R
rebornix 已提交
1812
		export const onDidChangeCellLanguage: Event<NotebookCellLanguageChangeEvent>;
1813
		/**
J
Johannes Rieken 已提交
1814 1815
		 * 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.
1816 1817 1818 1819 1820
		 *
		 * @param notebook
		 * @param selector
		 */
		export function createConcatTextDocument(notebook: NotebookDocument, selector?: DocumentSelector): NotebookConcatTextDocument;
R
rebornix 已提交
1821 1822 1823
	}

	//#endregion
R
rebornix 已提交
1824

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

P
label2  
Pine Wu 已提交
1827 1828 1829 1830
	export interface CompletionItem {
		/**
		 * Will be merged into CompletionItem#label
		 */
P
Pine Wu 已提交
1831
		label2?: CompletionItemLabel;
P
label2  
Pine Wu 已提交
1832 1833
	}

1834 1835
	export interface CompletionItemLabel {
		/**
P
Pine Wu 已提交
1836
		 * The function or variable. Rendered leftmost.
1837
		 */
P
Pine Wu 已提交
1838
		name: string;
1839

P
Pine Wu 已提交
1840
		/**
1841
		 * The parameters without the return type. Render after `name`.
P
Pine Wu 已提交
1842
		 */
1843
		parameters?: string;
P
Pine Wu 已提交
1844 1845

		/**
P
Pine Wu 已提交
1846
		 * The fully qualified name, like package name or file path. Rendered after `signature`.
P
Pine Wu 已提交
1847 1848
		 */
		qualifier?: string;
1849

P
Pine Wu 已提交
1850
		/**
P
Pine Wu 已提交
1851
		 * The return-type of a function or type of a property/variable. Rendered rightmost.
P
Pine Wu 已提交
1852
		 */
P
Pine Wu 已提交
1853
		type?: string;
1854 1855 1856 1857
	}

	//#endregion

1858
	//#region @eamodio - timeline: https://github.com/microsoft/vscode/issues/84297
1859 1860 1861

	export class TimelineItem {
		/**
1862
		 * A timestamp (in milliseconds since 1 January 1970 00:00:00) for when the timeline item occurred.
1863
		 */
E
Eric Amodio 已提交
1864
		timestamp: number;
1865 1866

		/**
1867
		 * A human-readable string describing the timeline item.
1868 1869 1870 1871
		 */
		label: string;

		/**
1872
		 * Optional id for the timeline item. It must be unique across all the timeline items provided by this source.
1873
		 *
1874
		 * If not provided, an id is generated using the timeline item's timestamp.
1875 1876 1877 1878
		 */
		id?: string;

		/**
1879
		 * The icon path or [ThemeIcon](#ThemeIcon) for the timeline item.
1880
		 */
R
rebornix 已提交
1881
		iconPath?: Uri | { light: Uri; dark: Uri; } | ThemeIcon;
1882 1883

		/**
1884
		 * A human readable string describing less prominent details of the timeline item.
1885 1886 1887 1888 1889 1890
		 */
		description?: string;

		/**
		 * The tooltip text when you hover over the timeline item.
		 */
1891
		detail?: string;
1892 1893 1894 1895 1896 1897 1898

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

		/**
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914
		 * 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`.
1915 1916 1917
		 */
		contextValue?: string;

1918 1919 1920 1921 1922
		/**
		 * Accessibility information used when screen reader interacts with this timeline item.
		 */
		accessibilityInformation?: AccessibilityInformation;

1923 1924
		/**
		 * @param label A human-readable string describing the timeline item
E
Eric Amodio 已提交
1925
		 * @param timestamp A timestamp (in milliseconds since 1 January 1970 00:00:00) for when the timeline item occurred
1926
		 */
E
Eric Amodio 已提交
1927
		constructor(label: string, timestamp: number);
1928 1929
	}

1930
	export interface TimelineChangeEvent {
E
Eric Amodio 已提交
1931
		/**
1932
		 * The [uri](#Uri) of the resource for which the timeline changed.
E
Eric Amodio 已提交
1933
		 */
E
Eric Amodio 已提交
1934
		uri: Uri;
1935

E
Eric Amodio 已提交
1936
		/**
1937
		 * A flag which indicates whether the entire timeline should be reset.
E
Eric Amodio 已提交
1938
		 */
1939 1940
		reset?: boolean;
	}
E
Eric Amodio 已提交
1941

1942 1943 1944
	export interface Timeline {
		readonly paging?: {
			/**
E
Eric Amodio 已提交
1945
			 * A provider-defined cursor specifying the starting point of timeline items which are after the ones returned.
E
Eric Amodio 已提交
1946
			 * Use `undefined` to signal that there are no more items to be returned.
1947
			 */
E
Eric Amodio 已提交
1948
			readonly cursor: string | undefined;
R
rebornix 已提交
1949
		};
E
Eric Amodio 已提交
1950 1951

		/**
1952
		 * An array of [timeline items](#TimelineItem).
E
Eric Amodio 已提交
1953
		 */
1954
		readonly items: readonly TimelineItem[];
E
Eric Amodio 已提交
1955 1956
	}

1957
	export interface TimelineOptions {
E
Eric Amodio 已提交
1958
		/**
E
Eric Amodio 已提交
1959
		 * A provider-defined cursor specifying the starting point of the timeline items that should be returned.
E
Eric Amodio 已提交
1960
		 */
1961
		cursor?: string;
E
Eric Amodio 已提交
1962 1963

		/**
1964 1965
		 * 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 已提交
1966
		 */
R
rebornix 已提交
1967
		limit?: number | { timestamp: number; id?: string; };
E
Eric Amodio 已提交
1968 1969
	}

1970
	export interface TimelineProvider {
1971
		/**
1972 1973
		 * 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`.
1974
		 */
E
Eric Amodio 已提交
1975
		onDidChange?: Event<TimelineChangeEvent | undefined>;
1976 1977

		/**
1978
		 * An identifier of the source of the timeline items. This can be used to filter sources.
1979
		 */
1980
		readonly id: string;
1981

E
Eric Amodio 已提交
1982
		/**
1983
		 * 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 已提交
1984
		 */
1985
		readonly label: string;
1986 1987

		/**
E
Eric Amodio 已提交
1988
		 * Provide [timeline items](#TimelineItem) for a [Uri](#Uri).
1989
		 *
1990
		 * @param uri The [uri](#Uri) of the file to provide the timeline for.
1991
		 * @param options A set of options to determine how results should be returned.
1992
		 * @param token A cancellation token.
E
Eric Amodio 已提交
1993
		 * @return The [timeline result](#TimelineResult) or a thenable that resolves to such. The lack of a result
1994 1995
		 * can be signaled by returning `undefined`, `null`, or an empty array.
		 */
1996
		provideTimeline(uri: Uri, options: TimelineOptions, token: CancellationToken): ProviderResult<Timeline>;
1997 1998 1999 2000 2001 2002 2003 2004 2005 2006
	}

	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.
		 *
2007
		 * @param scheme A scheme or schemes that defines which documents this provider is applicable to. Can be `*` to target all documents.
2008 2009
		 * @param provider A timeline provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Eric Amodio 已提交
2010
		*/
2011
		export function registerTimelineProvider(scheme: string | string[], provider: TimelineProvider): Disposable;
2012 2013 2014
	}

	//#endregion
2015

2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034
	//#region https://github.com/microsoft/vscode/issues/91555

	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>;
	}

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