code-server/packages/ide/src/fill/notification.ts

80 lines
1.9 KiB
TypeScript
Raw Normal View History

2019-01-31 04:40:01 +07:00
import { logger, field } from "@coder/logger";
export interface INotificationHandle {
close(): void;
updateMessage(message: string): void;
updateButtons(buttons: INotificationButton[]): void;
}
export enum Severity {
Ignore = 0,
Info = 1,
Warning = 2,
Error = 3,
}
export interface INotificationButton {
label: string;
run(): void;
}
/**
* Optional notification service.
*/
export interface INotificationService {
error(error: Error): void;
prompt(severity: Severity, message: string, buttons: INotificationButton[], onCancel: () => void): INotificationHandle;
}
export interface IProgress {
/**
* Report progress, which should be the completed percentage from 0 to 100.
2019-01-31 04:40:01 +07:00
*/
report(progress: number): void;
}
export interface IProgressService {
/**
* Start a new progress bar that resolves & disappears when the task finishes.
*/
start<T>(title: string, task: (progress: IProgress) => Promise<T>, onCancel: () => void): Promise<T>;
}
/**
2019-02-07 07:11:31 +07:00
* Console-based notification service.
2019-01-31 04:40:01 +07:00
*/
export class NotificationService implements INotificationService {
public error(error: Error): void {
logger.error(error.message, field("error", error));
}
2019-02-07 07:11:31 +07:00
public prompt(severity: Severity, message: string, _buttons: INotificationButton[], _onCancel: () => void): INotificationHandle {
switch (severity) {
case Severity.Info: logger.info(message); break;
case Severity.Warning: logger.warn(message); break;
case Severity.Error: logger.error(message); break;
}
return {
close: (): void => undefined,
updateMessage: (): void => undefined,
updateButtons: (): void => undefined,
};
2019-01-31 04:40:01 +07:00
}
}
/**
2019-02-07 07:11:31 +07:00
* Console-based progress service.
2019-01-31 04:40:01 +07:00
*/
export class ProgressService implements IProgressService {
public start<T>(title: string, task: (progress: IProgress) => Promise<T>): Promise<T> {
logger.info(title);
return task({
report: (progress): void => {
logger.info(`${title} progress: ${progress}`);
},
});
}
}