Use ReadonlyArray for a few more lists of IActions

mjbvz · mjbvz · commit 9f6de388ea44 · 2019-06-07T10:26:00.000-07:00
Also changes processService to not modify its input actions, which seems like unexpected behavior
diff --git a/src/vs/base/browser/ui/inputbox/inputBox.ts b/src/vs/base/browser/ui/inputbox/inputBox.ts
@@ -28,7 +28,7 @@ export interface IInputOptions extends IInputBoxStyles {
 	readonly type?: string;
 	readonly validationOptions?: IInputValidationOptions;
 	readonly flexibleHeight?: boolean;
-	readonly actions?: IAction[];
+	readonly actions?: ReadonlyArray<IAction>;
 }
 
 export interface IInputBoxStyles {
diff --git a/src/vs/base/parts/tree/browser/tree.ts b/src/vs/base/parts/tree/browser/tree.ts
@@ -576,7 +576,7 @@ export interface IActionProvider {
 	hasActions(tree: ITree | null, element: any): boolean;
 
 	/**
-	 * Returns a promise of an array with the actions of the element that should show up in place right to the element in the tree.
+	 * Returns an array with the actions of the element that should show up in place right to the element in the tree.
 	 */
-	getActions(tree: ITree | null, element: any): IAction[] | null;
+	getActions(tree: ITree | null, element: any): ReadonlyArray<IAction> | null;
 }
diff --git a/src/vs/editor/contrib/contextmenu/contextmenu.ts b/src/vs/editor/contrib/contextmenu/contextmenu.ts
@@ -125,7 +125,7 @@ export class ContextMenuController implements IEditorContribution {
 		}
 	}
 
