Merge pull request #199183 from microsoft/merogge/ext-contributed

meganrogge · web-flow · commit c6eb717f7577 · 2023-11-27T11:11:57.000-06:00
allow user defined profile to override extension one, remove unused function
diff --git a/src/vs/platform/terminal/common/terminalPlatformConfiguration.ts b/src/vs/platform/terminal/common/terminalPlatformConfiguration.ts
@@ -42,7 +42,7 @@ const terminalProfileBaseProperties: IJSONSchemaMap = {
 		}
 	},
 	overrideName: {
-		description: localize('terminalProfile.overrideName', 'Controls whether or not the profile name overrides the auto detected one.'),
+		description: localize('terminalProfile.overrideName', 'Whether or not to replace the dynamic terminal title that detects what program is running with the static profile name.'),
 		type: 'boolean'
 	},
 	icon: {
diff --git a/src/vs/workbench/contrib/terminal/browser/terminalProfileResolverService.ts b/src/vs/workbench/contrib/terminal/browser/terminalProfileResolverService.ts
@@ -19,9 +19,8 @@ import { IRemoteAgentService } from 'vs/workbench/services/remote/common/remoteA
 import { debounce } from 'vs/base/common/decorators';
 import { ThemeIcon } from 'vs/base/common/themables';
 import { URI } from 'vs/base/common/uri';
-import { equals } from 'vs/base/common/arrays';
 import { deepClone } from 'vs/base/common/objects';
-import { terminalProfileArgsMatch, isUriComponents } from 'vs/platform/terminal/common/terminalProfiles';
+import { isUriComponents } from 'vs/platform/terminal/common/terminalProfiles';
 import { ITerminalInstanceService } from 'vs/workbench/contrib/terminal/browser/terminal';
 
 export interface IProfileContextProvider {
@@ -345,48 +344,6 @@ export abstract class BaseTerminalProfileResolverService implements ITerminalPro
 		}
 	}
 
-	private _isValidShellArgs(shellArgs: unknown, os: OperatingSystem): shellArgs is string | string[] | undefined {
-		if (shellArgs === undefined) {
-			return true;
-		}
-		if (os === OperatingSystem.Windows && typeof shellArgs === 'string') {
-			return true;
-		}
-		if (Array.isArray(shellArgs) && shellArgs.every(e => typeof e === 'string')) {
-			return true;
-		}
-		return false;
-	}
-
-	async createProfileFromShellAndShellArgs(shell?: unknown, shellArgs?: unknown): Promise<ITerminalProfile | string> {
-		const detectedProfile = this._terminalProfileService.availableProfiles?.find(p => {
-			if (p.path !== shell) {
-				return false;
-			}
-			if (p.args === undefined || typeof p.args === 'string') {
-				return p.args === shellArgs;
-			}
-			return p.path === shell && equals(p.args, (shellArgs || []) as string[]);
-		});
-		const fallbackProfile = (await this.getDefaultProfile({
-			remoteAuthority: this._remoteAgentService.getConnection()?.remoteAuthority,
-			os: this._primaryBackendOs!
-		}));
-		fallbackProfile.profileName = `${fallbackProfile.path} (migrated)`;
-		const profile = detectedProfile || fallbackProfile;
-		const args = this._isValidShellArgs(shellArgs, this._primaryBackendOs!) ? shellArgs : profile.args;
-		const createdProfile = {
-			profileName: profile.profileName,
-			path: profile.path,
-			args,
-			isDefault: true
-		};
-		if (detectedProfile && detectedProfile.profileName === createdProfile.profileName && detectedProfile.path === createdProfile.path && terminalProfileArgsMatch(detectedProfile.args, createdProfile.args)) {
-			return detectedProfile.profileName;
-		}
-		return createdProfile;
-	}
-
 	private _isValidAutomationProfile(profile: unknown, os: OperatingSystem): profile is ITerminalProfile {
 		if (profile === null || profile === undefined || typeof profile !== 'object') {
 			return false;
diff --git a/src/vs/workbench/contrib/terminal/browser/terminalProfileService.ts b/src/vs/workbench/contrib/terminal/browser/terminalProfileService.ts
@@ -52,7 +52,9 @@ export class TerminalProfileService extends Disposable implements ITerminalProfi
 		return this._availableProfiles || [];
 	}
 	get contributedProfiles(): IExtensionTerminalProfile[] {
-		return this._contributedProfiles || [];
+		const userConfiguredProfileNames = this._availableProfiles?.map(p => p.profileName) || [];
+		// Allow a user defined profile to override an extension contributed profile with the same name
+		return this._contributedProfiles?.filter(p => !userConfiguredProfileNames.includes(p.title)) || [];
 	}
 
 	constructor(
diff --git a/src/vs/workbench/contrib/terminal/common/terminal.ts b/src/vs/workbench/contrib/terminal/common/terminal.ts
@@ -51,7 +51,6 @@ export interface ITerminalProfileResolverService {
 	getDefaultShellArgs(options: IShellLaunchConfigResolveOptions): Promise<string | string[]>;
 	getDefaultIcon(): TerminalIcon & ThemeIcon;
 	getEnvironment(remoteAuthority: string | undefined): Promise<IProcessEnvironment>;
-	createProfileFromShellAndShellArgs(shell?: unknown, shellArgs?: unknown): Promise<ITerminalProfile | string>;
 }
 
 /*

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ const terminalProfileBaseProperties: IJSONSchemaMap = {`
`42`	`42`	`}`
`43`	`43`	`},`
`44`	`44`	`overrideName: {`
`45`		`- description: localize('terminalProfile.overrideName', 'Controls whether or not the profile name overrides the auto detected one.'),`
	`45`	`+ description: localize('terminalProfile.overrideName', 'Whether or not to replace the dynamic terminal title that detects what program is running with the static profile name.'),`
`46`	`46`	`type: 'boolean'`
`47`	`47`	`},`
`48`	`48`	`icon: {`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,9 @@ export class TerminalProfileService extends Disposable implements ITerminalProfi`
`52`	`52`	`return this._availableProfiles \|\| [];`
`53`	`53`	`}`
`54`	`54`	`get contributedProfiles(): IExtensionTerminalProfile[] {`
`55`		`- return this._contributedProfiles \|\| [];`
	`55`	`+ const userConfiguredProfileNames = this._availableProfiles?.map(p => p.profileName) \|\| [];`
	`56`	`+ // Allow a user defined profile to override an extension contributed profile with the same name`
	`57`	`+ return this._contributedProfiles?.filter(p => !userConfiguredProfileNames.includes(p.title)) \|\| [];`
`56`	`58`	`}`
`57`	`59`
`58`	`60`	`constructor(`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,6 @@ export interface ITerminalProfileResolverService {`
`51`	`51`	`getDefaultShellArgs(options: IShellLaunchConfigResolveOptions): Promise<string \| string[]>;`
`52`	`52`	`getDefaultIcon(): TerminalIcon & ThemeIcon;`
`53`	`53`	`getEnvironment(remoteAuthority: string \| undefined): Promise<IProcessEnvironment>;`
`54`		`- createProfileFromShellAndShellArgs(shell?: unknown, shellArgs?: unknown): Promise<ITerminalProfile \| string>;`
`55`	`54`	`}`
`56`	`55`
`57`	`56`	`/*`