allow setting icon/color for tasks (microsoft#151949)

Author: meganrogge

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

@@ -318,6 +318,8 @@ namespace TaskDTO {
 			isBackground: task.configurationProperties.isBackground,
 			problemMatchers: [],
 			hasDefinedMatchers: ContributedTask.is(task) ? task.hasDefinedMatchers : false,
+			icon: task.configurationProperties.icon,
+			color: task.configurationProperties.color,
 			runOptions: RunOptionsDTO.from(task.runOptions),
 		};
 		result.group = TaskGroupDTO.from(task.configurationProperties.group);
@@ -382,7 +384,9 @@ namespace TaskDTO {
 				group: task.group,
 				isBackground: !!task.isBackground,
 				problemMatchers: task.problemMatchers.slice(),
-				detail: task.detail
+				detail: task.detail,
+				color: task.color,
+				icon: task.icon
 			}
 		);
 		return result;

src/vs/workbench/api/common/shared/tasks.ts

@@ -76,6 +76,8 @@ export interface ITaskSourceDTO {
 	label: string;
 	extensionId?: string;
 	scope?: number | UriComponents;
+	color?: string;
+	icon?: string;
 }
 
 export interface ITaskHandleDTO {
@@ -101,6 +103,8 @@ export interface ITaskDTO {
 	problemMatchers: string[];
 	hasDefinedMatchers: boolean;
 	runOptions?: IRunOptionsDTO;
+	color?: string;
+	icon?: string;
 }
 
 export interface ITaskSetDTO {

src/vs/workbench/contrib/tasks/browser/terminalTaskSystem.ts

@@ -50,6 +50,7 @@ import { TaskTerminalStatus } from 'vs/workbench/contrib/tasks/browser/taskTermi
 import { ITaskService } from 'vs/workbench/contrib/tasks/common/taskService';
 import { IPaneCompositePartService } from 'vs/workbench/services/panecomposite/browser/panecomposite';
 import { INotificationService } from 'vs/platform/notification/common/notification';
+import { ThemeIcon } from 'vs/platform/theme/common/themeService';
 
 interface ITerminalData {
 	terminal: ITerminalInstance;
@@ -1032,9 +1033,9 @@ export class TerminalTaskSystem extends Disposable implements ITaskSystem {
 				type,
 				executable: defaultProfile.path,
 				args: defaultProfile.args,
-				icon: defaultProfile.icon,
 				env: { ...defaultProfile.env },
-				color: defaultProfile.color,
+				icon: task.configurationProperties.icon ? ThemeIcon.fromId(task.configurationProperties.icon) : defaultProfile.icon,
+				color: task.configurationProperties.color || defaultProfile.color,
 				waitOnExit
 			};
 			let shellSpecified: boolean = false;
@@ -1125,6 +1126,8 @@ export class TerminalTaskSystem extends Disposable implements ITaskSystem {
 			shellLaunchConfig = {
 				name: terminalName,
 				type,
+				icon: task.configurationProperties.icon ? ThemeIcon.fromId(task.configurationProperties.icon) : undefined,
+				color: task.configurationProperties.color,
 				executable: executable,
 				args: args.map(a => Types.isString(a) ? a : a.value),
 				waitOnExit
@@ -1243,7 +1246,9 @@ export class TerminalTaskSystem extends Disposable implements ITaskSystem {
 				waitOnExit,
 				name: this._createTerminalName(task),
 				initialText: task.command.presentation && task.command.presentation.echo ? `\x1b[1m> Executing task: ${task._label} <\x1b[0m\n` : undefined,
-				isFeatureTerminal: true
+				isFeatureTerminal: true,
+				icon: task.configurationProperties.icon ? ThemeIcon.fromId(task.configurationProperties.icon) : undefined,
+				color: task.configurationProperties.color
 			};
 		} else {
 			const resolvedResult: { command: CommandString; args: CommandString[] } = await this._resolveCommandAndArgs(resolver, task.command);

src/vs/workbench/contrib/tasks/common/jsonSchema_v2.ts

@@ -94,6 +94,16 @@ const detail: IJSONSchema = {
 	description: nls.localize('JsonSchema.tasks.detail', 'An optional description of a task that shows in the Run Task quick pick as a detail.')
 };
 
+const color: IJSONSchema = {
+	type: 'string',
+	description: nls.localize('JsonSchema.tasks.color', 'An optional color for the task icon')
+};
+
+const icon: IJSONSchema = {
+	type: 'string',
+	description: nls.localize('JsonSchema.tasks.icon', 'An optional icon for the task')
+};
+
 const presentation: IJSONSchema = {
 	type: 'object',
 	default: {
@@ -378,6 +388,8 @@ const taskConfiguration: IJSONSchema = {
 			default: false
 		},
 		presentation: Objects.deepClone(presentation),
+		color: Objects.deepClone(color),
+		icon: Objects.deepClone(icon),
 		options: options,
 		problemMatcher: {
 			$ref: '#/definitions/problemMatcherType',
@@ -455,6 +467,8 @@ taskDescriptionProperties.identifier = Objects.deepClone(identifier);
 taskDescriptionProperties.type = Objects.deepClone(taskType);
 taskDescriptionProperties.presentation = Objects.deepClone(presentation);
 taskDescriptionProperties.terminal = terminal;
+taskDescriptionProperties.color = color;
+taskDescriptionProperties.icon = icon;
 taskDescriptionProperties.group = Objects.deepClone(group);
 taskDescriptionProperties.runOptions = Objects.deepClone(runOptions);
 taskDescriptionProperties.detail = detail;

src/vs/workbench/contrib/tasks/common/taskConfiguration.ts

@@ -352,6 +352,16 @@ export interface IConfigurationProperties {
 	 * Task run options. Control run related properties.
 	 */
 	runOptions?: IRunOptionsConfig;
+
+	/**
+	 * The icon for this task in the terminal tabs list
+	 */
+	icon?: string;
+
+	/**
+	 * The icon's color in the terminal tabs list
+	 */
+	color?: string;
 }
 
 export interface ICustomTask extends ICommandProperties, IConfigurationProperties {
@@ -1303,11 +1313,17 @@ namespace DependsOrder {
 namespace ConfigurationProperties {
 
 	const properties: IMetaData<Tasks.IConfigurationProperties, any>[] = [
-
-		{ property: 'name' }, { property: 'identifier' }, { property: 'group' }, { property: 'isBackground' },
-		{ property: 'promptOnClose' }, { property: 'dependsOn' },
-		{ property: 'presentation', type: CommandConfiguration.PresentationOptions }, { property: 'problemMatchers' },
-		{ property: 'options' }
+		{ property: 'name' },
+		{ property: 'identifier' },
+		{ property: 'group' },
+		{ property: 'isBackground' },
+		{ property: 'promptOnClose' },
+		{ property: 'dependsOn' },
+		{ property: 'presentation', type: CommandConfiguration.PresentationOptions },
+		{ property: 'problemMatchers' },
+		{ property: 'options' },
+		{ property: 'color' },
+		{ property: 'icon' }
 	];
 
 	export function from(this: void, external: IConfigurationProperties & { [key: string]: any }, context: IParseContext,
@@ -1334,6 +1350,13 @@ namespace ConfigurationProperties {
 		if (Types.isString(external.identifier)) {
 			result.identifier = external.identifier;
 		}
+		if (Types.isString(external.color)) {
+			result.color = external.color;
+		}
+		if (Types.isString(external.icon)) {
+			result.icon = external.icon;
+		}
+
 		if (external.isBackground !== undefined) {
 			result.isBackground = !!external.isBackground;
 		}
@@ -1618,7 +1641,10 @@ namespace CustomTask {
 			{
 				name: configuredProps.configurationProperties.name || contributedTask.configurationProperties.name,
 				identifier: configuredProps.configurationProperties.identifier || contributedTask.configurationProperties.identifier,
-			}
+				icon: contributedTask.configurationProperties.icon,
+				color: contributedTask.configurationProperties.color
+			},
+
 		);
 		result.addTaskLoadMessages(configuredProps.taskLoadMessages);
 		const resultConfigProps: Tasks.IConfigurationProperties = result.configurationProperties;

src/vs/workbench/contrib/tasks/common/tasks.ts

@@ -544,6 +544,16 @@ export interface IConfigurationProperties {
 	 * The problem watchers to use for this task
 	 */
 	problemMatchers?: Array<string | ProblemMatcher>;
+
+	/**
+	 * The icon for this task in the terminal tabs list
+	 */
+	icon?: string;
+
+	/**
+	 * The icon's color in the terminal tabs list
+	 */
+	color?: string;
 }
 
 export enum RunOnOptions {
@@ -681,6 +691,12 @@ export abstract class CommonTask {
 	}
 }
 
+/**
+ * For tasks of type shell or process, this is created upon parse
+ * of the tasks.json or workspace file.
+ * For ContributedTasks of all other types, this is the result of
+ * resolving a ConfiguringTask.
+ */
 export class CustomTask extends CommonTask {
 
 	override type!: '$customized'; // CUSTOMIZED_TASK_TYPE
@@ -812,6 +828,11 @@ export class CustomTask extends CommonTask {
 	}
 }
 
+/**
+ * After a contributed task has been parsed, but before
+ * the task has been resolved via the extension, its properties
+ * are stored in this
+ */
 export class ConfiguringTask extends CommonTask {
 
 	/**
@@ -871,6 +892,9 @@ export class ConfiguringTask extends CommonTask {
 	}
 }
 
+/**
+ * A task from an extension created via resolveTask or provideTask
+ */
 export class ContributedTask extends CommonTask {
 
 	/**