Support CDPATH in terminal suggest

src/vs/workbench/contrib/terminalContrib/suggest/browser/terminalCompletionService.ts

@@ -12,6 +12,7 @@ import { URI } from '../../../../../base/common/uri.js';
 import { IConfigurationService } from '../../../../../platform/configuration/common/configuration.js';
 import { IFileService } from '../../../../../platform/files/common/files.js';
 import { createDecorator } from '../../../../../platform/instantiation/common/instantiation.js';
+import { TerminalCapability, type ITerminalCapabilityStore } from '../../../../../platform/terminal/common/capabilities/capabilities.js';
 import { GeneralShellType, TerminalShellType } from '../../../../../platform/terminal/common/terminal.js';
 import { ISimpleCompletion } from '../../../../services/suggest/browser/simpleCompletionItem.js';
 import { TerminalSuggestSettingId } from '../common/terminalSuggestConfiguration.js';
@@ -82,7 +83,7 @@ export interface ITerminalCompletionService {
 	_serviceBrand: undefined;
 	readonly providers: IterableIterator<ITerminalCompletionProvider>;
 	registerTerminalCompletionProvider(extensionIdentifier: string, id: string, provider: ITerminalCompletionProvider, ...triggerCharacters: string[]): IDisposable;
-	provideCompletions(promptValue: string, cursorPosition: number, shellType: TerminalShellType, token: CancellationToken, triggerCharacter?: boolean, skipExtensionCompletions?: boolean): Promise<ITerminalCompletion[] | undefined>;
+	provideCompletions(promptValue: string, cursorPosition: number, shellType: TerminalShellType, capabilities: ITerminalCapabilityStore, token: CancellationToken, triggerCharacter?: boolean, skipExtensionCompletions?: boolean): Promise<ITerminalCompletion[] | undefined>;
 }
 
 export class TerminalCompletionService extends Disposable implements ITerminalCompletionService {
@@ -101,7 +102,8 @@ export class TerminalCompletionService extends Disposable implements ITerminalCo
 		}
 	}
 
-	constructor(@IConfigurationService private readonly _configurationService: IConfigurationService,
+	constructor(
+		@IConfigurationService private readonly _configurationService: IConfigurationService,
 		@IFileService private readonly _fileService: IFileService
 	) {
 		super();
@@ -127,7 +129,7 @@ export class TerminalCompletionService extends Disposable implements ITerminalCo
 		});
 	}
 
-	async provideCompletions(promptValue: string, cursorPosition: number, shellType: TerminalShellType, token: CancellationToken, triggerCharacter?: boolean, skipExtensionCompletions?: boolean): Promise<ITerminalCompletion[] | undefined> {
+	async provideCompletions(promptValue: string, cursorPosition: number, shellType: TerminalShellType, capabilities: ITerminalCapabilityStore, token: CancellationToken, triggerCharacter?: boolean, skipExtensionCompletions?: boolean): Promise<ITerminalCompletion[] | undefined> {
 		if (!this._providers || !this._providers.values || cursorPosition < 0) {
 			return undefined;
 		}
@@ -153,7 +155,7 @@ export class TerminalCompletionService extends Disposable implements ITerminalCo
 
 		if (skipExtensionCompletions) {
 			providers = providers.filter(p => p.isBuiltin);
-			return this._collectCompletions(providers, shellType, promptValue, cursorPosition, token);
+			return this._collectCompletions(providers, shellType, promptValue, cursorPosition, capabilities, token);
 		}
 
 		const providerConfig: { [key: string]: boolean } = this._configurationService.getValue(TerminalSuggestSettingId.Providers);
@@ -166,10 +168,10 @@ export class TerminalCompletionService extends Disposable implements ITerminalCo
 			return;
 		}
 
-		return this._collectCompletions(providers, shellType, promptValue, cursorPosition, token);
+		return this._collectCompletions(providers, shellType, promptValue, cursorPosition, capabilities, token);
 	}
 
