Merge pull request microsoft#154539 from microsoft/tyriar/153109

Run recent command: Collapse $HOME into ~

Author: Tyriar

src/vs/platform/terminal/common/terminalEnvironment.ts

@@ -12,3 +12,26 @@ export function escapeNonWindowsPath(path: string): string {
 	newPath = newPath.replace(bannedChars, '');
 	return `'${newPath}'`;
 }
+
+/**
+ * Collapses the user's home directory into `~` if it exists within the path, this gives a shorter
+ * path that is more suitable within the context of a terminal.
+ */
+export function collapseTildePath(path: string | undefined, userHome: string | undefined, separator: string): string {
+	if (!path) {
+		return '';
+	}
+	if (!userHome) {
+		return path;
+	}
+	// Trim the trailing separator from the end if it exists
+	if (userHome.match(/[\/\\]$/)) {
+		userHome = userHome.slice(0, userHome.length - 1);
+	}
+	const normalizedPath = path.replace(/\\/g, '/').toLowerCase();
+	const normalizedUserHome = userHome.replace(/\\/g, '/').toLowerCase();
+	if (!normalizedPath.includes(normalizedUserHome)) {
+		return path;
+	}
+	return `~${separator}${path.slice(userHome.length + 1)}`;
+}

src/vs/platform/terminal/test/common/terminalEnvironment.test.ts

@@ -0,0 +1,40 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { strictEqual } from 'assert';
+import { collapseTildePath } from 'vs/platform/terminal/common/terminalEnvironment';
+
+suite('terminalEnvironment', () => {
+	suite('collapseTildePath', () => {
+		test('should return empty string for a falsy path', () => {
+			strictEqual(collapseTildePath('', '/foo', '/'), '');
+			strictEqual(collapseTildePath(undefined, '/foo', '/'), '');
+		});
+		test('should return path for a falsy user home', () => {
+			strictEqual(collapseTildePath('/foo', '', '/'), '/foo');
+			strictEqual(collapseTildePath('/foo', undefined, '/'), '/foo');
+		});
+		test('should not collapse when user home isn\'t present', () => {
+			strictEqual(collapseTildePath('/foo', '/bar', '/'), '/foo');
+			strictEqual(collapseTildePath('C:\\foo', 'C:\\bar', '\\'), 'C:\\foo');
+		});
+		test('should collapse with Windows separators', () => {
+			strictEqual(collapseTildePath('C:\\foo\\bar', 'C:\\foo', '\\'), '~\\bar');
+			strictEqual(collapseTildePath('C:\\foo\\bar', 'C:\\foo\\', '\\'), '~\\bar');
+			strictEqual(collapseTildePath('C:\\foo\\bar\\baz', 'C:\\foo\\', '\\'), '~\\bar\\baz');
+			strictEqual(collapseTildePath('C:\\foo\\bar\\baz', 'C:\\foo', '\\'), '~\\bar\\baz');
+		});
+		test('should collapse mixed case with Windows separators', () => {
+			strictEqual(collapseTildePath('c:\\foo\\bar', 'C:\\foo', '\\'), '~\\bar');
+			strictEqual(collapseTildePath('C:\\foo\\bar\\baz', 'c:\\foo', '\\'), '~\\bar\\baz');
+		});
+		test('should collapse with Posix separators', () => {
+			strictEqual(collapseTildePath('/foo/bar', '/foo', '/'), '~/bar');
+			strictEqual(collapseTildePath('/foo/bar', '/foo/', '/'), '~/bar');
+			strictEqual(collapseTildePath('/foo/bar/baz', '/foo', '/'), '~/bar/baz');
+			strictEqual(collapseTildePath('/foo/bar/baz', '/foo/', '/'), '~/bar/baz');
+		});
+	});
+});

src/vs/workbench/contrib/terminal/browser/terminalInstance.ts

@@ -47,7 +47,7 @@ import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
 import { ITerminalCommand, TerminalCapability } from 'vs/platform/terminal/common/capabilities/capabilities';
 import { TerminalCapabilityStoreMultiplexer } from 'vs/platform/terminal/common/capabilities/terminalCapabilityStore';
 import { IProcessDataEvent, IProcessPropertyMap, IShellLaunchConfig, ITerminalDimensionsOverride, ITerminalLaunchError, PosixShellType, ProcessPropertyType, TerminalIcon, TerminalLocation, TerminalSettingId, TerminalShellType, TitleEventSource, WindowsShellType } from 'vs/platform/terminal/common/terminal';
-import { escapeNonWindowsPath } from 'vs/platform/terminal/common/terminalEnvironment';
+import { escapeNonWindowsPath, collapseTildePath } from 'vs/platform/terminal/common/terminalEnvironment';
 import { activeContrastBorder, scrollbarSliderActiveBackground, scrollbarSliderBackground, scrollbarSliderHoverBackground } from 'vs/platform/theme/common/colorRegistry';
 import { IColorTheme, ICssStyleCollector, IThemeService, registerThemingParticipant, ThemeIcon } from 'vs/platform/theme/common/themeService';
 import { IWorkspaceContextService, IWorkspaceFolder } from 'vs/platform/workspace/common/workspace';
@@ -852,7 +852,7 @@ export class TerminalInstance extends Disposable implements ITerminalInstance {
 					if (label.length === 0 || commandMap.has(label)) {
 						continue;
 					}
-					let description = `${entry.cwd}`;
+					let description = collapseTildePath(entry.cwd, this._userHome, this._processManager?.os === OperatingSystem.Windows ? '\\' : '/');
 					if (entry.exitCode) {
 						// Since you cannot get the last command's exit code on pwsh, just whether it failed
 						// or not, -1 is treated specially as simply failed