-	private _getMenuActions(model: ITextModel): IAction[] {
+	private _getMenuActions(model: ITextModel): ReadonlyArray<IAction> {
 		const result: IAction[] = [];
 
 		let contextMenu = this._menuService.createMenu(MenuId.EditorContext, this._contextKeyService);
@@ -141,7 +141,7 @@ export class ContextMenuController implements IEditorContribution {
 		return result;
 	}
 
-	private _doShowContextMenu(actions: IAction[], anchor: IAnchor | null = null): void {
+	private _doShowContextMenu(actions: ReadonlyArray<IAction>, anchor: IAnchor | null = null): void {
 		if (!this._editor.hasModel()) {
 			return;
 		}
diff --git a/src/vs/editor/contrib/gotoError/gotoErrorWidget.ts b/src/vs/editor/contrib/gotoError/gotoErrorWidget.ts
@@ -180,7 +180,7 @@ export class MarkerNavigationWidget extends PeekViewWidget {
 
 	constructor(
 		editor: ICodeEditor,
-		private readonly actions: IAction[],
+		private readonly actions: ReadonlyArray<IAction>,
 		private readonly _themeService: IThemeService
 	) {
 		super(editor, { showArrow: true, showFrame: true, isAccessible: true });
diff --git a/src/vs/platform/progress/common/progress.ts b/src/vs/platform/progress/common/progress.ts
@@ -61,9 +61,9 @@ export interface IProgressOptions {
 }
 
 export interface IProgressNotificationOptions extends IProgressOptions {
-	location: ProgressLocation.Notification;
-	primaryActions?: IAction[];
-	secondaryActions?: IAction[];
+	readonly location: ProgressLocation.Notification;
+	readonly primaryActions?: ReadonlyArray<IAction>;
+	readonly secondaryActions?: ReadonlyArray<IAction>;
 }
 
 export interface IProgressCompositeOptions extends IProgressOptions {
diff --git a/src/vs/workbench/browser/actions.ts b/src/vs/workbench/browser/actions.ts
@@ -24,7 +24,7 @@ export class ActionBarContributor {
 	/**
 	 * Returns an array of primary actions in the given context.
 	 */
-	getActions(context: unknown): IAction[] {
+	getActions(context: unknown): ReadonlyArray<IAction> {
 		return [];
 	}
 }
@@ -66,7 +66,7 @@ export class ContributableActionProvider implements IActionProvider {
 		return false;
 	}
 
-	getActions(tree: ITree, element: unknown): IAction[] {
+	getActions(tree: ITree, element: unknown): ReadonlyArray<IAction> {
 		const actions: IAction[] = [];
 		const context = this.toContext(tree, element);
 
diff --git a/src/vs/workbench/browser/parts/editor/editor.contribution.ts b/src/vs/workbench/browser/parts/editor/editor.contribution.ts
@@ -253,7 +253,7 @@ export class QuickOpenActionContributor extends ActionBarContributor {
 		return !!entry;
 	}
 
-	getActions(context: any): IAction[] {
+	getActions(context: any): ReadonlyArray<IAction> {
 		const actions: Action[] = [];
 
 		const entry = this.getEntry(context);
diff --git a/src/vs/workbench/browser/parts/notifications/notificationsActions.ts b/src/vs/workbench/browser/parts/notifications/notificationsActions.ts
@@ -121,12 +121,12 @@ export class ConfigureNotificationAction extends Action {
 	constructor(
 		id: string,
 		label: string,
-		private _configurationActions: IAction[]
+		private readonly _configurationActions: ReadonlyArray<IAction>
 	) {
 		super(id, label, 'configure-notification-action');
 	}
 
-	get configurationActions(): IAction[] {
+	get configurationActions(): ReadonlyArray<IAction> {
 		return this._configurationActions;
 	}
 }
diff --git a/src/vs/workbench/contrib/tasks/browser/quickOpen.ts b/src/vs/workbench/contrib/tasks/browser/quickOpen.ts
@@ -214,7 +214,7 @@ export class QuickOpenActionContributor extends ActionBarContributor {
 		return !!task;
 	}
 
-	public getActions(context: any): IAction[] {
+	public getActions(context: any): ReadonlyArray<IAction> {
 		let actions: Action[] = [];
 		let task = this.getTask(context);
 		if (task && ContributedTask.is(task) || CustomTask.is(task)) {
diff --git a/src/vs/workbench/contrib/terminal/browser/terminalActions.ts b/src/vs/workbench/contrib/terminal/browser/terminalActions.ts
@@ -1041,7 +1041,7 @@ export class QuickOpenActionTermContributor extends ActionBarContributor {
 		super();
 	}
 
-	public getActions(context: any): IAction[] {
+	public getActions(context: any): ReadonlyArray<IAction> {
 		const actions: Action[] = [];
 		if (context.element instanceof TerminalEntry) {
 			actions.push(this.instantiationService.createInstance(RenameTerminalQuickOpenAction, RenameTerminalQuickOpenAction.ID, RenameTerminalQuickOpenAction.LABEL, context.element));
diff --git a/src/vs/workbench/services/progress/browser/progressService.ts b/src/vs/workbench/services/progress/browser/progressService.ts
@@ -143,8 +143,8 @@ export class ProgressService implements IProgressService {
 				return undefined; // we need a message at least
 			}
 
-			const primaryActions = options.primaryActions || [];
-			const secondaryActions = options.secondaryActions || [];
+			const primaryActions = options.primaryActions ? Array.from(options.primaryActions) : [];
+			const secondaryActions = options.secondaryActions ? Array.from(options.secondaryActions) : [];
 			if (options.cancellable) {
 				const cancelAction = new class extends Action {
 					constructor() {

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ export interface IInputOptions extends IInputBoxStyles {`
`28`	`28`	`readonly type?: string;`
`29`	`29`	`readonly validationOptions?: IInputValidationOptions;`
`30`	`30`	`readonly flexibleHeight?: boolean;`
`31`		`- readonly actions?: IAction[];`
	`31`	`+ readonly actions?: ReadonlyArray<IAction>;`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`export interface IInputBoxStyles {`
Original file line number	Diff line number	Diff line change
`@@ -576,7 +576,7 @@ export interface IActionProvider {`
`576`	`576`	`hasActions(tree: ITree \| null, element: any): boolean;`
`577`	`577`
`578`	`578`	`/**`
`579`		`- * Returns a promise of an array with the actions of the element that should show up in place right to the element in the tree.`
	`579`	`+ * Returns an array with the actions of the element that should show up in place right to the element in the tree.`
`580`	`580`	`*/`
`581`		`- getActions(tree: ITree \| null, element: any): IAction[] \| null;`
	`581`	`+ getActions(tree: ITree \| null, element: any): ReadonlyArray<IAction> \| null;`
`582`	`582`	`}`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ export class ContextMenuController implements IEditorContribution {`
`125`	`125`	`}`
`126`	`126`	`}`
`127`	`127`
`128`		`- private _getMenuActions(model: ITextModel): IAction[] {`
	`128`	`+ private _getMenuActions(model: ITextModel): ReadonlyArray<IAction> {`
`129`	`129`	`const result: IAction[] = [];`
`130`	`130`
`131`	`131`	`let contextMenu = this._menuService.createMenu(MenuId.EditorContext, this._contextKeyService);`
`@@ -141,7 +141,7 @@ export class ContextMenuController implements IEditorContribution {`
`141`	`141`	`return result;`
`142`	`142`	`}`
`143`	`143`
`144`		`- private _doShowContextMenu(actions: IAction[], anchor: IAnchor \| null = null): void {`
	`144`	`+ private _doShowContextMenu(actions: ReadonlyArray<IAction>, anchor: IAnchor \| null = null): void {`
`145`	`145`	`if (!this._editor.hasModel()) {`
`146`	`146`	`return;`
`147`	`147`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,9 +61,9 @@ export interface IProgressOptions {`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`export interface IProgressNotificationOptions extends IProgressOptions {`
`64`		`- location: ProgressLocation.Notification;`
`65`		`- primaryActions?: IAction[];`
`66`		`- secondaryActions?: IAction[];`
	`64`	`+ readonly location: ProgressLocation.Notification;`
	`65`	`+ readonly primaryActions?: ReadonlyArray<IAction>;`
	`66`	`+ readonly secondaryActions?: ReadonlyArray<IAction>;`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`export interface IProgressCompositeOptions extends IProgressOptions {`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ export class ActionBarContributor {`
`24`	`24`	`/**`
`25`	`25`	`* Returns an array of primary actions in the given context.`
`26`	`26`	`*/`
`27`		`- getActions(context: unknown): IAction[] {`
	`27`	`+ getActions(context: unknown): ReadonlyArray<IAction> {`
`28`	`28`	`return [];`
`29`	`29`	`}`
`30`	`30`	`}`
`@@ -66,7 +66,7 @@ export class ContributableActionProvider implements IActionProvider {`
`66`	`66`	`return false;`
`67`	`67`	`}`
`68`	`68`
`69`		`- getActions(tree: ITree, element: unknown): IAction[] {`
	`69`	`+ getActions(tree: ITree, element: unknown): ReadonlyArray<IAction> {`
`70`	`70`	`const actions: IAction[] = [];`
`71`	`71`	`const context = this.toContext(tree, element);`
`72`	`72`
Original file line number	Diff line number	Diff line change
`@@ -253,7 +253,7 @@ export class QuickOpenActionContributor extends ActionBarContributor {`
`253`	`253`	`return !!entry;`
`254`	`254`	`}`
`255`	`255`
`256`		`- getActions(context: any): IAction[] {`
	`256`	`+ getActions(context: any): ReadonlyArray<IAction> {`
`257`	`257`	`const actions: Action[] = [];`
`258`	`258`
`259`	`259`	`const entry = this.getEntry(context);`
Original file line number	Diff line number	Diff line change
`@@ -121,12 +121,12 @@ export class ConfigureNotificationAction extends Action {`
`121`	`121`	`constructor(`
`122`	`122`	`id: string,`
`123`	`123`	`label: string,`
`124`		`- private _configurationActions: IAction[]`
	`124`	`+ private readonly _configurationActions: ReadonlyArray<IAction>`
`125`	`125`	`) {`
`126`	`126`	`super(id, label, 'configure-notification-action');`
`127`	`127`	`}`
`128`	`128`
`129`		`- get configurationActions(): IAction[] {`
	`129`	`+ get configurationActions(): ReadonlyArray<IAction> {`
`130`	`130`	`return this._configurationActions;`
`131`	`131`	`}`
`132`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,7 @@ export class QuickOpenActionContributor extends ActionBarContributor {`
`214`	`214`	`return !!task;`
`215`	`215`	`}`
`216`	`216`
`217`		`- public getActions(context: any): IAction[] {`
	`217`	`+ public getActions(context: any): ReadonlyArray<IAction> {`
`218`	`218`	`let actions: Action[] = [];`
`219`	`219`	`let task = this.getTask(context);`
`220`	`220`	`if (task && ContributedTask.is(task) \|\| CustomTask.is(task)) {`
Original file line number	Diff line number	Diff line change
`@@ -1041,7 +1041,7 @@ export class QuickOpenActionTermContributor extends ActionBarContributor {`
`1041`	`1041`	`super();`
`1042`	`1042`	`}`
`1043`	`1043`
`1044`		`- public getActions(context: any): IAction[] {`
	`1044`	`+ public getActions(context: any): ReadonlyArray<IAction> {`
`1045`	`1045`	`const actions: Action[] = [];`
`1046`	`1046`	`if (context.element instanceof TerminalEntry) {`
`1047`	`1047`	`actions.push(this.instantiationService.createInstance(RenameTerminalQuickOpenAction, RenameTerminalQuickOpenAction.ID, RenameTerminalQuickOpenAction.LABEL, context.element));`