Move getCodiconAriaLabel to iconLabels

src/vs/base/common/codicons.ts

@@ -2,20 +2,9 @@
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-
 import { ThemeIcon } from 'vs/base/common/themables';
 import { isString } from 'vs/base/common/types';
 
-// Selects all codicon names encapsulated in the `$()` syntax and wraps the
-// results with spaces so that screen readers can read the text better.
-export function getCodiconAriaLabel(text: string | undefined) {
-	if (!text) {
-		return '';
-	}
-
-	return text.replace(/\$\((.*?)\)/g, (_match, codiconName) => ` ${codiconName} `).trim();
-}
-
 const _codiconFontCharacters: { [id: string]: number } = Object.create(null);
 
 function register(id: string, fontCharacter: number | string): ThemeIcon {

src/vs/base/common/iconLabels.ts

@@ -23,6 +23,10 @@ export function markdownEscapeEscapedIcons(text: string): string {
 }
 
 const stripIconsRegex = new RegExp(`(\\s)?(\\\\)?${iconsRegex.source}(\\s)?`, 'g');
+
+/**
+ * Takes a label with icons (`$(iconId)xyz`)  and strips the icons out (`xyz`)
+ */
 export function stripIcons(text: string): string {
 	if (text.indexOf(iconStartMarker) === -1) {
 		return text;
@@ -32,13 +36,28 @@ export function stripIcons(text: string): string {
 }
 
 
+/**
+ * Takes a label with icons (`$(iconId)xyz`), removes the icon syntax adds whitespace so that screen readers can read the text better.
+ */
+export function getCodiconAriaLabel(text: string | undefined) {
+	if (!text) {
+		return '';
+	}
+
+	return text.replace(/\$\((.*?)\)/g, (_match, codiconName) => ` ${codiconName} `).trim();
+}
+
+
 export interface IParsedLabelWithIcons {
 	readonly text: string;
 	readonly iconOffsets?: readonly number[];
 }
 
 const _parseIconsRegex = new RegExp(`\\$\\(${ThemeIcon.iconNameCharacter}+\\)`, 'g');
 
+/**
+ * Takes a label with icons (`abc $(iconId)xyz`) and returns the text (`abc xyz`) and the offsets of the icons (`[3]`)
+ */
 export function parseLabelWithIcons(input: string): IParsedLabelWithIcons {
 
 	_parseIconsRegex.lastIndex = 0;

src/vs/base/parts/quickinput/browser/quickInputList.ts

@@ -13,12 +13,11 @@ import { IListRenderer, IListVirtualDelegate } from 'vs/base/browser/ui/list/lis
 import { IListAccessibilityProvider, IListOptions, IListStyles, List } from 'vs/base/browser/ui/list/listWidget';
 import { IAction } from 'vs/base/common/actions';
 import { range } from 'vs/base/common/arrays';
-import { getCodiconAriaLabel } from 'vs/base/common/codicons';
 import { compareAnything } from 'vs/base/common/comparers';
 import { memoize } from 'vs/base/common/decorators';
 import { Emitter, Event } from 'vs/base/common/event';
 import { IMatch } from 'vs/base/common/filters';
-import { IParsedLabelWithIcons, matchesFuzzyIconAware, parseLabelWithIcons } from 'vs/base/common/iconLabels';
+import { getCodiconAriaLabel, IParsedLabelWithIcons, matchesFuzzyIconAware, parseLabelWithIcons } from 'vs/base/common/iconLabels';
 import { KeyCode } from 'vs/base/common/keyCodes';
 import { dispose, IDisposable } from 'vs/base/common/lifecycle';
 import * as platform from 'vs/base/common/platform';

src/vs/base/test/common/iconLabels.test.ts

@@ -5,7 +5,7 @@
 
 import * as assert from 'assert';
 import { IMatch } from 'vs/base/common/filters';
-import { escapeIcons, IParsedLabelWithIcons, markdownEscapeEscapedIcons, matchesFuzzyIconAware, parseLabelWithIcons, stripIcons } from 'vs/base/common/iconLabels';
+import { escapeIcons, getCodiconAriaLabel, IParsedLabelWithIcons, markdownEscapeEscapedIcons, matchesFuzzyIconAware, parseLabelWithIcons, stripIcons } from 'vs/base/common/iconLabels';
 
 interface IIconFilter {
 	// Returns null if word doesn't match.
@@ -21,6 +21,26 @@ function filterOk(filter: IIconFilter, word: string, target: IParsedLabelWithIco
 }
 
 suite('Icon Labels', () => {
+
+	test('Can get proper aria labels', () => {
+		// note, the spaces in the results are important
+		const testCases = new Map<string, string>([
+			['', ''],
+			['asdf', 'asdf'],
+			['asdf$(squirrel)asdf', 'asdf squirrel asdf'],
+			['asdf $(squirrel) asdf', 'asdf  squirrel  asdf'],
+			['$(rocket)asdf', 'rocket asdf'],
+			['$(rocket) asdf', 'rocket  asdf'],
+			['$(rocket)$(rocket)$(rocket)asdf', 'rocket  rocket  rocket asdf'],
+			['$(rocket) asdf $(rocket)', 'rocket  asdf  rocket'],
+			['$(rocket)asdf$(rocket)', 'rocket asdf rocket'],
+		]);
+
+		for (const [input, expected] of testCases) {
+			assert.strictEqual(getCodiconAriaLabel(input), expected);
+		}
+	});
+
 	test('matchesFuzzyIconAware', () => {
 
 		// Camel Case

src/vs/workbench/api/browser/mainThreadStatusBar.ts

@@ -10,8 +10,8 @@ import { extHostNamedCustomer, IExtHostContext } from 'vs/workbench/services/ext
 import { dispose } from 'vs/base/common/lifecycle';
 import { Command } from 'vs/editor/common/languages';
 import { IAccessibilityInformation } from 'vs/platform/accessibility/common/accessibility';
-import { getCodiconAriaLabel } from 'vs/base/common/codicons';
 import { IMarkdownString } from 'vs/base/common/htmlContent';
+import { getCodiconAriaLabel } from 'vs/base/common/iconLabels';
 
 @extHostNamedCustomer(MainContext.MainThreadStatusBar)
 export class MainThreadStatusBar implements MainThreadStatusBarShape {

src/vs/workbench/contrib/remote/browser/remoteIndicator.ts

@@ -27,7 +27,7 @@ import { truncate } from 'vs/base/common/strings';
 import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace';
 import { getRemoteName } from 'vs/platform/remote/common/remoteHosts';
 import { getVirtualWorkspaceLocation } from 'vs/platform/workspace/common/virtualWorkspace';
-import { getCodiconAriaLabel } from 'vs/base/common/codicons';
+import { getCodiconAriaLabel } from 'vs/base/common/iconLabels';
 import { ILogService } from 'vs/platform/log/common/log';
 import { ReloadWindowAction } from 'vs/workbench/browser/actions/windowActions';
 import { IExtensionGalleryService } from 'vs/platform/extensionManagement/common/extensionManagement';