Mark keybindings arrays as readonly

mjbvz · mjbvz · commit e7f559cd3b31 · 2019-11-07T07:57:04.000-08:00
These arrays should not be mutated by callers as it would cause the keybinding service to have unexpected behavior
diff --git a/src/vs/platform/keybinding/common/abstractKeybindingService.ts b/src/vs/platform/keybinding/common/abstractKeybindingService.ts
@@ -65,11 +65,11 @@ export abstract class AbstractKeybindingService extends Disposable implements IK
 		return '';
 	}
 
-	public getDefaultKeybindings(): ResolvedKeybindingItem[] {
+	public getDefaultKeybindings(): readonly ResolvedKeybindingItem[] {
 		return this._getResolver().getDefaultKeybindings();
 	}
 
-	public getKeybindings(): ResolvedKeybindingItem[] {
+	public getKeybindings(): readonly ResolvedKeybindingItem[] {
 		return this._getResolver().getKeybindings();
 	}
 
diff --git a/src/vs/platform/keybinding/common/keybinding.ts b/src/vs/platform/keybinding/common/keybinding.ts
@@ -87,9 +87,9 @@ export interface IKeybindingService {
 
 	getDefaultKeybindingsContent(): string;
 
-	getDefaultKeybindings(): ResolvedKeybindingItem[];
+	getDefaultKeybindings(): readonly ResolvedKeybindingItem[];
 
-	getKeybindings(): ResolvedKeybindingItem[];
+	getKeybindings(): readonly ResolvedKeybindingItem[];
 
 	customKeybindingsCount(): number;
 
diff --git a/src/vs/platform/keybinding/common/keybindingResolver.ts b/src/vs/platform/keybinding/common/keybindingResolver.ts
@@ -215,11 +215,11 @@ export class KeybindingResolver {
 		return this._defaultBoundCommands;
 	}
 
-	public getDefaultKeybindings(): ResolvedKeybindingItem[] {
+	public getDefaultKeybindings(): readonly ResolvedKeybindingItem[] {
 		return this._defaultKeybindings;
 	}
 
-	public getKeybindings(): ResolvedKeybindingItem[] {
+	public getKeybindings(): readonly ResolvedKeybindingItem[] {
 		return this._keybindings;
 	}
 
diff --git a/src/vs/workbench/services/keybinding/browser/keybindingService.ts b/src/vs/workbench/services/keybinding/browser/keybindingService.ts
@@ -517,7 +517,7 @@ export class WorkbenchKeybindingService extends AbstractKeybindingService {
 		);
 	}
 
-	private static _getDefaultKeybindings(defaultKeybindings: ResolvedKeybindingItem[]): string {
+	private static _getDefaultKeybindings(defaultKeybindings: readonly ResolvedKeybindingItem[]): string {
 		let out = new OutputBuilder();
 		out.writeLine('[');
 

Original file line number	Diff line number	Diff line change
`@@ -65,11 +65,11 @@ export abstract class AbstractKeybindingService extends Disposable implements IK`
`65`	`65`	`return '';`
`66`	`66`	`}`
`67`	`67`
`68`		`- public getDefaultKeybindings(): ResolvedKeybindingItem[] {`
	`68`	`+ public getDefaultKeybindings(): readonly ResolvedKeybindingItem[] {`
`69`	`69`	`return this._getResolver().getDefaultKeybindings();`
`70`	`70`	`}`
`71`	`71`
`72`		`- public getKeybindings(): ResolvedKeybindingItem[] {`
	`72`	`+ public getKeybindings(): readonly ResolvedKeybindingItem[] {`
`73`	`73`	`return this._getResolver().getKeybindings();`
`74`	`74`	`}`
`75`	`75`
Original file line number	Diff line number	Diff line change
`@@ -215,11 +215,11 @@ export class KeybindingResolver {`
`215`	`215`	`return this._defaultBoundCommands;`
`216`	`216`	`}`
`217`	`217`
`218`		`- public getDefaultKeybindings(): ResolvedKeybindingItem[] {`
	`218`	`+ public getDefaultKeybindings(): readonly ResolvedKeybindingItem[] {`
`219`	`219`	`return this._defaultKeybindings;`
`220`	`220`	`}`
`221`	`221`
`222`		`- public getKeybindings(): ResolvedKeybindingItem[] {`
	`222`	`+ public getKeybindings(): readonly ResolvedKeybindingItem[] {`
`223`	`223`	`return this._keybindings;`
`224`	`224`	`}`
`225`	`225`
Original file line number	Diff line number	Diff line change
`@@ -517,7 +517,7 @@ export class WorkbenchKeybindingService extends AbstractKeybindingService {`
`517`	`517`	`);`
`518`	`518`	`}`
`519`	`519`
`520`		`- private static _getDefaultKeybindings(defaultKeybindings: ResolvedKeybindingItem[]): string {`
	`520`	`+ private static _getDefaultKeybindings(defaultKeybindings: readonly ResolvedKeybindingItem[]): string {`
`521`	`521`	`let out = new OutputBuilder();`
`522`	`522`	`out.writeLine('[');`
`523`	`523`