From c977eb647e235aee52c0ecb04c000be5f5807c9a Mon Sep 17 00:00:00 2001 From: Johannes Rieken Date: Mon, 18 Nov 2019 14:20:34 +0100 Subject: [PATCH] tweak events and add some jsdoc, #43768 --- src/vs/vscode.proposed.d.ts | 53 ++++++++++++++----- .../common/extHostFileSystemEventService.ts | 12 ++--- 2 files changed, 45 insertions(+), 20 deletions(-) diff --git a/src/vs/vscode.proposed.d.ts b/src/vs/vscode.proposed.d.ts index e1a5cb97a3861..889ed495c15a4 100644 --- a/src/vs/vscode.proposed.d.ts +++ b/src/vs/vscode.proposed.d.ts @@ -825,46 +825,71 @@ declare module 'vscode' { //#region mjbvz,joh: https://github.com/Microsoft/vscode/issues/43768 export interface FileCreateEvent { - readonly created: ReadonlyArray; + + /** + * The files that got created. + */ + readonly files: ReadonlyArray; } export interface FileWillCreateEvent { - readonly creating: ReadonlyArray; - waitUntil(thenable: Thenable): void; + + /** + * The files that are going to be created. + */ + readonly files: ReadonlyArray; + waitUntil(thenable: Thenable): void; + waitUntil(thenable: Thenable): void; } export interface FileDeleteEvent { - readonly deleted: ReadonlyArray; + + /** + * The files that got deleted. + */ + readonly files: ReadonlyArray; } export interface FileWillDeleteEvent { - readonly deleting: ReadonlyArray; - waitUntil(thenable: Thenable): void; + + /** + * The files that are going to be deleted. + */ + readonly files: ReadonlyArray; + waitUntil(thenable: Thenable): void; + waitUntil(thenable: Thenable): void; } export interface FileRenameEvent { - readonly renamed: ReadonlyArray<{ oldUri: Uri, newUri: Uri }>; + + /** + * The files that got renamed. + */ + readonly files: ReadonlyArray<{ oldUri: Uri, newUri: Uri }>; } export interface FileWillRenameEvent { - readonly renaming: ReadonlyArray<{ oldUri: Uri, newUri: Uri }>; - waitUntil(thenable: Thenable): void; + + /** + * The files that are going to be renamed. + */ + readonly files: ReadonlyArray<{ oldUri: Uri, newUri: Uri }>; + waitUntil(thenable: Thenable): void; + waitUntil(thenable: Thenable): void; } export namespace workspace { export const onWillCreateFiles: Event; - export const onDidCreateFiles: Event; - export const onWillDeleteFiles: Event; - export const onDidDeleteFiles: Event; - export const onWillRenameFiles: Event; - export const onDidRenameFiles: Event; + export const onDidCreateFiles: Event; + export const onDidDeleteFiles: Event; + export const onDidRenameFiles: Event; } //#endregion diff --git a/src/vs/workbench/api/common/extHostFileSystemEventService.ts b/src/vs/workbench/api/common/extHostFileSystemEventService.ts index 069b45371c7bd..f39a22d203ed2 100644 --- a/src/vs/workbench/api/common/extHostFileSystemEventService.ts +++ b/src/vs/workbench/api/common/extHostFileSystemEventService.ts @@ -142,13 +142,13 @@ export class ExtHostFileSystemEventService implements ExtHostFileSystemEventServ $onDidRunFileOperation(operation: FileOperation, target: UriComponents, source: UriComponents | undefined): void { switch (operation) { case FileOperation.MOVE: - this._onDidRenameFile.fire(Object.freeze({ renamed: [{ oldUri: URI.revive(source!), newUri: URI.revive(target) }] })); + this._onDidRenameFile.fire(Object.freeze({ files: [{ oldUri: URI.revive(source!), newUri: URI.revive(target) }] })); break; case FileOperation.DELETE: - this._onDidDeleteFile.fire(Object.freeze({ deleted: [URI.revive(target)] })); + this._onDidDeleteFile.fire(Object.freeze({ files: [URI.revive(target)] })); break; case FileOperation.CREATE: - this._onDidCreateFile.fire(Object.freeze({ created: [URI.revive(target)] })); + this._onDidCreateFile.fire(Object.freeze({ files: [URI.revive(target)] })); break; default: //ignore, dont send @@ -179,13 +179,13 @@ export class ExtHostFileSystemEventService implements ExtHostFileSystemEventServ async $onWillRunFileOperation(operation: FileOperation, target: UriComponents, source: UriComponents | undefined): Promise { switch (operation) { case FileOperation.MOVE: - await this._fireWillEvent(this._onWillRenameFile, { renaming: [{ oldUri: URI.revive(source!), newUri: URI.revive(target) }], }); + await this._fireWillEvent(this._onWillRenameFile, { files: [{ oldUri: URI.revive(source!), newUri: URI.revive(target) }], }); break; case FileOperation.DELETE: - await this._fireWillEvent(this._onWillDeleteFile, { deleting: [URI.revive(target)] }); + await this._fireWillEvent(this._onWillDeleteFile, { files: [URI.revive(target)] }); break; case FileOperation.CREATE: - await this._fireWillEvent(this._onWillCreateFile, { creating: [URI.revive(target)] }); + await this._fireWillEvent(this._onWillCreateFile, { files: [URI.revive(target)] }); break; default: //ignore, dont send