Merge pull request #119784 from microsoft/tyriar/profile_schema

Add schema to profiles settings

src/vs/workbench/contrib/terminal/common/terminalConfiguration.ts

@@ -8,6 +8,28 @@ import { localize } from 'vs/nls';
 import { EDITOR_FONT_DEFAULTS } from 'vs/editor/common/config/editorOptions';
 import { DEFAULT_LETTER_SPACING, DEFAULT_LINE_HEIGHT, TerminalCursorStyle, DEFAULT_COMMANDS_TO_SKIP_SHELL, SUGGESTIONS_FONT_WEIGHT, MINIMUM_FONT_WEIGHT, MAXIMUM_FONT_WEIGHT, DEFAULT_LOCAL_ECHO_EXCLUDE } from 'vs/workbench/contrib/terminal/common/terminal';
 import { isMacintosh, isWindows, Platform } from 'vs/base/common/platform';
+import { IJSONSchema } from 'vs/base/common/jsonSchema';
+
+const terminalProfileSchema: IJSONSchema = {
+	type: 'object',
+	required: ['path'],
+	properties: {
+		path: {
+			description: localize('terminalProfile.path', 'A single path to a shell executable or an array of paths that will be used as fallbacks when one fails.'),
+			type: ['string', 'array'],
+			items: {
+				type: 'string'
+			}
+		},
+		args: {
+			description: localize('terminalProfile.args', 'An optional set of arguments to run the shell executable with.'),
+			type: 'array',
+			items: {
+				type: 'string'
+			}
+		}
+	}
+};
 
 export const terminalConfiguration: IConfigurationNode = {
 	id: 'terminal',
@@ -104,6 +126,21 @@ export const terminalConfiguration: IConfigurationNode = {
 					source: 'Git Bash'
 				}
 			},
+			additionalProperties: {
+				'anyOf': [
+					{
+						type: 'object',
+						required: ['source'],
+						properties: {
+							source: {
+								description: localize('terminalProfile.windowsSource', 'A profile source that will auto detect the paths to the shell.'),
+								enum: ['PowerShell', 'Git Bash']
+							}
+						}
+					},
+					terminalProfileSchema
+				]
+			}
 		},
 		'terminal.integrated.profiles.osx': {
 			markdownDescription: localize(
@@ -128,6 +165,7 @@ export const terminalConfiguration: IConfigurationNode = {
 					path: 'tmux'
 				}
 			},
+			additionalProperties: terminalProfileSchema
 		},
 		'terminal.integrated.profiles.linux': {
 			markdownDescription: localize(
@@ -151,7 +189,8 @@ export const terminalConfiguration: IConfigurationNode = {
 				'tmux': {
 					path: 'tmux'
 				}
-			}
+			},
+			additionalProperties: terminalProfileSchema
 		},
 		'terminal.integrated.showQuickLaunchWslProfiles': {
 			description: localize('terminal.integrated.showQuickLaunchWslProfiles', 'Controls whether or not WSL distros are shown in the quick launch dropdown'),

src/vs/workbench/contrib/terminal/node/terminalProfiles.ts

@@ -57,10 +57,7 @@ async function detectAvailableWindowsProfiles(quickLaunchOnly: boolean, statProv
 		);
 	}
 
-	for (const [profileName, value] of Object.entries(configProfiles || {})) {
-		if (value === null) { detectedProfiles.delete(profileName); }
-		detectedProfiles.set(profileName, value);
-	}
+	applyConfigProfilesToMap(configProfiles, detectedProfiles);
 
 	const resultProfiles: ITerminalProfile[] = await transformToTerminalProfiles(detectedProfiles.entries(), statProvider, logService, variableResolver, workspaceFolder);
 
@@ -200,17 +197,24 @@ async function detectAvailableUnixProfiles(statProvider: IStatProvider, logServi
 		}
 	}
 
-	for (const [profileName, value] of Object.entries(configProfiles || {})) {
-		if (value === null) {
-			detectedProfiles.delete(profileName);
-		} else {
-			detectedProfiles.set(profileName, value);
-		}
-	}
+	applyConfigProfilesToMap(configProfiles, detectedProfiles);
 
 	return await transformToTerminalProfiles(detectedProfiles.entries(), statProvider, logService, variableResolver, workspaceFolder);
 }
 
+function applyConfigProfilesToMap(configProfiles: { [key: string]: ITerminalProfileObject } | undefined, profilesMap: Map<string, ITerminalProfileObject>) {
+	if (!configProfiles) {
+		return;
+	}
+	for (const [profileName, value] of Object.entries(configProfiles)) {
+		if (value === null) {
+			profilesMap.delete(profileName);
+		} else {
+			profilesMap.set(profileName, value);
+		}
+	}
+}
+
 async function validateProfilePaths(label: string, potentialPaths: string[], statProvider: IStatProvider, args?: string[] | string, logService?: ILogService): Promise<ITerminalProfile | undefined> {
 	if (potentialPaths.length === 0) {
 		return Promise.resolve(undefined);