Mark quick input button and classlist arrays as readonly (microsoft#163891)

Author: mjbvz

src/vs/base/browser/ui/highlightedlabel/highlightedLabel.ts

@@ -33,7 +33,7 @@ export class HighlightedLabel {
 	private readonly domNode: HTMLElement;
 	private text: string = '';
 	private title: string = '';
-	private highlights: IHighlight[] = [];
+	private highlights: readonly IHighlight[] = [];
 	private supportIcons: boolean;
 	private didEverRender: boolean = false;
 
@@ -63,7 +63,7 @@ export class HighlightedLabel {
 	 * @param escapeNewLines Whether to escape new lines.
 	 * @returns
 	 */
-	set(text: string | undefined, highlights: IHighlight[] = [], title: string = '', escapeNewLines?: boolean) {
+	set(text: string | undefined, highlights: readonly IHighlight[] = [], title: string = '', escapeNewLines?: boolean) {
 		if (!text) {
 			text = '';
 		}
@@ -126,7 +126,7 @@ export class HighlightedLabel {
 		this.didEverRender = true;
 	}
 
-	static escapeNewLines(text: string, highlights: IHighlight[]): string {
+	static escapeNewLines(text: string, highlights: readonly IHighlight[]): string {
 		let total = 0;
 		let extra = 0;
 

src/vs/base/browser/ui/iconLabel/iconLabel.ts

@@ -14,22 +14,22 @@ import { equals } from 'vs/base/common/objects';
 import { Range } from 'vs/base/common/range';
 
 export interface IIconLabelCreationOptions {
-	supportHighlights?: boolean;
-	supportDescriptionHighlights?: boolean;
-	supportIcons?: boolean;
-	hoverDelegate?: IHoverDelegate;
+	readonly supportHighlights?: boolean;
+	readonly supportDescriptionHighlights?: boolean;
+	readonly supportIcons?: boolean;
+	readonly hoverDelegate?: IHoverDelegate;
 }
 
 export interface IIconLabelValueOptions {
 	title?: string | ITooltipMarkdownString;
 	descriptionTitle?: string;
 	hideIcon?: boolean;
-	extraClasses?: string[];
+	extraClasses?: readonly string[];
 	italic?: boolean;
 	strikethrough?: boolean;
-	matches?: IMatch[];
+	matches?: readonly IMatch[];
 	labelEscapeNewLines?: boolean;
-	descriptionMatches?: IMatch[];
+	descriptionMatches?: readonly IMatch[];
 	disabledCommand?: boolean;
 	readonly separator?: string;
 	readonly domId?: string;
@@ -241,7 +241,7 @@ class Label {
 	}
 }
 
-function splitMatches(labels: string[], separator: string, matches: IMatch[] | undefined): IMatch[][] | undefined {
+function splitMatches(labels: string[], separator: string, matches: readonly IMatch[] | undefined): IMatch[][] | undefined {
 	if (!matches) {
 		return undefined;
 	}

src/vs/base/parts/quickinput/common/quickInput.ts

@@ -34,11 +34,11 @@ export interface IQuickPickItem {
 	 * keyboard shortcut.
 	 */
 	keybinding?: ResolvedKeybinding;
-	iconClasses?: string[];
+	iconClasses?: readonly string[];
 	italic?: boolean;
 	strikethrough?: boolean;
 	highlights?: IQuickPickItemHighlights;
-	buttons?: IQuickInputButton[];
+	buttons?: readonly IQuickInputButton[];
 	picked?: boolean;
 	alwaysShow?: boolean;
 }
@@ -48,7 +48,7 @@ export interface IQuickPickSeparator {
 	id?: string;
 	label?: string;
 	ariaLabel?: string;
-	buttons?: IQuickInputButton[];
+	buttons?: readonly IQuickInputButton[];
 }
 
 export interface IKeyMods {
@@ -59,7 +59,7 @@ export interface IKeyMods {
 export const NO_KEY_MODS: IKeyMods = { ctrlCmd: false, alt: false };
 
 export interface IQuickNavigateConfiguration {
-	keybindings: ResolvedKeybinding[];
+	keybindings: readonly ResolvedKeybinding[];
 }
 
 export interface IPickOptions<T extends IQuickPickItem> {

src/vs/platform/quickinput/browser/quickPickPin.ts

@@ -77,13 +77,15 @@ function updateButtons(item: QuickPickItem, removePin: boolean): void {
 	if (item.type === 'separator') {
 		return;
 	}
+
 	// remove button classes before adding the new one
-	item.buttons = item.buttons ? item.buttons?.filter(button => button.iconClass && !buttonClasses.includes(button.iconClass)) : [];
-	item.buttons.unshift({
+	const newButtons = item.buttons?.filter(button => button.iconClass && !buttonClasses.includes(button.iconClass)) ?? [];
+	newButtons.unshift({
 		iconClass: removePin ? pinButtonClass : pinnedButtonClass,
 		tooltip: removePin ? localize('pinCommand', "Pin command") : localize('pinnedCommand', "Pinned command"),
 		alwaysVisible: false
 	});
+	item.buttons = newButtons;
 }
 
 function itemsMatch(itemA: QuickPickItem, itemB: QuickPickItem): boolean {

src/vs/workbench/contrib/codeEditor/browser/outline/documentSymbolsTree.ts

@@ -133,10 +133,11 @@ export class DocumentSymbolRenderer implements ITreeRenderer<OutlineElement, Fuz
 
 	renderElement(node: ITreeNode<OutlineElement, FuzzyScore>, _index: number, template: DocumentSymbolTemplate): void {
 		const { element } = node;
+		const extraClasses = ['nowrap'];
 		const options: IIconLabelValueOptions = {
 			matches: createMatches(node.filterData),
 			labelEscapeNewLines: true,
-			extraClasses: ['nowrap'],
+			extraClasses,
 			title: localize('title.template', "{0} ({1})", element.symbol.name, DocumentSymbolRenderer._symbolKindNames[element.symbol.kind])
 		};
 		if (this._configurationService.getValue(OutlineConfigKeys.icons)) {
@@ -145,7 +146,7 @@ export class DocumentSymbolRenderer implements ITreeRenderer<OutlineElement, Fuz
 			template.iconClass.classList.add('outline-element-icon', 'inline', ...CSSIcon.asClassNameArray(SymbolKinds.toIcon(element.symbol.kind)));
 		}
 		if (element.symbol.tags.indexOf(SymbolTag.Deprecated) >= 0) {
-			options.extraClasses!.push(`deprecated`);
+			extraClasses.push(`deprecated`);
 			options.matches = [];
 		}
 		template.iconLabel.setLabel(element.symbol.name, element.symbol.detail, options);

src/vs/workbench/contrib/notebook/browser/contrib/outline/notebookOutline.ts

@@ -168,15 +168,16 @@ class NotebookOutlineRenderer implements ITreeRenderer<OutlineEntry, FuzzyScore,
 	}
 
 	renderElement(node: ITreeNode<OutlineEntry, FuzzyScore>, _index: number, template: NotebookOutlineTemplate, _height: number | undefined): void {
+		const extraClasses: string[] = [];
 		const options: IIconLabelValueOptions = {
 			matches: createMatches(node.filterData),
 			labelEscapeNewLines: true,
-			extraClasses: []
+			extraClasses,
 		};
 
 		if (node.element.cell.cellKind === CellKind.Code && this._themeService.getFileIconTheme().hasFileIcons && !node.element.isExecuting) {
 			template.iconClass.className = '';
-			options.extraClasses?.push(...getIconClassesForLanguageId(node.element.cell.language ?? ''));
+			extraClasses.push(...getIconClassesForLanguageId(node.element.cell.language ?? ''));
 		} else {
 			template.iconClass.className = 'element-icon ' + ThemeIcon.asClassNameArray(node.element.icon).join(' ');
 		}

src/vs/workbench/contrib/tasks/browser/taskQuickPick.ts

@@ -99,11 +99,12 @@ export class TaskQuickPick extends Disposable {
 		}
 	}
 
-	private _createTaskEntry(task: Task | ConfiguringTask, extraButtons: IQuickInputButton[] = []): ITaskTwoLevelQuickPickEntry {
+	private _createTaskEntry(task: Task | ConfiguringTask, extraButtons: readonly IQuickInputButton[] = []): ITaskTwoLevelQuickPickEntry {
 		const entry: ITaskTwoLevelQuickPickEntry = { label: TaskQuickPick.getTaskLabelWithIcon(task, this._guessTaskLabel(task)), description: this._taskService.getTaskDescription(task), task, detail: this._showDetail() ? task.configurationProperties.detail : undefined };
-		entry.buttons = [];
-		entry.buttons.push({ iconClass: ThemeIcon.asClassName(configureTaskIcon), tooltip: nls.localize('configureTask', "Configure Task") });
-		entry.buttons.push(...extraButtons);
+		entry.buttons = [
+			{ iconClass: ThemeIcon.asClassName(configureTaskIcon), tooltip: nls.localize('configureTask', "Configure Task") },
+			...extraButtons,
+		];
 		TaskQuickPick.applyColorStyles(task, entry, this._themeService);
 		return entry;
 	}