-	private async _collectCompletions(providers: ITerminalCompletionProvider[], shellType: TerminalShellType, promptValue: string, cursorPosition: number, token: CancellationToken): Promise<ITerminalCompletion[] | undefined> {
+	private async _collectCompletions(providers: ITerminalCompletionProvider[], shellType: TerminalShellType, promptValue: string, cursorPosition: number, capabilities: ITerminalCapabilityStore, token: CancellationToken): Promise<ITerminalCompletion[] | undefined> {
 		const completionPromises = providers.map(async provider => {
 			if (provider.shellTypes && !provider.shellTypes.includes(shellType)) {
 				return undefined;
@@ -193,7 +195,7 @@ export class TerminalCompletionService extends Disposable implements ITerminalCo
 				return completionItems;
 			}
 			if (completions.resourceRequestConfig) {
-				const resourceCompletions = await this.resolveResources(completions.resourceRequestConfig, promptValue, cursorPosition, provider.id);
+				const resourceCompletions = await this.resolveResources(completions.resourceRequestConfig, promptValue, cursorPosition, provider.id, capabilities);
 				if (resourceCompletions) {
 					completionItems.push(...resourceCompletions);
 				}
@@ -206,7 +208,7 @@ export class TerminalCompletionService extends Disposable implements ITerminalCo
 		return results.filter(result => !!result).flat();
 	}
 
-	async resolveResources(resourceRequestConfig: TerminalResourceRequestConfig, promptValue: string, cursorPosition: number, provider: string): Promise<ITerminalCompletion[] | undefined> {
+	async resolveResources(resourceRequestConfig: TerminalResourceRequestConfig, promptValue: string, cursorPosition: number, provider: string, capabilities: ITerminalCapabilityStore): Promise<ITerminalCompletion[] | undefined> {
 		if (resourceRequestConfig.shouldNormalizePrefix) {
 			// for tests, make sure the right path separator is used
 			promptValue = promptValue.replaceAll(/[\\/]/g, resourceRequestConfig.pathSeparator);
@@ -349,6 +351,42 @@ export class TerminalCompletionService extends Disposable implements ITerminalCo
 			}
 		}
 
+		// Support $CDPATH specially for the `cd` command only
+		if (promptValue.startsWith('cd ')) {
+			const config = this._configurationService.getValue(TerminalSuggestSettingId.CdPath);
+			if (config === 'absolute' || config === 'relative') {
+				const cdPath = capabilities.get(TerminalCapability.ShellEnvDetection)?.env?.get('CDPATH');
+				if (cdPath) {
+					const cdPathEntries = cdPath.split(useForwardSlash ? ';' : ':');
+					for (const cdPathEntry of cdPathEntries) {
+						try {
+							const fileStat = await this._fileService.resolve(URI.file(cdPathEntry), { resolveSingleChildDescendants: true });
+							if (fileStat?.children) {
+								for (const child of fileStat.children) {
+									if (!child.isDirectory) {
+										continue;
+									}
+									const useRelative = config === 'relative';
+									const label = useRelative ? basename(child.resource.fsPath) : getFriendlyPath(child.resource, resourceRequestConfig.pathSeparator);
+									const detail = useRelative ? `CDPATH ${getFriendlyPath(child.resource, resourceRequestConfig.pathSeparator)}` : `CDPATH`;
+									resourceCompletions.push({
+										label,
+										provider,
+										kind: TerminalCompletionItemKind.Folder,
+										isDirectory: child.isDirectory,
+										isFile: child.isFile,
+										detail,
+										replacementIndex: cursorPosition - lastWord.length,
+										replacementLength: lastWord.length
+									});
+								}
+							}
+						} catch { /* ignore */ }
+					}
+				}
+			}
+		}
+
 		// Add parent directory to the bottom of the list because it's not as useful as other suggestions
 		//
 		// For example:

src/vs/workbench/contrib/terminalContrib/suggest/browser/terminalSuggestAddon.ts

@@ -169,7 +169,7 @@ export class SuggestAddon extends Disposable implements ITerminalAddon, ISuggest
 		};
 		this._requestedCompletionsIndex = this._currentPromptInputState.cursorIndex;
 
-		const providedCompletions = await this._terminalCompletionService.provideCompletions(this._currentPromptInputState.prefix, this._currentPromptInputState.cursorIndex, this.shellType, token, doNotRequestExtensionCompletions);
+		const providedCompletions = await this._terminalCompletionService.provideCompletions(this._currentPromptInputState.prefix, this._currentPromptInputState.cursorIndex, this.shellType, this._capabilities, token, doNotRequestExtensionCompletions);
 
 		if (!providedCompletions?.length || token.isCancellationRequested) {
 			return;

src/vs/workbench/contrib/terminalContrib/suggest/common/terminalSuggestConfiguration.ts

@@ -17,6 +17,7 @@ export const enum TerminalSuggestSettingId {
 	WindowsExecutableExtensions = 'terminal.integrated.suggest.windowsExecutableExtensions',
 	Providers = 'terminal.integrated.suggest.providers',
 	ShowStatusBar = 'terminal.integrated.suggest.showStatusBar',
+	CdPath = 'terminal.integrated.suggest.cdPath',
 }
 
 export const windowsDefaultExecutableExtensions: string[] = [
@@ -134,6 +135,18 @@ export const terminalSuggestConfiguration: IStringDictionary<IConfigurationPrope
 		default: true,
 		tags: ['experimental'],
 	},
+	[TerminalSuggestSettingId.CdPath]: {
+		restricted: true,
+		markdownDescription: localize('suggest.cdPath', "Controls whether to enable $CDPATH support which exposes children of the folders in the $CDPATH variable regardless of the current working directory. $CDPATH is expected to be semi colon-separated on Windows and colon-separated on other platforms."),
+		enum: ['off', 'relative', 'absolute'],
+		markdownEnumDescriptions: [
+			localize('suggest.cdPath.off', "Disable the feature."),
+			localize('suggest.cdPath.relative', "Enable the feature and use relative paths."),
+			localize('suggest.cdPath.absolute', "Enable the feature and use absolute paths. This is useful when the shell doesn't natively support `$CDPATH`."),
+		],
+		default: 'absolute',
+		tags: ['experimental'],
+	},
 };