Skip to content

Commit

Permalink
Updates view progress proposal - #92421
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric Amodio committed Mar 16, 2020
1 parent 83c5b1c commit 7fcc44c
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 29 deletions.
3 changes: 1 addition & 2 deletions src/vs/platform/progress/common/progress.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ export const enum ProgressLocation {
Extensions = 5,
Window = 10,
Notification = 15,
Dialog = 20,
View = 25
Dialog = 20
}

export interface IProgressOptions {
Expand Down
2 changes: 1 addition & 1 deletion src/vs/vscode.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7932,7 +7932,7 @@ declare module 'vscode' {
/**
* The location at which progress should show.
*/
location: ProgressLocation;
location: ProgressLocation | { viewId: string };

/**
* A human-readable string which will be used to describe the
Expand Down
19 changes: 0 additions & 19 deletions src/vs/vscode.proposed.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1891,23 +1891,4 @@ declare module 'vscode' {

//#endregion

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

export enum ProgressLocation {
/**
* Show progress for a view, as progress bar inside the view (when visible),
* and as an overlay on the activity bar icon. Doesn't support cancellation or discrete progress.
*/
View = 25,
}

export interface ProgressOptions {
/**
* The target view identifier for showing progress when using [ProgressLocation.View](#ProgressLocation.View).
*/
viewId?: string
}

//#endregion

}
2 changes: 1 addition & 1 deletion src/vs/workbench/api/common/extHost.api.impl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -540,7 +540,7 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
return extHostProgress.withProgress(extension, { location: extHostTypes.ProgressLocation.SourceControl }, (progress, token) => task({ report(n: number) { /*noop*/ } }));
},
withProgress<R>(options: vscode.ProgressOptions, task: (progress: vscode.Progress<{ message?: string; worked?: number }>, token: vscode.CancellationToken) => Thenable<R>) {
if (options.location === extHostTypes.ProgressLocation.View) {
if (typeof options.location !== 'number') {
checkProposedApiEnabled(extension);
}
return extHostProgress.withProgress(extension, options, task);
Expand Down
4 changes: 2 additions & 2 deletions src/vs/workbench/api/common/extHostProgress.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ export class ExtHostProgress implements ExtHostProgressShape {

withProgress<R>(extension: IExtensionDescription, options: ProgressOptions, task: (progress: Progress<IProgressStep>, token: CancellationToken) => Thenable<R>): Thenable<R> {
const handle = this._handles++;
const { title, location, cancellable, viewId } = options;
const { title, location, cancellable } = options;
const source = localize('extensionSource', "{0} (Extension)", extension.displayName || extension.name);

this._proxy.$startProgress(handle, { location: ProgressLocation.from(location, viewId), title, source, cancellable }, extension);
this._proxy.$startProgress(handle, { location: ProgressLocation.from(location), title, source, cancellable }, extension);
return this._withProgress(handle, task, !!cancellable);
}

Expand Down
7 changes: 5 additions & 2 deletions src/vs/workbench/api/common/extHostTypeConverters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1093,12 +1093,15 @@ export namespace EndOfLine {
}

export namespace ProgressLocation {
export function from(loc: vscode.ProgressLocation, viewId?: string): MainProgressLocation | string {
export function from(loc: vscode.ProgressLocation | { viewId: string }): MainProgressLocation | string {
if (typeof loc === 'string') {
return loc;
}

switch (loc) {
case types.ProgressLocation.SourceControl: return MainProgressLocation.Scm;
case types.ProgressLocation.Window: return MainProgressLocation.Window;
case types.ProgressLocation.Notification: return MainProgressLocation.Notification;
case types.ProgressLocation.View: return viewId ?? '';
}
throw new Error(`Unknown 'ProgressLocation'`);
}
Expand Down
3 changes: 1 addition & 2 deletions src/vs/workbench/api/common/extHostTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2082,8 +2082,7 @@ export class Task implements vscode.Task2 {
export enum ProgressLocation {
SourceControl = 1,
Window = 10,
Notification = 15,
View = 25
Notification = 15
}

@es5ClassCompat
Expand Down

0 comments on commit 7fcc44c

Please sign in to comment.