task.contribution.ts 75.5 KB
Newer Older
E
Erich Gamma 已提交
1 2 3 4 5 6 7 8 9 10 11
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
'use strict';

import 'vs/css!./media/task.contribution';
import 'vs/workbench/parts/tasks/browser/taskQuickOpen';

import * as nls from 'vs/nls';

12
import { TPromise } from 'vs/base/common/winjs.base';
E
Erich Gamma 已提交
13 14
import Severity from 'vs/base/common/severity';
import * as Objects from 'vs/base/common/objects';
15
import URI from 'vs/base/common/uri';
E
Erich Gamma 已提交
16 17 18
import { IStringDictionary } from 'vs/base/common/collections';
import { Action } from 'vs/base/common/actions';
import * as Dom from 'vs/base/browser/dom';
J
Joao Moreno 已提交
19
import { IDisposable, dispose } from 'vs/base/common/lifecycle';
A
Alex Dima 已提交
20
import { EventEmitter } from 'vs/base/common/eventEmitter';
E
Erich Gamma 已提交
21 22 23
import * as Builder from 'vs/base/browser/builder';
import * as Types from 'vs/base/common/types';
import { KeyMod, KeyCode } from 'vs/base/common/keyCodes';
24
import { TerminateResponseCode } from 'vs/base/common/processes';
25
import * as strings from 'vs/base/common/strings';
26
import { ValidationStatus, ValidationState } from 'vs/base/common/parsers';
27
import * as UUID from 'vs/base/common/uuid';
D
Dirk Baeumer 已提交
28
import { LinkedMap, Touch } from 'vs/base/common/map';
E
Erich Gamma 已提交
29

30
import { Registry } from 'vs/platform/registry/common/platform';
E
Erich Gamma 已提交
31
import { ILifecycleService } from 'vs/platform/lifecycle/common/lifecycle';
32
import { SyncActionDescriptor, MenuRegistry } from 'vs/platform/actions/common/actions';
E
Erich Gamma 已提交
33
import { registerSingleton } from 'vs/platform/instantiation/common/extensions';
34
import { IEditor } from 'vs/platform/editor/common/editor';
E
Erich Gamma 已提交
35 36 37
import { IMessageService } from 'vs/platform/message/common/message';
import { IMarkerService, MarkerStatistics } from 'vs/platform/markers/common/markers';
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
38
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
39
import { IFileService } from 'vs/platform/files/common/files';
A
Alex Dima 已提交
40
import { IExtensionService } from 'vs/platform/extensions/common/extensions';
41
import { CommandsRegistry } from 'vs/platform/commands/common/commands';
42 43
import { KeybindingsRegistry } from 'vs/platform/keybinding/common/keybindingsRegistry';
import { ServicesAccessor } from 'vs/platform/instantiation/common/instantiation';
44
import { ProblemMatcherRegistry, NamedProblemMatcher } from 'vs/platform/markers/common/problemMatcher';
45
import { IStorageService, StorageScope } from 'vs/platform/storage/common/storage';
46
import { IProgressService2, IProgressOptions, ProgressLocation } from 'vs/platform/progress/common/progress';
47
import { IOpenerService } from 'vs/platform/opener/common/opener';
E
Erich Gamma 已提交
48 49 50 51

import { IModeService } from 'vs/editor/common/services/modeService';
import { IModelService } from 'vs/editor/common/services/modelService';

52

M
Martin Aeschlimann 已提交
53
import jsonContributionRegistry = require('vs/platform/jsonschemas/common/jsonContributionRegistry');
E
Erich Gamma 已提交
54 55
import { IJSONSchema } from 'vs/base/common/jsonSchema';

56
import { IWorkbenchActionRegistry, Extensions as WorkbenchActionExtensions } from 'vs/workbench/common/actionRegistry';
J
Johannes Rieken 已提交
57
import { IStatusbarItem, IStatusbarRegistry, Extensions as StatusbarExtensions, StatusbarItemDescriptor, StatusbarAlignment } from 'vs/workbench/browser/parts/statusbar/statusbar';
58
import { IQuickOpenRegistry, Extensions as QuickOpenExtensions, QuickOpenHandlerDescriptor } from 'vs/workbench/browser/quickopen';
E
Erich Gamma 已提交
59

60
import { IQuickOpenService, IPickOpenEntry } from 'vs/platform/quickOpen/common/quickOpen';
61
import { IPanelService } from 'vs/workbench/services/panel/common/panelService';
62 63
import Constants from 'vs/workbench/parts/markers/common/constants';
import { IPartService } from 'vs/workbench/services/part/common/partService';
E
Erich Gamma 已提交
64
import { IWorkbenchEditorService } from 'vs/workbench/services/editor/common/editorService';
65
import { IConfigurationResolverService } from 'vs/workbench/services/configurationResolver/common/configurationResolver';
66
import { IConfigurationEditingService, ConfigurationTarget, IConfigurationValue } from 'vs/workbench/services/configuration/common/configurationEditing';
67
import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace';
E
Erich Gamma 已提交
68

69
import { ITextFileService } from 'vs/workbench/services/textfile/common/textfiles';
70
import { IOutputService, IOutputChannelRegistry, Extensions as OutputExt, IOutputChannel } from 'vs/workbench/parts/output/common/output';
71
import { Scope, IActionBarRegistry, Extensions as ActionBarExtensions } from 'vs/workbench/browser/actions';
E
Erich Gamma 已提交
72

73 74
import { ITerminalService } from 'vs/workbench/parts/terminal/common/terminal';

75
import { ITaskSystem, ITaskResolver, ITaskSummary, ITaskExecuteResult, TaskExecuteKind, TaskError, TaskErrors, TaskSystemEvents, TaskTerminateResponse } from 'vs/workbench/parts/tasks/common/taskSystem';
76
import { Task, CustomTask, ConfiguringTask, ContributedTask, TaskSet, TaskGroup, ExecutionEngine, JsonSchemaVersion, TaskSourceKind, TaskIdentifier } from 'vs/workbench/parts/tasks/common/tasks';
77
import { ITaskService, TaskServiceEvents, ITaskProvider, TaskEvent, RunOptions, CustomizationProperties } from 'vs/workbench/parts/tasks/common/taskService';
D
Dirk Baeumer 已提交
78
import { templates as taskTemplates } from 'vs/workbench/parts/tasks/common/taskTemplates';
E
Erich Gamma 已提交
79

80
import * as TaskConfig from '../node/taskConfiguration';
81
import { ProcessTaskSystem } from 'vs/workbench/parts/tasks/node/processTaskSystem';
82
import { TerminalTaskSystem } from './terminalTaskSystem';
J
Johannes Rieken 已提交
83
import { ProcessRunnerDetector } from 'vs/workbench/parts/tasks/node/processRunnerDetector';
D
Dirk Baeumer 已提交
84
import { QuickOpenActionContributor } from '../browser/quickOpen';
85

J
Johannes Rieken 已提交
86
import { IEnvironmentService } from 'vs/platform/environment/common/environment';
E
Erich Gamma 已提交
87

88
import { Themable, STATUS_BAR_FOREGROUND, STATUS_BAR_NO_FOLDER_FOREGROUND } from 'vs/workbench/common/theme';
89 90
import { IThemeService } from 'vs/platform/theme/common/themeService';

E
Erich Gamma 已提交
91
let $ = Builder.$;
92
let tasksCategory = nls.localize('tasksCategory', "Tasks");
E
Erich Gamma 已提交
93

94
abstract class OpenTaskConfigurationAction extends Action {
E
Erich Gamma 已提交
95

96 97 98 99 100 101 102 103 104
	constructor(id: string, label: string,
		private taskService: ITaskService,
		private configurationService: IConfigurationService,
		private editorService: IWorkbenchEditorService, private fileService: IFileService,
		private contextService: IWorkspaceContextService, private outputService: IOutputService,
		private messageService: IMessageService, private quickOpenService: IQuickOpenService,
		private environmentService: IEnvironmentService,
		private configurationResolverService: IConfigurationResolverService,
		private extensionService: IExtensionService) {
E
Erich Gamma 已提交
105 106 107 108

		super(id, label);
	}

J
Johannes Rieken 已提交
109
	public run(event?: any): TPromise<IEditor> {
B
Benjamin Pasero 已提交
110
		if (!this.contextService.hasWorkspace()) {
111 112 113
			this.messageService.show(Severity.Info, nls.localize('ConfigureTaskRunnerAction.noWorkspace', 'Tasks are only available on a workspace folder.'));
			return TPromise.as(undefined);
		}
E
Erich Gamma 已提交
114
		let sideBySide = !!(event && (event.ctrlKey || event.metaKey));
115
		let configFileCreated = false;
B
Benjamin Pasero 已提交
116
		return this.fileService.resolveFile(this.contextService.toResource('.vscode/tasks.json')).then((success) => { // TODO@Dirk (https://github.com/Microsoft/vscode/issues/29454)
117

E
Erich Gamma 已提交
118
			return success;
J
Johannes Rieken 已提交
119 120
		}, (err: any) => {
			return this.quickOpenService.pick(taskTemplates, { placeHolder: nls.localize('ConfigureTaskRunnerAction.quickPick.template', 'Select a Task Runner') }).then(selection => {
D
Dirk Baeumer 已提交
121 122
				if (!selection) {
					return undefined;
E
Erich Gamma 已提交
123
				}
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
				let contentPromise: TPromise<string>;
				if (selection.autoDetect) {
					const outputChannel = this.outputService.getChannel(TaskService.OutputChannelId);
					outputChannel.show(true);
					outputChannel.append(nls.localize('ConfigureTaskRunnerAction.autoDetecting', 'Auto detecting tasks for {0}', selection.id) + '\n');
					let detector = new ProcessRunnerDetector(this.fileService, this.contextService, this.configurationResolverService);
					contentPromise = detector.detect(false, selection.id).then((value) => {
						let config = value.config;
						if (value.stderr && value.stderr.length > 0) {
							value.stderr.forEach((line) => {
								outputChannel.append(line + '\n');
							});
							if (config && (!config.tasks || config.tasks.length === 0)) {
								this.messageService.show(Severity.Warning, nls.localize('ConfigureTaskRunnerAction.autoDetect', 'Auto detecting the task system failed. Using default template. Consult the task output for details.'));
								return selection.content;
							} else {
								this.messageService.show(Severity.Warning, nls.localize('ConfigureTaskRunnerAction.autoDetectError', 'Auto detecting the task system produced errors. Consult the task output for details.'));
							}
						}
						if (config) {
							if (value.stdout && value.stdout.length > 0) {
								value.stdout.forEach(line => outputChannel.append(line + '\n'));
							}
							let content = JSON.stringify(config, null, '\t');
							content = [
								'{',
								'\t// See https://go.microsoft.com/fwlink/?LinkId=733558',
								'\t// for the documentation about the tasks.json format',
							].join('\n') + content.substr(1);
							return content;
						} else {
							return selection.content;
						}
					});
				} else {
					contentPromise = TPromise.as(selection.content);
				}
				return contentPromise.then(content => {
					let editorConfig = this.configurationService.getConfiguration<any>();
					if (editorConfig.editor.insertSpaces) {
						content = content.replace(/(\n)(\t+)/g, (_, s1, s2) => s1 + strings.repeat(' ', s2.length * editorConfig.editor.tabSize));
					}
					configFileCreated = true;
B
Benjamin Pasero 已提交
167
					return this.fileService.createFile(this.contextService.toResource('.vscode/tasks.json'), content); // TODO@Dirk (https://github.com/Microsoft/vscode/issues/29454)
168 169
				});
				/* 2.0 version
D
Dirk Baeumer 已提交
170 171 172 173
				let content = selection.content;
				let editorConfig = this.configurationService.getConfiguration<any>();
				if (editorConfig.editor.insertSpaces) {
					content = content.replace(/(\n)(\t+)/g, (_, s1, s2) => s1 + strings.repeat(' ', s2.length * editorConfig.editor.tabSize));
E
Erich Gamma 已提交
174
				}
D
Dirk Baeumer 已提交
175 176
				configFileCreated = true;
				return this.fileService.createFile(this.contextService.toResource('.vscode/tasks.json'), content);
177
				*/
E
Erich Gamma 已提交
178 179
			});
		}).then((stat) => {
D
Dirk Baeumer 已提交
180 181 182 183
			if (!stat) {
				return undefined;
			}
			// // (2) Open editor with configuration file
E
Erich Gamma 已提交
184 185 186
			return this.editorService.openEditor({
				resource: stat.resource,
				options: {
187 188
					forceOpen: true,
					pinned: configFileCreated // pin only if config file is created #8727
E
Erich Gamma 已提交
189
				}
D
Dirk Baeumer 已提交
190
			}, sideBySide);
E
Erich Gamma 已提交
191 192 193 194 195 196
		}, (error) => {
			throw new Error(nls.localize('ConfigureTaskRunnerAction.failed', "Unable to create the 'tasks.json' file inside the '.vscode' folder. Consult the task output for details."));
		});
	}
}

197 198 199 200
class ConfigureTaskRunnerAction extends OpenTaskConfigurationAction {
	public static ID = 'workbench.action.tasks.configureTaskRunner';
	public static TEXT = nls.localize('ConfigureTaskRunnerAction.label', "Configure Task Runner");

201 202
	constructor(id: string, label: string,
		@ITaskService taskService, @IConfigurationService configurationService: IConfigurationService,
203 204 205
		@IWorkbenchEditorService editorService: IWorkbenchEditorService, @IFileService fileService: IFileService,
		@IWorkspaceContextService contextService: IWorkspaceContextService, @IOutputService outputService: IOutputService,
		@IMessageService messageService: IMessageService, @IQuickOpenService quickOpenService: IQuickOpenService,
206
		@IEnvironmentService environmentService: IEnvironmentService,
207 208 209 210 211
		@IConfigurationResolverService configurationResolverService: IConfigurationResolverService,
		@IExtensionService extensionService) {
		super(id, label, taskService, configurationService, editorService, fileService, contextService,
			outputService, messageService, quickOpenService, environmentService, configurationResolverService,
			extensionService);
J
Johannes Rieken 已提交
212
	}
213 214 215 216 217 218
}

class ConfigureBuildTaskAction extends OpenTaskConfigurationAction {
	public static ID = 'workbench.action.tasks.configureBuildTask';
	public static TEXT = nls.localize('ConfigureBuildTaskAction.label', "Configure Build Task");

219 220
	constructor(id: string, label: string,
		@ITaskService taskService, @IConfigurationService configurationService: IConfigurationService,
221 222 223
		@IWorkbenchEditorService editorService: IWorkbenchEditorService, @IFileService fileService: IFileService,
		@IWorkspaceContextService contextService: IWorkspaceContextService, @IOutputService outputService: IOutputService,
		@IMessageService messageService: IMessageService, @IQuickOpenService quickOpenService: IQuickOpenService,
224
		@IEnvironmentService environmentService: IEnvironmentService,
225 226 227 228 229
		@IConfigurationResolverService configurationResolverService: IConfigurationResolverService,
		@IExtensionService extensionService) {
		super(id, label, taskService, configurationService, editorService, fileService, contextService,
			outputService, messageService, quickOpenService, environmentService, configurationResolverService,
			extensionService);
J
Johannes Rieken 已提交
230
	}
231 232
}

E
Erich Gamma 已提交
233 234 235 236 237 238 239 240 241 242
class CloseMessageAction extends Action {

	public static ID = 'workbench.action.build.closeMessage';
	public static TEXT = nls.localize('CloseMessageAction.label', 'Close');

	public closeFunction: () => void;

	constructor() {
		super(CloseMessageAction.ID, CloseMessageAction.TEXT);
	}
243
	public run(): TPromise<void> {
E
Erich Gamma 已提交
244 245 246
		if (this.closeFunction) {
			this.closeFunction();
		}
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
		return TPromise.as(undefined);
	}
}

class ViewTerminalAction extends Action {

	public static ID = 'workbench.action.build.viewTerminal';
	public static TEXT = nls.localize('ShowTerminalAction.label', 'View Terminal');

	constructor( @ITerminalService private terminalService: ITerminalService) {
		super(ViewTerminalAction.ID, ViewTerminalAction.TEXT);
	}

	public run(): TPromise<void> {
		this.terminalService.showPanel();
		return TPromise.as(undefined);
E
Erich Gamma 已提交
263 264 265
	}
}

266
class BuildStatusBarItem extends Themable implements IStatusbarItem {
E
Erich Gamma 已提交
267 268
	private intervalToken: any;
	private activeCount: number;
J
Johannes Rieken 已提交
269
	private static progressChars: string = '|/-\\';
270 271 272 273 274 275 276 277
	private icons: HTMLElement[];

	constructor(
		@IPanelService private panelService: IPanelService,
		@IMarkerService private markerService: IMarkerService,
		@IOutputService private outputService: IOutputService,
		@ITaskService private taskService: ITaskService,
		@IPartService private partService: IPartService,
278 279
		@IThemeService themeService: IThemeService,
		@IWorkspaceContextService private contextService: IWorkspaceContextService
280 281
	) {
		super(themeService);
E
Erich Gamma 已提交
282 283

		this.activeCount = 0;
284
		this.icons = [];
E
Erich Gamma 已提交
285 286
	}

287 288
	protected updateStyles(): void {
		super.updateStyles();
E
Erich Gamma 已提交
289

290
		this.icons.forEach(icon => {
291
			icon.style.backgroundColor = this.getColor(this.contextService.hasWorkspace() ? STATUS_BAR_FOREGROUND : STATUS_BAR_NO_FOLDER_FOREGROUND);
292 293
		});
	}
E
Erich Gamma 已提交
294

295 296 297 298 299 300 301 302 303 304 305 306
	public render(container: HTMLElement): IDisposable {
		let callOnDispose: IDisposable[] = [];

		const element = document.createElement('div');
		const progress = document.createElement('div');
		const label = document.createElement('a');
		const errorIcon = document.createElement('div');
		const warningIcon = document.createElement('div');
		const infoIcon = document.createElement('div');
		const error = document.createElement('div');
		const warning = document.createElement('div');
		const info = document.createElement('div');
E
Erich Gamma 已提交
307

308
		Dom.addClass(element, 'task-statusbar-item');
E
Erich Gamma 已提交
309 310 311

		Dom.addClass(progress, 'task-statusbar-item-progress');
		element.appendChild(progress);
312
		progress.innerHTML = BuildStatusBarItem.progressChars[0];
E
Erich Gamma 已提交
313 314 315 316
		$(progress).hide();

		Dom.addClass(label, 'task-statusbar-item-label');
		element.appendChild(label);
S
Sandeep Somavarapu 已提交
317
		element.title = nls.localize('problems', "Problems");
E
Erich Gamma 已提交
318

319
		Dom.addClass(errorIcon, 'task-statusbar-item-label-error');
320
		Dom.addClass(errorIcon, 'mask-icon');
321 322 323 324
		label.appendChild(errorIcon);
		this.icons.push(errorIcon);

		Dom.addClass(error, 'task-statusbar-item-label-counter');
E
Erich Gamma 已提交
325 326 327
		error.innerHTML = '0';
		label.appendChild(error);

328
		Dom.addClass(warningIcon, 'task-statusbar-item-label-warning');
329
		Dom.addClass(warningIcon, 'mask-icon');
330 331 332 333
		label.appendChild(warningIcon);
		this.icons.push(warningIcon);

		Dom.addClass(warning, 'task-statusbar-item-label-counter');
E
Erich Gamma 已提交
334 335 336
		warning.innerHTML = '0';
		label.appendChild(warning);

337
		Dom.addClass(infoIcon, 'task-statusbar-item-label-info');
338
		Dom.addClass(infoIcon, 'mask-icon');
339 340 341 342 343
		label.appendChild(infoIcon);
		this.icons.push(infoIcon);
		$(infoIcon).hide();

		Dom.addClass(info, 'task-statusbar-item-label-counter');
E
Erich Gamma 已提交
344 345 346
		label.appendChild(info);
		$(info).hide();

J
Johannes Rieken 已提交
347 348
		callOnDispose.push(Dom.addDisposableListener(label, 'click', (e: MouseEvent) => {
			const panel = this.panelService.getActivePanel();
349 350 351 352 353
			if (panel && panel.getId() === Constants.MARKERS_PANEL_ID) {
				this.partService.setPanelHidden(true);
			} else {
				this.panelService.openPanel(Constants.MARKERS_PANEL_ID, true);
			}
J
Johannes Rieken 已提交
354
		}));
E
Erich Gamma 已提交
355

356
		let updateStatus = (element: HTMLDivElement, icon: HTMLDivElement, stats: number): boolean => {
E
Erich Gamma 已提交
357 358 359
			if (stats > 0) {
				element.innerHTML = stats.toString();
				$(element).show();
360
				$(icon).show();
E
Erich Gamma 已提交
361 362 363
				return true;
			} else {
				$(element).hide();
364
				$(icon).hide();
E
Erich Gamma 已提交
365 366 367 368 369 370 371 372
				return false;
			}
		};

		let manyMarkers = nls.localize('manyMarkers', "99+");
		let updateLabel = (stats: MarkerStatistics) => {
			error.innerHTML = stats.errors < 100 ? stats.errors.toString() : manyMarkers;
			warning.innerHTML = stats.warnings < 100 ? stats.warnings.toString() : manyMarkers;
373
			updateStatus(info, infoIcon, stats.infos);
E
Erich Gamma 已提交
374 375 376 377 378 379
		};

		this.markerService.onMarkerChanged((changedResources) => {
			updateLabel(this.markerService.getStatistics());
		});

380
		callOnDispose.push(this.taskService.addListener(TaskServiceEvents.Active, (event: TaskEvent) => {
381
			if (this.ignoreEvent(event)) {
382 383
				return;
			}
E
Erich Gamma 已提交
384 385 386
			this.activeCount++;
			if (this.activeCount === 1) {
				let index = 1;
387
				let chars = BuildStatusBarItem.progressChars;
E
Erich Gamma 已提交
388 389 390 391 392 393 394 395 396 397 398 399
				progress.innerHTML = chars[0];
				this.intervalToken = setInterval(() => {
					progress.innerHTML = chars[index];
					index++;
					if (index >= chars.length) {
						index = 0;
					}
				}, 50);
				$(progress).show();
			}
		}));

400
		callOnDispose.push(this.taskService.addListener(TaskServiceEvents.Inactive, (event: TaskEvent) => {
401
			if (this.ignoreEvent(event)) {
402 403
				return;
			}
404 405 406 407 408 409 410 411 412 413 414
			// Since the exiting of the sub process is communicated async we can't order inactive and terminate events.
			// So try to treat them accordingly.
			if (this.activeCount > 0) {
				this.activeCount--;
				if (this.activeCount === 0) {
					$(progress).hide();
					if (this.intervalToken) {
						clearInterval(this.intervalToken);
						this.intervalToken = null;
					}
				}
E
Erich Gamma 已提交
415 416 417
			}
		}));

418
		callOnDispose.push(this.taskService.addListener(TaskServiceEvents.Terminated, (event: TaskEvent) => {
419
			if (this.ignoreEvent(event)) {
420 421
				return;
			}
E
Erich Gamma 已提交
422 423 424 425 426 427 428 429 430 431 432 433
			if (this.activeCount !== 0) {
				$(progress).hide();
				if (this.intervalToken) {
					clearInterval(this.intervalToken);
					this.intervalToken = null;
				}
				this.activeCount = 0;
			}
		}));

		container.appendChild(element);

434 435
		this.updateStyles();

E
Erich Gamma 已提交
436
		return {
437
			dispose: () => {
J
Joao Moreno 已提交
438
				callOnDispose = dispose(callOnDispose);
439
			}
E
Erich Gamma 已提交
440 441
		};
	}
442 443 444 445 446 447 448 449 450 451 452 453 454

	private ignoreEvent(event: TaskEvent): boolean {
		if (!this.taskService.inTerminal()) {
			return false;
		}
		if (event.group !== TaskGroup.Build) {
			return true;
		}
		if (!event.__task) {
			return false;
		}
		return event.__task.problemMatchers === void 0 || event.__task.problemMatchers.length === 0;
	}
E
Erich Gamma 已提交
455 456
}

457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
class TaskStatusBarItem extends Themable implements IStatusbarItem {

	constructor(
		@IPanelService private panelService: IPanelService,
		@IMarkerService private markerService: IMarkerService,
		@IOutputService private outputService: IOutputService,
		@ITaskService private taskService: ITaskService,
		@IPartService private partService: IPartService,
		@IThemeService themeService: IThemeService,
		@IWorkspaceContextService private contextService: IWorkspaceContextService,
	) {
		super(themeService);
	}

	protected updateStyles(): void {
		super.updateStyles();
	}

	public render(container: HTMLElement): IDisposable {
		let callOnDispose: IDisposable[] = [];

		const element = document.createElement('div');
		const label = document.createElement('a');

		Dom.addClass(element, 'task-statusbar-runningItem');

		Dom.addClass(label, 'task-statusbar-runningItem-label');
		element.appendChild(label);
		element.title = nls.localize('runningTasks', "Show Running Tasks");

		callOnDispose.push(Dom.addDisposableListener(label, 'click', (e: MouseEvent) => {
			(this.taskService as TaskService).runShowTasks();
		}));

		let updateStatus = (): void => {
			this.taskService.getActiveTasks().then(tasks => {
				if (tasks.length === 0) {
					label.innerHTML = nls.localize('nothingRunner', 'Running Tasks: 0');
				} else if (tasks.length === 1) {
					label.innerHTML = nls.localize('oneTasksRunnering', 'Running Tasks: 1');
				} else {
					label.innerHTML = nls.localize('nTasksRunnering', 'Running Tasks: {0}', tasks.length);
				}
			});
		};

		callOnDispose.push(this.taskService.addListener(TaskServiceEvents.Changed, (event: TaskEvent) => {
			updateStatus();
		}));

		container.appendChild(element);

		this.updateStyles();
		updateStatus();

		return {
			dispose: () => {
				callOnDispose = dispose(callOnDispose);
			}
		};
	}
}

E
Erich Gamma 已提交
520 521 522 523
interface TaskServiceEventData {
	error?: any;
}

524
class NullTaskSystem extends EventEmitter implements ITaskSystem {
525
	public run(task: Task): ITaskExecuteResult {
526
		return {
527
			kind: TaskExecuteKind.Started,
528 529 530
			promise: TPromise.as<ITaskSummary>({})
		};
	}
531 532 533
	public revealTask(task: Task): boolean {
		return false;
	}
534 535 536 537 538 539
	public isActive(): TPromise<boolean> {
		return TPromise.as(false);
	}
	public isActiveSync(): boolean {
		return false;
	}
540 541 542
	public getActiveTasks(): Task[] {
		return [];
	}
543 544 545
	public canAutoTerminate(): boolean {
		return true;
	}
546 547
	public terminate(task: string | Task): TPromise<TaskTerminateResponse> {
		return TPromise.as<TaskTerminateResponse>({ success: true, task: undefined });
548
	}
549 550
	public terminateAll(): TPromise<TaskTerminateResponse[]> {
		return TPromise.as<TaskTerminateResponse[]>([]);
551 552 553
	}
}

554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
class ProblemReporter implements TaskConfig.IProblemReporter {

	private _validationStatus: ValidationStatus;

	constructor(private _outputChannel: IOutputChannel) {
		this._validationStatus = new ValidationStatus();
	}

	public info(message: string): void {
		this._validationStatus.state = ValidationState.Info;
		this._outputChannel.append(message + '\n');
	}

	public warn(message: string): void {
		this._validationStatus.state = ValidationState.Warning;
		this._outputChannel.append(message + '\n');
	}

	public error(message: string): void {
		this._validationStatus.state = ValidationState.Error;
		this._outputChannel.append(message + '\n');
	}

	public fatal(message: string): void {
		this._validationStatus.state = ValidationState.Fatal;
		this._outputChannel.append(message + '\n');
	}

	public get status(): ValidationStatus {
		return this._validationStatus;
	}

	public clearOutput(): void {
		this._outputChannel.clear();
	}
}

591
interface WorkspaceTaskResult {
592
	set: TaskSet;
593 594
	configurations: {
		byIdentifier: IStringDictionary<ConfiguringTask>;
595
	};
596 597 598
	hasErrors: boolean;
}

599 600 601 602 603
interface WorkspaceConfigurationResult {
	config: TaskConfig.ExternalTaskRunnerConfiguration;
	hasErrors: boolean;
}

604 605 606 607
interface TaskCustomizationTelementryEvent {
	properties: string[];
}

E
Erich Gamma 已提交
608
class TaskService extends EventEmitter implements ITaskService {
609

610
	// private static autoDetectTelemetryName: string = 'taskServer.autoDetect';
611
	private static RecentlyUsedTasks_Key = 'workbench.tasks.recentlyUsedTasks';
T
t-amqi 已提交
612
	private static RanTaskBefore_Key = 'workbench.tasks.ranTaskBefore';
613

614 615
	private static CustomizationTelemetryEventName: string = 'taskService.customize';

616
	public _serviceBrand: any;
E
Erich Gamma 已提交
617
	public static SERVICE_ID: string = 'taskService';
J
Johannes Rieken 已提交
618 619
	public static OutputChannelId: string = 'tasks';
	public static OutputChannelLabel: string = nls.localize('tasks', "Tasks");
E
Erich Gamma 已提交
620 621 622

	private modeService: IModeService;
	private configurationService: IConfigurationService;
D
Dirk Baeumer 已提交
623
	private configurationEditingService: IConfigurationEditingService;
E
Erich Gamma 已提交
624 625 626 627 628 629 630 631 632
	private markerService: IMarkerService;
	private outputService: IOutputService;
	private messageService: IMessageService;
	private fileService: IFileService;
	private telemetryService: ITelemetryService;
	private editorService: IWorkbenchEditorService;
	private contextService: IWorkspaceContextService;
	private textFileService: ITextFileService;
	private modelService: IModelService;
A
Alex Dima 已提交
633
	private extensionService: IExtensionService;
D
Dirk Baeumer 已提交
634
	private quickOpenService: IQuickOpenService;
E
Erich Gamma 已提交
635

636
	private _configHasErrors: boolean;
637
	private _providers: Map<number, ITaskProvider>;
638 639

	private _workspaceTasksPromise: TPromise<WorkspaceTaskResult>;
640

E
Erich Gamma 已提交
641
	private _taskSystem: ITaskSystem;
642
	private _taskSystemListeners: IDisposable[];
643
	private _recentlyUsedTasks: LinkedMap<string, string>;
644

645
	private _outputChannel: IOutputChannel;
E
Erich Gamma 已提交
646

J
Johannes Rieken 已提交
647
	constructor( @IModeService modeService: IModeService, @IConfigurationService configurationService: IConfigurationService,
D
Dirk Baeumer 已提交
648
		@IConfigurationEditingService configurationEditingService: IConfigurationEditingService,
E
Erich Gamma 已提交
649
		@IMarkerService markerService: IMarkerService, @IOutputService outputService: IOutputService,
J
Johannes Rieken 已提交
650 651 652
		@IMessageService messageService: IMessageService, @IWorkbenchEditorService editorService: IWorkbenchEditorService,
		@IFileService fileService: IFileService, @IWorkspaceContextService contextService: IWorkspaceContextService,
		@ITelemetryService telemetryService: ITelemetryService, @ITextFileService textFileService: ITextFileService,
653
		@ILifecycleService lifecycleService: ILifecycleService,
A
Alex Dima 已提交
654
		@IModelService modelService: IModelService, @IExtensionService extensionService: IExtensionService,
655
		@IQuickOpenService quickOpenService: IQuickOpenService,
656
		@IEnvironmentService private environmentService: IEnvironmentService,
657
		@IConfigurationResolverService private configurationResolverService: IConfigurationResolverService,
658
		@ITerminalService private terminalService: ITerminalService,
659
		@IWorkbenchEditorService private workbenchEditorService: IWorkbenchEditorService,
660
		@IStorageService private storageService: IStorageService,
661 662
		@IProgressService2 private progressService: IProgressService2,
		@IOpenerService private openerService: IOpenerService
663
	) {
E
Erich Gamma 已提交
664 665 666 667

		super();
		this.modeService = modeService;
		this.configurationService = configurationService;
D
Dirk Baeumer 已提交
668
		this.configurationEditingService = configurationEditingService;
E
Erich Gamma 已提交
669 670 671 672 673 674 675 676 677
		this.markerService = markerService;
		this.outputService = outputService;
		this.messageService = messageService;
		this.editorService = editorService;
		this.fileService = fileService;
		this.contextService = contextService;
		this.telemetryService = telemetryService;
		this.textFileService = textFileService;
		this.modelService = modelService;
A
Alex Dima 已提交
678
		this.extensionService = extensionService;
D
Dirk Baeumer 已提交
679
		this.quickOpenService = quickOpenService;
E
Erich Gamma 已提交
680

681 682
		this._configHasErrors = false;
		this._workspaceTasksPromise = undefined;
683 684 685
		this._taskSystemListeners = [];
		this._outputChannel = this.outputService.getChannel(TaskService.OutputChannelId);
		this._providers = new Map<number, ITaskProvider>();
J
Johannes Rieken 已提交
686
		this.configurationService.onDidUpdateConfiguration(() => {
687
			if (!this._taskSystem && !this._workspaceTasksPromise) {
688 689
				return;
			}
690
			this.updateWorkspaceTasks();
691 692 693
			if (!this._taskSystem) {
				return;
			}
694 695 696 697
			let currentExecutionEngine = this._taskSystem instanceof TerminalTaskSystem
				? ExecutionEngine.Terminal
				: this._taskSystem instanceof ProcessTaskSystem
					? ExecutionEngine.Process
698
					: ExecutionEngine._default;
699
			if (currentExecutionEngine !== this.getExecutionEngine()) {
700
				this.messageService.show(Severity.Info, nls.localize('TaskSystem.noHotSwap', 'Changing the task execution engine requires restarting VS Code. The change is ignored.'));
D
Dirk Baeumer 已提交
701
			}
E
Erich Gamma 已提交
702
		});
703
		lifecycleService.onWillShutdown(event => event.veto(this.beforeShutdown()));
704 705 706 707
		this.registerCommands();
	}

	private registerCommands(): void {
708
		CommandsRegistry.registerCommand('workbench.action.tasks.runTask', (accessor, arg) => {
709 710 711
			this.runTaskCommand(accessor, arg);
		});

712 713 714 715
		CommandsRegistry.registerCommand('workbench.action.tasks.restartTask', (accessor, arg) => {
			this.runRestartTaskCommand(accessor, arg);
		});

716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
		CommandsRegistry.registerCommand('workbench.action.tasks.terminate', (accessor, arg) => {
			this.runTerminateCommand();
		});

		CommandsRegistry.registerCommand('workbench.action.tasks.showLog', () => {
			if (!this.canRunCommand()) {
				return;
			}
			this.showOutput();
		});

		CommandsRegistry.registerCommand('workbench.action.tasks.build', () => {
			if (!this.canRunCommand()) {
				return;
			}
731
			this.runBuildCommand();
732 733 734 735 736 737 738 739 740 741 742 743
		});

		KeybindingsRegistry.registerKeybindingRule({
			id: 'workbench.action.tasks.build',
			weight: KeybindingsRegistry.WEIGHT.workbenchContrib(),
			when: undefined,
			primary: KeyMod.CtrlCmd | KeyMod.Shift | KeyCode.KEY_B
		});

		CommandsRegistry.registerCommand('workbench.action.tasks.test', () => {
			if (!this.canRunCommand()) {
				return;
744
			}
745
			this.runTestCommand();
746
		});
747 748 749 750 751 752 753 754

		CommandsRegistry.registerCommand('workbench.action.tasks.configureDefaultBuildTask', () => {
			this.runConfigureDefaultBuildTask();
		});

		CommandsRegistry.registerCommand('workbench.action.tasks.configureDefaultTestTask', () => {
			this.runConfigureDefaultTestTask();
		});
755 756 757 758

		CommandsRegistry.registerCommand('workbench.action.tasks.showTasks', () => {
			this.runShowTasks();
		});
E
Erich Gamma 已提交
759 760
	}

761
	private showOutput(): void {
762
		this._outputChannel.show(true);
763 764
	}

E
Erich Gamma 已提交
765
	private disposeTaskSystemListeners(): void {
766
		this._taskSystemListeners = dispose(this._taskSystemListeners);
E
Erich Gamma 已提交
767 768
	}

769 770 771 772
	public registerTaskProvider(handle: number, provider: ITaskProvider): void {
		if (!provider) {
			return;
		}
773
		this._providers.set(handle, provider);
774 775 776
	}

	public unregisterTaskProvider(handle: number): boolean {
777
		return this._providers.delete(handle);
778 779
	}

780 781 782 783 784 785 786
	public getTask(identifier: string): TPromise<Task> {
		return this.getTaskSets().then((sets) => {
			let resolver = this.createResolver(sets);
			return resolver.resolve(identifier);
		});
	}

787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
	public tasks(): TPromise<Task[]> {
		return this.getTaskSets().then((sets) => {
			let result: Task[] = [];
			for (let set of sets) {
				result.push(...set.tasks);
			}
			return result;
		});
	};

	public isActive(): TPromise<boolean> {
		if (!this._taskSystem) {
			return TPromise.as(false);
		}
		return this._taskSystem.isActive();
	}

804 805 806 807 808 809 810
	public getActiveTasks(): TPromise<Task[]> {
		if (!this._taskSystem) {
			return TPromise.as([]);
		}
		return TPromise.as(this._taskSystem.getActiveTasks());
	}

811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
	public getRecentlyUsedTasks(): LinkedMap<string, string> {
		if (this._recentlyUsedTasks) {
			return this._recentlyUsedTasks;
		}
		this._recentlyUsedTasks = new LinkedMap<string, string>();
		let storageValue = this.storageService.get(TaskService.RecentlyUsedTasks_Key, StorageScope.WORKSPACE);
		if (storageValue) {
			try {
				let values: string[] = JSON.parse(storageValue);
				if (Array.isArray(values)) {
					for (let value of values) {
						this._recentlyUsedTasks.set(value, value);
					}
				}
			} catch (error) {
				// Ignore. We use the empty result
			}
		}
		return this._recentlyUsedTasks;
	}

	private saveRecentlyUsedTasks(): void {
		if (!this._recentlyUsedTasks) {
			return;
		}
		let values = this._recentlyUsedTasks.values();
		if (values.length > 30) {
			values = values.slice(0, 30);
		}
		this.storageService.store(TaskService.RecentlyUsedTasks_Key, JSON.stringify(values), StorageScope.WORKSPACE);
	}
842

843
	private openDocumentation(): void {
844 845 846
		this.openerService.open(URI.parse('https://go.microsoft.com/fwlink/?LinkId=733558'));
	}

847 848
	public build(): TPromise<ITaskSummary> {
		return this.getTaskSets().then((values) => {
849
			let runnable = this.createRunnableTask(values, TaskGroup.Build);
850
			if (!runnable || !runnable.task) {
851 852 853 854 855
				if (this.getJsonSchemaVersion() === JsonSchemaVersion.V0_1_0) {
					throw new TaskError(Severity.Info, nls.localize('TaskService.noBuildTask1', 'No build task defined. Mark a task with \'isBuildCommand\' in the tasks.json file.'), TaskErrors.NoBuildTask);
				} else {
					throw new TaskError(Severity.Info, nls.localize('TaskService.noBuildTask2', 'No build task defined. Mark a task with as a \'build\' group in the tasks.json file.'), TaskErrors.NoBuildTask);
				}
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
			}
			return this.executeTask(runnable.task, runnable.resolver);
		}).then(value => value, (error) => {
			this.handleError(error);
			return TPromise.wrapError(error);
		});
	}

	public rebuild(): TPromise<ITaskSummary> {
		return TPromise.wrapError<ITaskSummary>(new Error('Not implemented'));
	}

	public clean(): TPromise<ITaskSummary> {
		return TPromise.wrapError<ITaskSummary>(new Error('Not implemented'));
	}

	public runTest(): TPromise<ITaskSummary> {
		return this.getTaskSets().then((values) => {
874
			let runnable = this.createRunnableTask(values, TaskGroup.Test);
875
			if (!runnable || !runnable.task) {
876 877 878 879 880
				if (this.getJsonSchemaVersion() === JsonSchemaVersion.V0_1_0) {
					throw new TaskError(Severity.Info, nls.localize('TaskService.noTestTask1', 'No test task defined. Mark a task with \'isTestCommand\' in the tasks.json file.'), TaskErrors.NoTestTask);
				} else {
					throw new TaskError(Severity.Info, nls.localize('TaskService.noTestTask2', 'No test task defined. Mark a task with as a \'test\' group in the tasks.json file.'), TaskErrors.NoTestTask);
				}
881 882 883 884 885 886 887 888
			}
			return this.executeTask(runnable.task, runnable.resolver);
		}).then(value => value, (error) => {
			this.handleError(error);
			return TPromise.wrapError(error);
		});
	}

889
	public run(task: string | Task, options?: RunOptions): TPromise<ITaskSummary> {
890 891 892 893 894 895 896
		return this.getTaskSets().then((values) => {
			let resolver = this.createResolver(values);
			let requested: string;
			let toExecute: Task;
			if (Types.isString(task)) {
				requested = task;
				toExecute = resolver.resolve(task);
897
			} else {
898
				requested = task.name;
D
Dirk Baeumer 已提交
899
				toExecute = task;
900 901 902 903
			}
			if (!toExecute) {
				throw new TaskError(Severity.Info, nls.localize('TaskServer.noTask', 'Requested task {0} to execute not found.', requested), TaskErrors.TaskNotFound);
			} else {
904
				if (options && options.attachProblemMatcher && this.shouldAttachProblemMatcher(toExecute)) {
905 906 907 908 909 910 911 912
					return this.attachProblemMatcher(toExecute).then((toExecute) => {
						if (toExecute) {
							return this.executeTask(toExecute, resolver);
						} else {
							return TPromise.as(undefined);
						}
					});
				}
913
				return this.executeTask(toExecute, resolver);
914
			}
915 916 917 918 919 920
		}).then(value => value, (error) => {
			this.handleError(error);
			return TPromise.wrapError(error);
		});
	}

921 922 923 924
	private shouldAttachProblemMatcher(task: Task): boolean {
		if (!this.canCustomize()) {
			return false;
		}
925 926 927
		if (task.group !== void 0 && task.group !== TaskGroup.Build) {
			return false;
		}
928 929 930 931
		if (task.problemMatchers !== void 0 && task.problemMatchers.length > 0) {
			return false;
		}
		if (task._source.config === void 0 && ContributedTask.is(task)) {
932
			return !task.hasDefinedMatchers && task.problemMatchers.length === 0;
933 934 935 936 937
		}
		let configProperties: TaskConfig.ConfigurationProperties = task._source.config.element;
		return configProperties.problemMatcher === void 0;
	}

938 939 940
	private attachProblemMatcher(task: Task): TPromise<Task> {
		interface ProblemMatcherPickEntry extends IPickOpenEntry {
			matcher: NamedProblemMatcher;
941
			never?: boolean;
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
			learnMore?: boolean;
		}
		let entries: ProblemMatcherPickEntry[] = [];
		for (let key of ProblemMatcherRegistry.keys()) {
			let matcher = ProblemMatcherRegistry.get(key);
			if (matcher.name === matcher.label) {
				entries.push({ label: matcher.name, matcher: matcher });
			} else {
				entries.push({
					label: matcher.label,
					description: `$${matcher.name}`,
					matcher: matcher
				});
			}
		}
		if (entries.length > 0) {
			entries = entries.sort((a, b) => a.label.localeCompare(b.label));
			entries[0].separator = { border: true };
			entries.unshift(
961 962 963
				{ label: nls.localize('TaskService.attachProblemMatcher.continueWithout', 'Continue without scanning the task output'), matcher: undefined },
				{ label: nls.localize('TaskService.attachProblemMatcher.never', 'Never scan the task output'), matcher: undefined, never: true },
				{ label: nls.localize('TaskService.attachProblemMatcher.learnMoreAbout', 'Learn more about scanning the task output'), matcher: undefined, learnMore: true }
964 965
			);
			return this.quickOpenService.pick(entries, {
966
				placeHolder: nls.localize('selectProblemMatcher', 'Select for which kind of errors and warnings to scan the task output'),
967 968 969 970 971 972
				autoFocus: { autoFocusFirstEntry: true }
			}).then((selected) => {
				if (selected) {
					if (selected.learnMore) {
						this.openDocumentation();
						return undefined;
973 974 975
					} else if (selected.never) {
						this.customize(task, { problemMatcher: [] }, true);
						return task;
976 977 978 979 980 981 982 983 984 985
					} else if (selected.matcher) {
						let newTask = Objects.deepClone(task);
						let matcherReference = `$${selected.matcher.name}`;
						newTask.problemMatchers = [matcherReference];
						this.customize(task, { problemMatcher: [matcherReference] }, true);
						return newTask;
					} else {
						return task;
					}
				} else {
986
					return undefined;
987 988 989 990 991 992
				}
			});
		}
		return TPromise.as(task);
	}

993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
	public getTasksForGroup(group: string): TPromise<Task[]> {
		return this.getTaskSets().then((values) => {
			let result: Task[] = [];
			for (let value of values) {
				for (let task of value.tasks) {
					if (task.group === group) {
						result.push(task);
					}
				}
			}
			return result;
		});
	}

1007 1008 1009 1010
	public canCustomize(): boolean {
		return this.getJsonSchemaVersion() === JsonSchemaVersion.V2_0_0;
	}

1011
	public customize(task: Task, properties?: CustomizationProperties, openConfig?: boolean): TPromise<void> {
D
Dirk Baeumer 已提交
1012 1013 1014 1015 1016 1017
		let configuration = this.getConfiguration();
		if (configuration.hasParseErrors) {
			this.messageService.show(Severity.Warning, nls.localize('customizeParseErrors', 'The current task configuration has errors. Please fix the errors first before customizing a task.'));
			return TPromise.as<void>(undefined);
		}
		let fileConfig = configuration.config;
1018
		let index: number;
1019
		let toCustomize: TaskConfig.CustomTask | TaskConfig.ConfiguringTask;
1020 1021 1022 1023
		let taskConfig = task._source.config;
		if (taskConfig && taskConfig.element) {
			index = taskConfig.index;
			toCustomize = taskConfig.element;
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
		} else if (ContributedTask.is(task)) {
			toCustomize = {
			};
			let identifier: TaskConfig.TaskIdentifier = Objects.assign(Object.create(null), task.defines);
			delete identifier['_key'];
			Object.keys(identifier).forEach(key => toCustomize[key] = identifier[key]);
		}
		if (!toCustomize) {
			return TPromise.as(undefined);
		}
1034 1035 1036 1037
		if (properties) {
			for (let property of Object.getOwnPropertyNames(properties)) {
				let value = properties[property];
				if (value !== void 0 && value !== null) {
1038
					toCustomize[property] = value;
1039 1040 1041 1042
				}
			}
		} else {
			if (task.problemMatchers === void 0 || task.problemMatchers.length === 0) {
1043
				toCustomize.problemMatcher = [];
1044
			}
1045
		}
1046

1047
		let promise: TPromise<void>;
D
Dirk Baeumer 已提交
1048
		if (!fileConfig) {
1049
			let value = {
D
Dirk Baeumer 已提交
1050
				version: '2.0.0',
1051
				tasks: [toCustomize]
D
Dirk Baeumer 已提交
1052
			};
1053 1054 1055 1056 1057 1058 1059 1060 1061
			let content = [
				'{',
				'\t// See https://go.microsoft.com/fwlink/?LinkId=733558',
				'\t// for the documentation about the tasks.json format',
			].join('\n') + JSON.stringify(value, null, '\t').substr(1);
			let editorConfig = this.configurationService.getConfiguration<any>();
			if (editorConfig.editor.insertSpaces) {
				content = content.replace(/(\n)(\t+)/g, (_, s1, s2) => s1 + strings.repeat(' ', s2.length * editorConfig.editor.tabSize));
			}
B
Benjamin Pasero 已提交
1062
			promise = this.fileService.createFile(this.contextService.toResource('.vscode/tasks.json'), content).then(() => { }); // TODO@Dirk (https://github.com/Microsoft/vscode/issues/29454)
D
Dirk Baeumer 已提交
1063
		} else {
1064
			let value: IConfigurationValue = { key: undefined, value: undefined };
1065 1066
			// We have a global task configuration
			if (index === -1) {
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
				if (properties.problemMatcher !== void 0) {
					fileConfig.problemMatcher = properties.problemMatcher;
					value.key = 'tasks.problemMatchers';
					value.value = fileConfig.problemMatcher;
					promise = this.configurationEditingService.writeConfiguration(ConfigurationTarget.WORKSPACE, value);
				} else if (properties.group !== void 0) {
					fileConfig.group = properties.group;
					value.key = 'tasks.group';
					value.value = fileConfig.group;
					promise = this.configurationEditingService.writeConfiguration(ConfigurationTarget.WORKSPACE, value);
				}
1078 1079 1080 1081 1082 1083 1084
			} else {
				if (!Array.isArray(fileConfig.tasks)) {
					fileConfig.tasks = [];
				}
				value.key = 'tasks.tasks';
				value.value = fileConfig.tasks;
				if (index === void 0) {
1085 1086 1087 1088
					fileConfig.tasks.push(toCustomize);
				} else {
					fileConfig.tasks[index] = toCustomize;
				}
1089
				promise = this.configurationEditingService.writeConfiguration(ConfigurationTarget.WORKSPACE, value);
D
Dirk Baeumer 已提交
1090 1091
			}
		};
1092 1093 1094
		if (!promise) {
			return TPromise.as(undefined);
		}
1095
		return promise.then(() => {
1096 1097 1098 1099
			let event: TaskCustomizationTelementryEvent = {
				properties: properties ? Object.getOwnPropertyNames(properties) : []
			};
			this.telemetryService.publicLog(TaskService.CustomizationTelemetryEventName, event);
D
Dirk Baeumer 已提交
1100
			if (openConfig) {
B
Benjamin Pasero 已提交
1101
				let resource = this.contextService.toResource('.vscode/tasks.json'); // TODO@Dirk (https://github.com/Microsoft/vscode/issues/29454)
D
Dirk Baeumer 已提交
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
				this.editorService.openEditor({
					resource: resource,
					options: {
						forceOpen: true,
						pinned: false
					}
				}, false);
			}
		});
	}

1113
	private createRunnableTask(sets: TaskSet[], group: TaskGroup): { task: Task; resolver: ITaskResolver } {
1114
		let idMap: IStringDictionary<Task> = Object.create(null);
D
Dirk Baeumer 已提交
1115
		let labelMap: IStringDictionary<Task> = Object.create(null);
1116 1117
		let identifierMap: IStringDictionary<Task> = Object.create(null);

1118 1119
		let workspaceTasks: Task[] = [];
		let extensionTasks: Task[] = [];
1120 1121
		sets.forEach((set) => {
			set.tasks.forEach((task) => {
1122
				idMap[task._id] = task;
1123
				labelMap[task._label] = task;
1124
				identifierMap[task.identifier] = task;
1125
				if (group && task.group === group) {
1126 1127 1128 1129 1130
					if (task._source.kind === TaskSourceKind.Workspace) {
						workspaceTasks.push(task);
					} else {
						extensionTasks.push(task);
					}
1131
				}
1132 1133 1134 1135
			});
		});
		let resolver: ITaskResolver = {
			resolve: (id: string) => {
1136
				return idMap[id] || labelMap[id] || identifierMap[id];
1137 1138
			}
		};
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
		if (workspaceTasks.length > 0) {
			if (workspaceTasks.length > 1) {
				this._outputChannel.append(nls.localize('moreThanOneBuildTask', 'There are many build tasks defined in the tasks.json. Executing the first one.\n'));
			}
			return { task: workspaceTasks[0], resolver };
		}
		if (extensionTasks.length === 0) {
			return undefined;
		}

1149 1150
		// We can only have extension tasks if we are in version 2.0.0. Then we can even run
		// multiple build tasks.
1151 1152
		if (extensionTasks.length === 1) {
			return { task: extensionTasks[0], resolver };
1153 1154
		} else {
			let id: string = UUID.generateUuid();
1155
			let task: CustomTask = {
1156
				_id: id,
1157
				_source: { kind: TaskSourceKind.Generic, label: 'generic' },
1158
				_label: id,
1159
				type: 'custom',
1160 1161
				name: id,
				identifier: id,
1162
				dependsOn: extensionTasks.map(task => task._id),
1163 1164 1165
				command: undefined,
			};
			return { task, resolver };
E
Erich Gamma 已提交
1166 1167 1168
		}
	}

1169
	private createResolver(sets: TaskSet[]): ITaskResolver {
D
Dirk Baeumer 已提交
1170
		let labelMap: IStringDictionary<Task> = Object.create(null);
1171 1172 1173 1174
		let identifierMap: IStringDictionary<Task> = Object.create(null);

		sets.forEach((set) => {
			set.tasks.forEach((task) => {
1175
				labelMap[task._label] = task;
1176 1177 1178 1179 1180
				identifierMap[task.identifier] = task;
			});
		});
		return {
			resolve: (id: string) => {
D
Dirk Baeumer 已提交
1181
				return labelMap[id] || identifierMap[id];
1182
			}
1183 1184 1185 1186
		};
	}

	private executeTask(task: Task, resolver: ITaskResolver): TPromise<ITaskSummary> {
T
t-amqi 已提交
1187 1188
		if (!this.storageService.get(TaskService.RanTaskBefore_Key, StorageScope.GLOBAL)) {
			this.storageService.store(TaskService.RanTaskBefore_Key, true, StorageScope.GLOBAL);
T
t-amqi 已提交
1189
		}
1190 1191 1192
		return ProblemMatcherRegistry.onReady().then(() => {
			return this.textFileService.saveAll().then((value) => { // make sure all dirty files are saved
				let executeResult = this.getTaskSystem().run(task, resolver);
1193
				this.getRecentlyUsedTasks().set(Task.getKey(task), Task.getKey(task), Touch.First);
1194 1195
				if (executeResult.kind === TaskExecuteKind.Active) {
					let active = executeResult.active;
1196 1197 1198 1199
					if (active.same) {
						if (active.background) {
							this.messageService.show(Severity.Info, nls.localize('TaskSystem.activeSame.background', 'The task is already active and in background mode. To terminate the task use `F1 > terminate task`'));
						} else {
1200
							this.messageService.show(Severity.Info, nls.localize('TaskSystem.activeSame.noBackground', 'The task is already active. To terminate the task use `F1 > terminate task`'));
1201
						}
1202 1203 1204
					} else {
						throw new TaskError(Severity.Warning, nls.localize('TaskSystem.active', 'There is already a task running. Terminate it first before executing another task.'), TaskErrors.RunningTask);
					}
1205
				}
1206 1207
				return executeResult.promise;
			});
1208 1209 1210
		});
	}

1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
	public restart(task: string | Task): void {
		if (!this._taskSystem) {
			return;
		}
		const id: string = Types.isString(task) ? task : task._id;
		this._taskSystem.terminate(id).then((response) => {
			if (response.success) {
				this.emit(TaskServiceEvents.Terminated, {});
				this.run(task);
			} else {
				this.messageService.show(Severity.Warning, nls.localize('TaskSystem.restartFailed', 'Failed to terminate and restart task {0}', Types.isString(task) ? task : task.name));
			}
			return response;
		});
	}

1227
	public terminate(task: string | Task): TPromise<TaskTerminateResponse> {
1228
		if (!this._taskSystem) {
1229
			return TPromise.as({ success: true, task: undefined });
1230
		}
1231
		const id: string = Types.isString(task) ? task : task._id;
1232
		return this._taskSystem.terminate(id);
1233 1234
	}

1235
	public terminateAll(): TPromise<TaskTerminateResponse[]> {
1236
		if (!this._taskSystem) {
1237
			return TPromise.as<TaskTerminateResponse[]>([]);
1238
		}
1239
		return this._taskSystem.terminateAll();
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
	}

	private getTaskSystem(): ITaskSystem {
		if (this._taskSystem) {
			return this._taskSystem;
		}
		let engine = this.getExecutionEngine();
		if (engine === ExecutionEngine.Terminal) {
			this._taskSystem = new TerminalTaskSystem(
				this.terminalService, this.outputService, this.markerService,
				this.modelService, this.configurationResolverService, this.telemetryService,
1251
				this.workbenchEditorService,
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
				TaskService.OutputChannelId
			);
		} else {
			let system = new ProcessTaskSystem(
				this.markerService, this.modelService, this.telemetryService, this.outputService,
				this.configurationResolverService, TaskService.OutputChannelId,
			);
			system.hasErrors(this._configHasErrors);
			this._taskSystem = system;
		}
A
Alex Dima 已提交
1262 1263
		this._taskSystemListeners.push(this._taskSystem.addListener(TaskSystemEvents.Active, (event) => this.emit(TaskServiceEvents.Active, event)));
		this._taskSystemListeners.push(this._taskSystem.addListener(TaskSystemEvents.Inactive, (event) => this.emit(TaskServiceEvents.Inactive, event)));
1264
		this._taskSystemListeners.push(this._taskSystem.addListener(TaskSystemEvents.Terminated, (event) => this.emit(TaskServiceEvents.Terminated, event)));
1265
		this._taskSystemListeners.push(this._taskSystem.addListener(TaskSystemEvents.Changed, () => this.emit(TaskServiceEvents.Changed)));
1266 1267 1268 1269
		return this._taskSystem;
	}

	private getTaskSets(): TPromise<TaskSet[]> {
D
Dirk Baeumer 已提交
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
		return this.extensionService.activateByEvent('onCommand:workbench.action.tasks.runTask').then(() => {
			return new TPromise<TaskSet[]>((resolve, reject) => {
				let result: TaskSet[] = [];
				let counter: number = 0;
				let done = (value: TaskSet) => {
					if (value) {
						result.push(value);
					}
					if (--counter === 0) {
						resolve(result);
					}
				};
				let error = () => {
					if (--counter === 0) {
						resolve(result);
					}
				};
1287
				if (this.getJsonSchemaVersion() === JsonSchemaVersion.V2_0_0 && this._providers.size > 0) {
D
Dirk Baeumer 已提交
1288 1289 1290 1291 1292
					this._providers.forEach((provider) => {
						counter++;
						provider.provideTasks().done(done, error);
					});
				} else {
1293 1294
					resolve(result);
				}
D
Dirk Baeumer 已提交
1295
			});
1296 1297 1298
		}).then((result) => {
			return this.getWorkspaceTasks().then((workspaceTaskResult) => {
				let workspaceTasksToDelete: Task[] = [];
1299 1300 1301
				let configurations = workspaceTaskResult.configurations;
				let legacyTaskConfigurations = workspaceTaskResult.set ? this.getLegacyTaskConfigurations(workspaceTaskResult.set) : undefined;
				if (configurations || legacyTaskConfigurations) {
1302
					for (let set of result) {
1303 1304 1305 1306 1307 1308
						for (let i = 0; i < set.tasks.length; i++) {
							let task = set.tasks[i];
							if (!ContributedTask.is(task)) {
								continue;
							}
							if (configurations) {
1309 1310 1311
								let configuringTask = configurations.byIdentifier[task.defines._key];
								if (configuringTask) {
									set.tasks[i] = TaskConfig.createCustomTask(task, configuringTask);
1312 1313 1314
									continue;
								}
							}
1315
							if (legacyTaskConfigurations) {
1316 1317 1318 1319 1320
								let configuringTask = legacyTaskConfigurations[task.defines._key];
								if (configuringTask) {
									set.tasks[i] = TaskConfig.createCustomTask(task, configuringTask);
									workspaceTasksToDelete.push(configuringTask);
									set.tasks[i] = configuringTask;
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
									continue;
								}
							}
						}
					}
				}
				if (workspaceTaskResult.set) {
					if (workspaceTasksToDelete.length > 0) {
						let tasks = workspaceTaskResult.set.tasks;
						let newSet: TaskSet = {
							extension: workspaceTaskResult.set.extension,
							tasks: []
						};
						let toDelete = workspaceTasksToDelete.reduce<IStringDictionary<boolean>>((map, task) => {
							map[task._id] = true;
							return map;
						}, Object.create(null));
						newSet.tasks = tasks.filter(task => !toDelete[task._id]);
						result.push(newSet);
					} else {
						result.push(workspaceTaskResult.set);
					}
				}
				return result;
			}, () => {
				// If we can't read the tasks.json file provide at least the contributed tasks
				return result;
			});
1349 1350 1351
		});
	}

1352
	private getLegacyTaskConfigurations(workspaceTasks: TaskSet): IStringDictionary<Task> {
1353 1354 1355 1356 1357 1358 1359 1360 1361
		let result: IStringDictionary<Task>;
		function getResult() {
			if (result) {
				return result;
			}
			result = Object.create(null);
			return result;
		}
		for (let task of workspaceTasks.tasks) {
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
			if (CustomTask.is(task)) {
				let commandName = task.command && task.command.name;
				// This is for backwards compatibility with the 0.1.0 task annotation code
				// if we had a gulp, jake or grunt command a task specification was a annotation
				if (commandName === 'gulp' || commandName === 'grunt' || commandName === 'jake') {
					let identifier: TaskIdentifier = TaskConfig.getTaskIdentifier({
						type: commandName,
						task: task.name
					} as TaskConfig.TaskIdentifier);
					getResult()[identifier._key] = task;
				}
1373 1374 1375 1376 1377 1378
			}
		}
		return result;
	}

	private getWorkspaceTasks(): TPromise<WorkspaceTaskResult> {
1379 1380 1381
		if (this._workspaceTasksPromise) {
			return this._workspaceTasksPromise;
		}
1382
		this.updateWorkspaceTasks();
1383 1384 1385 1386 1387 1388
		return this._workspaceTasksPromise;
	}

	private updateWorkspaceTasks(): void {
		this._workspaceTasksPromise = this.computeWorkspaceTasks().then(value => {
			this._configHasErrors = value.hasErrors;
1389 1390 1391 1392
			if (this._taskSystem instanceof ProcessTaskSystem) {
				this._taskSystem.hasErrors(this._configHasErrors);
			}
			return value;
1393 1394 1395 1396
		});
	}

	private computeWorkspaceTasks(): TPromise<WorkspaceTaskResult> {
1397
		let configPromise: TPromise<WorkspaceConfigurationResult>;
1398 1399 1400
		{
			let { config, hasParseErrors } = this.getConfiguration();
			if (hasParseErrors) {
1401
				return TPromise.as({ set: undefined, hasErrors: true, configurations: undefined });
1402
			}
1403
			let engine = ExecutionEngine._default;
1404
			if (config) {
1405
				engine = TaskConfig.ExecutionEngine.from(config);
1406 1407 1408 1409 1410 1411 1412
				if (engine === ExecutionEngine.Process) {
					if (this.hasDetectorSupport(config)) {
						configPromise = new ProcessRunnerDetector(this.fileService, this.contextService, this.configurationResolverService, config).detect(true).then((value): WorkspaceConfigurationResult => {
							let hasErrors = this.printStderr(value.stderr);
							let detectedConfig = value.config;
							if (!detectedConfig) {
								return { config, hasErrors };
1413
							}
1414
							let result: TaskConfig.ExternalTaskRunnerConfiguration = Objects.clone(config);
1415
							let configuredTasks: IStringDictionary<TaskConfig.CustomTask> = Object.create(null);
1416 1417 1418
							if (!result.tasks) {
								if (detectedConfig.tasks) {
									result.tasks = detectedConfig.tasks;
1419
								}
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
							} else {
								result.tasks.forEach(task => configuredTasks[task.taskName] = task);
								detectedConfig.tasks.forEach((task) => {
									if (!configuredTasks[task.taskName]) {
										result.tasks.push(task);
									}
								});
							}
							return { config: result, hasErrors };
						});
					} else {
1431
						configPromise = TPromise.as({ config, hasErrors: false });
1432
					}
1433 1434 1435
				} else {
					configPromise = TPromise.as({ config, hasErrors: false });
				}
1436
			} else {
1437 1438 1439 1440 1441 1442 1443 1444
				if (engine === ExecutionEngine.Terminal) {
					configPromise = TPromise.as({ config, hasErrors: false });
				} else {
					configPromise = new ProcessRunnerDetector(this.fileService, this.contextService, this.configurationResolverService).detect(true).then((value) => {
						let hasErrors = this.printStderr(value.stderr);
						return { config: value.config, hasErrors };
					});
				}
1445 1446
			}
		}
1447
		return configPromise.then((resolved) => {
1448
			return ProblemMatcherRegistry.onReady().then((): WorkspaceTaskResult => {
1449
				if (!resolved || !resolved.config) {
1450
					return { set: undefined, configurations: undefined, hasErrors: resolved !== void 0 ? resolved.hasErrors : false };
1451
				}
1452
				let problemReporter = new ProblemReporter(this._outputChannel);
1453
				let parseResult = TaskConfig.parse(resolved.config, problemReporter);
1454 1455 1456 1457 1458 1459 1460
				let hasErrors = false;
				if (!parseResult.validationStatus.isOK()) {
					hasErrors = true;
					this.showOutput();
				}
				if (problemReporter.status.isFatal()) {
					problemReporter.fatal(nls.localize('TaskSystem.configurationErrors', 'Error: the provided task configuration has validation errors and can\'t not be used. Please correct the errors first.'));
1461
					return { set: undefined, configurations: undefined, hasErrors };
1462
				}
1463 1464 1465
				let customizedTasks: { byIdentifier: IStringDictionary<ConfiguringTask>; };
				if (parseResult.configured && parseResult.configured.length > 0) {
					customizedTasks = {
1466
						byIdentifier: Object.create(null)
1467
					};
1468 1469
					for (let task of parseResult.configured) {
						customizedTasks.byIdentifier[task.configures._key] = task;
1470
					}
1471
				}
1472
				return { set: { tasks: parseResult.custom }, configurations: customizedTasks, hasErrors };
1473 1474 1475 1476 1477 1478 1479
			});
		});
	}

	private getExecutionEngine(): ExecutionEngine {
		let { config } = this.getConfiguration();
		if (!config) {
1480
			return ExecutionEngine._default;
1481 1482 1483 1484
		}
		return TaskConfig.ExecutionEngine.from(config);
	}

1485 1486 1487 1488 1489 1490 1491 1492
	private getJsonSchemaVersion(): JsonSchemaVersion {
		let { config } = this.getConfiguration();
		if (!config) {
			return JsonSchemaVersion.V2_0_0;
		}
		return TaskConfig.JsonSchemaVersion.from(config);
	}

1493
	private getConfiguration(): { config: TaskConfig.ExternalTaskRunnerConfiguration; hasParseErrors: boolean } {
B
Benjamin Pasero 已提交
1494
		let result = this.contextService.hasWorkspace() ? this.configurationService.getConfiguration<TaskConfig.ExternalTaskRunnerConfiguration>('tasks', { resource: this.contextService.getLegacyWorkspace().resource }) : undefined;
1495
		if (!result) {
1496
			return { config: undefined, hasParseErrors: false };
1497 1498 1499 1500 1501 1502 1503 1504 1505
		}
		let parseErrors: string[] = (result as any).$parseErrors;
		if (parseErrors) {
			let isAffected = false;
			for (let i = 0; i < parseErrors.length; i++) {
				if (/tasks\.json$/.test(parseErrors[i])) {
					isAffected = true;
					break;
				}
1506
			}
1507
			if (isAffected) {
1508
				this._outputChannel.append(nls.localize('TaskSystem.invalidTaskJson', 'Error: The content of the tasks.json file has syntax errors. Please correct them before executing a task.\n'));
1509
				this.showOutput();
1510
				return { config: undefined, hasParseErrors: true };
1511
			}
1512 1513
		}
		return { config: result, hasParseErrors: false };
1514 1515
	}

E
Erich Gamma 已提交
1516
	private printStderr(stderr: string[]): boolean {
1517
		let result = false;
E
Erich Gamma 已提交
1518 1519
		if (stderr && stderr.length > 0) {
			stderr.forEach((line) => {
1520
				result = true;
1521
				this._outputChannel.append(line + '\n');
E
Erich Gamma 已提交
1522
			});
1523
			this._outputChannel.show(true);
E
Erich Gamma 已提交
1524 1525 1526 1527
		}
		return result;
	}

1528
	public inTerminal(): boolean {
1529 1530 1531 1532
		if (this._taskSystem) {
			return this._taskSystem instanceof TerminalTaskSystem;
		}
		return this.getExecutionEngine() === ExecutionEngine.Terminal;
1533 1534
	}

1535
	private hasDetectorSupport(config: TaskConfig.ExternalTaskRunnerConfiguration): boolean {
1536
		if (!config.command || !this.contextService.hasWorkspace()) {
E
Erich Gamma 已提交
1537 1538 1539 1540 1541
			return false;
		}
		return ProcessRunnerDetector.supports(config.command);
	}

1542
	public configureAction(): Action {
1543
		return new ConfigureTaskRunnerAction(ConfigureTaskRunnerAction.ID, ConfigureTaskRunnerAction.TEXT, this,
1544
			this.configurationService, this.editorService, this.fileService, this.contextService,
1545 1546
			this.outputService, this.messageService, this.quickOpenService, this.environmentService, this.configurationResolverService,
			this.extensionService);
1547 1548
	}

1549
	private configureBuildTask(): Action {
1550
		return new ConfigureBuildTaskAction(ConfigureBuildTaskAction.ID, ConfigureBuildTaskAction.TEXT, this,
1551
			this.configurationService, this.editorService, this.fileService, this.contextService,
1552 1553
			this.outputService, this.messageService, this.quickOpenService, this.environmentService, this.configurationResolverService,
			this.extensionService);
1554 1555
	}

E
Erich Gamma 已提交
1556
	public beforeShutdown(): boolean | TPromise<boolean> {
1557 1558 1559
		if (!this._taskSystem) {
			return false;
		}
1560
		this.saveRecentlyUsedTasks();
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
		if (!this._taskSystem.isActiveSync()) {
			return false;
		}
		// The terminal service kills all terminal on shutdown. So there
		// is nothing we can do to prevent this here.
		if (this._taskSystem instanceof TerminalTaskSystem) {
			return false;
		}
		if (this._taskSystem.canAutoTerminate() || this.messageService.confirm({
			message: nls.localize('TaskSystem.runningTask', 'There is a task running. Do you want to terminate it?'),
			primaryButton: nls.localize({ key: 'TaskSystem.terminateTask', comment: ['&& denotes a mnemonic'] }, "&&Terminate Task"),
			type: 'question'
		})) {
			return this._taskSystem.terminateAll().then((responses) => {
				let success = true;
				let code: number = undefined;
				for (let response of responses) {
					success = success && response.success;
					// We only have a code in the old output runner which only has one task
					// So we can use the first code.
					if (code === void 0 && response.code !== void 0) {
						code = response.code;
E
Erich Gamma 已提交
1583
					}
1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596
				}
				if (success) {
					this.emit(TaskServiceEvents.Terminated, {});
					this._taskSystem = null;
					this.disposeTaskSystemListeners();
					return false; // no veto
				} else if (code && code === TerminateResponseCode.ProcessNotFound) {
					return !this.messageService.confirm({
						message: nls.localize('TaskSystem.noProcess', 'The launched task doesn\'t exist anymore. If the task spawned background processes exiting VS Code might result in orphaned processes. To avoid this start the last background process with a wait flag.'),
						primaryButton: nls.localize({ key: 'TaskSystem.exitAnyways', comment: ['&& denotes a mnemonic'] }, "&&Exit Anyways"),
						type: 'info'
					});
				}
E
Erich Gamma 已提交
1597
				return true; // veto
1598 1599 1600 1601 1602
			}, (err) => {
				return true; // veto
			});
		} else {
			return true; // veto
E
Erich Gamma 已提交
1603 1604 1605
		}
	}

1606
	private getConfigureAction(code: TaskErrors): Action {
J
Johannes Rieken 已提交
1607
		switch (code) {
1608 1609 1610 1611 1612 1613
			case TaskErrors.NoBuildTask:
				return this.configureBuildTask();
			default:
				return this.configureAction();
		}
	}
1614

J
Johannes Rieken 已提交
1615
	private handleError(err: any): void {
E
Erich Gamma 已提交
1616 1617 1618
		let showOutput = true;
		if (err instanceof TaskError) {
			let buildError = <TaskError>err;
1619 1620 1621
			let needsConfig = buildError.code === TaskErrors.NotConfigured || buildError.code === TaskErrors.NoBuildTask || buildError.code === TaskErrors.NoTestTask;
			let needsTerminate = buildError.code === TaskErrors.RunningTask;
			if (needsConfig || needsTerminate) {
E
Erich Gamma 已提交
1622
				let closeAction = new CloseMessageAction();
1623
				let action: Action = needsConfig
1624
					? this.getConfigureAction(buildError.code)
1625 1626
					: new Action(
						'workbench.action.tasks.terminate',
1627
						nls.localize('TerminateAction.label', "Terminate Task"),
1628
						undefined, true, () => { this.runTerminateCommand(); return TPromise.as<void>(undefined); });
J
Johannes Rieken 已提交
1629
				closeAction.closeFunction = this.messageService.show(buildError.severity, { message: buildError.message, actions: [action, closeAction] });
E
Erich Gamma 已提交
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641
			} else {
				this.messageService.show(buildError.severity, buildError.message);
			}
		} else if (err instanceof Error) {
			let error = <Error>err;
			this.messageService.show(Severity.Error, error.message);
		} else if (Types.isString(err)) {
			this.messageService.show(Severity.Error, <string>err);
		} else {
			this.messageService.show(Severity.Error, nls.localize('TaskSystem.unknownError', 'An error has occurred while running a task. See task log for details.'));
		}
		if (showOutput) {
1642
			this._outputChannel.show(true);
E
Erich Gamma 已提交
1643 1644
		}
	}
1645 1646 1647 1648 1649 1650 1651 1652 1653

	private canRunCommand(): boolean {
		if (!this.contextService.hasWorkspace()) {
			this.messageService.show(Severity.Info, nls.localize('TaskService.noWorkspace', 'Tasks are only available on a workspace folder.'));
			return false;
		}
		return true;
	}

1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
	private showQuickPick(tasks: Task[], placeHolder: string, group: boolean = false, sort: boolean = false): TPromise<Task> {
		if (tasks === void 0 || tasks === null || tasks.length === 0) {
			return TPromise.as(undefined);
		}
		interface TaskQickPickEntry extends IPickOpenEntry {
			task: Task;
		}
		function TaskQickPickEntry(task: Task): TaskQickPickEntry {
			return { label: task._label, task };
		}
		function fillEntries(entries: TaskQickPickEntry[], tasks: Task[], groupLabel: string, withBorder: boolean = false): void {
			let first = true;
			for (let task of tasks) {
				if (first) {
					first = false;
					let entry = TaskQickPickEntry(task);
					entry.separator = { label: groupLabel, border: withBorder };
					entries.push(entry);
				} else {
					entries.push(TaskQickPickEntry(task));
				}
			}
		}
		let entries: TaskQickPickEntry[];
		if (group) {
			entries = [];
			if (tasks.length === 1) {
				entries.push(TaskQickPickEntry(tasks[0]));
			} else {
				let recentlyUsedTasks = this.getRecentlyUsedTasks();
				let recent: Task[] = [];
				let configured: Task[] = [];
				let detected: Task[] = [];
				let taskMap: IStringDictionary<Task> = Object.create(null);
				tasks.forEach(task => taskMap[Task.getKey(task)] = task);
				recentlyUsedTasks.keys().forEach(key => {
					let task = taskMap[key];
					if (task) {
						recent.push(task);
					}
				});
				for (let task of tasks) {
					if (!recentlyUsedTasks.has(Task.getKey(task))) {
						if (task._source.kind === TaskSourceKind.Workspace) {
							configured.push(task);
						} else {
							detected.push(task);
						}
					}
				}
				let hasRecentlyUsed: boolean = recent.length > 0;
				fillEntries(entries, recent, nls.localize('recentlyUsed', 'recently used tasks'));
				configured = configured.sort((a, b) => a._label.localeCompare(b._label));
				let hasConfigured = configured.length > 0;
				fillEntries(entries, configured, nls.localize('configured', 'configured tasks'), hasRecentlyUsed);
				detected = detected.sort((a, b) => a._label.localeCompare(b._label));
				fillEntries(entries, detected, nls.localize('detected', 'detected tasks'), hasRecentlyUsed || hasConfigured);
			}
		} else {
			entries = tasks.map<TaskQickPickEntry>(task => { return { label: task._label, task }; });
			if (sort) {
				entries = entries.sort((a, b) => a.task._label.localeCompare(b.task._label));
			}
		}
		return this.quickOpenService.pick(entries, { placeHolder, autoFocus: { autoFocusFirstEntry: true } }).then(entry => entry ? entry.task : undefined);
	}

1721 1722 1723 1724 1725 1726 1727
	private runTaskCommand(accessor: ServicesAccessor, arg: any): void {
		if (!this.canRunCommand()) {
			return;
		}
		if (Types.isString(arg)) {
			this.tasks().then(tasks => {
				for (let task of tasks) {
D
Dirk Baeumer 已提交
1728
					if (task.identifier === arg) {
1729
						this.run(task);
1730 1731 1732 1733 1734 1735 1736 1737
					}
				}
			});
		} else {
			this.quickOpenService.show('task ');
		}
	}

1738 1739 1740 1741 1742 1743 1744 1745
	private runBuildCommand(): void {
		if (!this.canRunCommand()) {
			return;
		}
		if (!this.inTerminal()) {
			this.build();
			return;
		}
1746 1747 1748 1749 1750
		let options: IProgressOptions = {
			location: ProgressLocation.Window,
			title: nls.localize('TaskService.fetchingBuildTasks', 'Fetching build tasks...')
		};
		let promise = this.getTasksForGroup(TaskGroup.Build).then((tasks) => {
1751
			if (tasks.length === 0) {
1752 1753 1754 1755 1756 1757 1758
				this.messageService.show(
					Severity.Info,
					{
						message: nls.localize('TaskService.noBuildTaskTerminal', 'No Build Task found. Press \'Configure Build Task\' to define one.'),
						actions: [this.configureBuildTask(), new CloseMessageAction()]
					}
				);
1759 1760
				return;
			}
D
Dirk Baeumer 已提交
1761 1762
			let primaries: Task[] = [];
			for (let task of tasks) {
1763
				// We only have build tasks here
1764
				if (task.isDefaultGroupEntry) {
D
Dirk Baeumer 已提交
1765 1766 1767 1768 1769 1770 1771
					primaries.push(task);
				}
			}
			if (primaries.length === 1) {
				this.run(primaries[0]);
				return;
			}
1772 1773 1774 1775 1776
			this.showQuickPick(tasks, nls.localize('TaskService.pickBuildTask', 'Select the build task to run'), true).then((task) => {
				if (task) {
					this.run(task, { attachProblemMatcher: true });
				}
			});
1777
		});
1778
		this.progressService.withProgress(options, () => promise);
1779 1780 1781 1782 1783 1784 1785
	}

	private runTestCommand(): void {
		if (!this.canRunCommand()) {
			return;
		}
		if (!this.inTerminal()) {
1786
			this.runTest();
1787 1788
			return;
		}
1789 1790 1791 1792 1793
		let options: IProgressOptions = {
			location: ProgressLocation.Window,
			title: nls.localize('TaskService.fetchingTestTasks', 'Fetching test tasks...')
		};
		let promise = this.getTasksForGroup(TaskGroup.Test).then((tasks) => {
D
Dirk Baeumer 已提交
1794
			if (tasks.length === 0) {
1795 1796 1797 1798 1799 1800 1801
				this.messageService.show(
					Severity.Info,
					{
						message: nls.localize('TaskService.noTestTaskTerminal', 'No Test Task found. Press \'Configure Task Runner\' to define one.'),
						actions: [this.configureAction(), new CloseMessageAction()]
					}
				);
D
Dirk Baeumer 已提交
1802 1803 1804 1805
				return;
			}
			let primaries: Task[] = [];
			for (let task of tasks) {
1806
				// We only have test task here.
1807
				if (task.isDefaultGroupEntry) {
D
Dirk Baeumer 已提交
1808 1809 1810 1811 1812
					primaries.push(task);
				}
			}
			if (primaries.length === 1) {
				this.run(primaries[0]);
1813 1814
				return;
			}
1815 1816 1817 1818 1819
			this.showQuickPick(tasks, nls.localize('TaskService.pickTestTask', 'Select the test task to run'), true).then((task) => {
				if (task) {
					this.run(task);
				}
			});
1820
		});
1821
		this.progressService.withProgress(options, () => promise);
1822 1823
	}

1824 1825 1826 1827 1828
	private runTerminateCommand(): void {
		if (!this.canRunCommand()) {
			return;
		}
		if (this.inTerminal()) {
1829 1830
			this.getActiveTasks().then((activeTasks) => {
				if (activeTasks.length === 0) {
D
Dirk Baeumer 已提交
1831
					this.messageService.show(Severity.Info, nls.localize('TaskService.noTaskRunning', 'No task is currently running.'));
1832 1833
					return;
				}
1834
				this.showQuickPick(activeTasks, nls.localize('TaskService.tastToTerminate', 'Select task to terminate'), false, true).then(task => {
1835 1836 1837 1838
					if (task) {
						this.terminate(task);
					}
				});
1839
			});
1840 1841 1842
		} else {
			this.isActive().then((active) => {
				if (active) {
1843 1844 1845
					this.terminateAll().then((responses) => {
						// the output runner has only one task
						let response = responses[0];
1846
						if (response.success) {
1847 1848 1849
							return;
						}
						if (response.code && response.code === TerminateResponseCode.ProcessNotFound) {
1850 1851
							this.messageService.show(Severity.Error, nls.localize('TerminateAction.noProcess', 'The launched process doesn\'t exist anymore. If the task spawned background tasks exiting VS Code might result in orphaned processes.'));
						} else {
1852
							this.messageService.show(Severity.Error, nls.localize('TerminateAction.failed', 'Failed to terminate running task'));
1853 1854 1855 1856 1857 1858
						}
					});
				}
			});
		}
	}
1859 1860 1861 1862 1863 1864 1865 1866

	private runRestartTaskCommand(accessor: ServicesAccessor, arg: any): void {
		if (!this.canRunCommand()) {
			return;
		}
		if (this.inTerminal()) {
			this.getActiveTasks().then((activeTasks) => {
				if (activeTasks.length === 0) {
1867
					this.messageService.show(Severity.Info, nls.localize('TaskService.noTaskToRestart', 'No task to restart.'));
1868 1869
					return;
				}
1870
				this.showQuickPick(activeTasks, nls.localize('TaskService.tastToRestart', 'Select the task to restart'), false, true).then(task => {
1871 1872 1873 1874
					if (task) {
						this.restart(task);
					}
				});
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885
			});
		} else {
			this.getActiveTasks().then((activeTasks) => {
				if (activeTasks.length === 0) {
					return;
				}
				let task = activeTasks[0];
				this.restart(task);
			});
		}
	}
1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950

	private runConfigureDefaultBuildTask(): void {
		if (!this.canRunCommand()) {
			return;
		}
		if (this.inTerminal()) {
			this.tasks().then((tasks => {
				if (tasks.length === 0) {
					this.configureBuildTask().run();
					return;
				}
				let defaultTask: Task;
				for (let task of tasks) {
					if (task.group === TaskGroup.Build && task.isDefaultGroupEntry) {
						defaultTask = task;
						break;
					}
				}
				if (defaultTask) {
					this.messageService.show(Severity.Info, nls.localize('TaskService.defaultBuildTaskExists', '{0} is already marked as the default build task.', defaultTask._label));
					return;
				}
				this.showQuickPick(tasks, nls.localize('TaskService.pickDefaultBuildTask', 'Select the task to be used as the default build task'), true).then((task) => {
					if (!task) {
						return;
					}
					this.customize(task, { group: { kind: 'build', isDefault: true } }, true);
				});
			}));
		} else {
			this.configureBuildTask().run();
		}
	}

	private runConfigureDefaultTestTask(): void {
		if (!this.canRunCommand()) {
			return;
		}
		if (this.inTerminal()) {
			this.tasks().then((tasks => {
				if (tasks.length === 0) {
					this.configureAction().run();
				}
				let defaultTask: Task;
				for (let task of tasks) {
					if (task.group === TaskGroup.Test && task.isDefaultGroupEntry) {
						defaultTask = task;
						break;
					}
				}
				if (defaultTask) {
					this.messageService.show(Severity.Info, nls.localize('TaskService.defaultTestTaskExists', '{0} is already marked as the default test task.', defaultTask._label));
					return;
				}
				this.showQuickPick(tasks, nls.localize('TaskService.pickDefaultTestTask', 'Select the task to be used as the default test task'), true).then((task) => {
					if (!task) {
						return;
					}
					this.customize(task, { group: { kind: 'test', isDefault: true } }, true);
				});
			}));
		} else {
			this.configureAction().run();
		}
	}
1951 1952 1953 1954 1955 1956 1957 1958 1959 1960

	public runShowTasks(): void {
		if (!this.canRunCommand()) {
			return;
		}
		if (!this._taskSystem) {
			this.messageService.show(Severity.Info, nls.localize('TaskService.noTaskIsRunning', 'No task is running.'));
			return;
		}
		this.getActiveTasks().then((tasks) => {
1961 1962 1963 1964 1965
			if (tasks.length === 0) {
				this.messageService.show(Severity.Info, nls.localize('TaskService.noTaskIsRunning', 'No task is running.'));
			} else if (tasks.length === 1) {
				if (this._taskSystem) {
					this._taskSystem.revealTask(tasks[0]);
1966
				}
1967 1968 1969 1970 1971 1972 1973 1974
			} else {
				this.showQuickPick(tasks, nls.localize('TaskService.pickShowTask', 'Select the task to show its output'), false, true).then((task) => {
					if (!task || !this._taskSystem) {
						return;
					}
					this._taskSystem.revealTask(task);
				});
			}
1975 1976
		});
	}
E
Erich Gamma 已提交
1977 1978
}

1979

1980
let workbenchActionsRegistry = <IWorkbenchActionRegistry>Registry.as(WorkbenchActionExtensions.WorkbenchActions);
1981
workbenchActionsRegistry.registerWorkbenchAction(new SyncActionDescriptor(ConfigureTaskRunnerAction, ConfigureTaskRunnerAction.ID, ConfigureTaskRunnerAction.TEXT), 'Tasks: Configure Task Runner', tasksCategory);
1982

1983 1984
MenuRegistry.addCommand({ id: 'workbench.action.tasks.showLog', title: { value: nls.localize('ShowLogAction.label', "Show Task Log"), original: 'Show Task Log' }, category: { value: tasksCategory, original: 'Tasks' } });
MenuRegistry.addCommand({ id: 'workbench.action.tasks.runTask', title: { value: nls.localize('RunTaskAction.label', "Run Task"), original: 'Run Task' }, category: { value: tasksCategory, original: 'Tasks' } });
1985
MenuRegistry.addCommand({ id: 'workbench.action.tasks.restartTask', title: { value: nls.localize('RestartTaskAction.label', "Restart Running Task"), original: 'Restart Running Task' }, category: { value: tasksCategory, original: 'Tasks' } });
1986
MenuRegistry.addCommand({ id: 'workbench.action.tasks.showTasks', title: { value: nls.localize('ShowTasksAction.label', "Show Running Tasks"), original: 'Show Running Tasks' }, category: { value: tasksCategory, original: 'Tasks' } });
1987
MenuRegistry.addCommand({ id: 'workbench.action.tasks.terminate', title: { value: nls.localize('TerminateAction.label', "Terminate Task"), original: 'Terminate Task' }, category: { value: tasksCategory, original: 'Tasks' } });
1988 1989
MenuRegistry.addCommand({ id: 'workbench.action.tasks.build', title: { value: nls.localize('BuildAction.label', "Run Build Task"), original: 'Run Build Task' }, category: { value: tasksCategory, original: 'Tasks' } });
MenuRegistry.addCommand({ id: 'workbench.action.tasks.test', title: { value: nls.localize('TestAction.label', "Run Test Task"), original: 'Run Test Task' }, category: { value: tasksCategory, original: 'Tasks' } });
1990 1991
MenuRegistry.addCommand({ id: 'workbench.action.tasks.configureDefaultBuildTask', title: { value: nls.localize('ConfigureDefaultBuildTask.label', "Configure Default Build Task"), original: 'Configure Default Build Task' }, category: { value: tasksCategory, original: 'Tasks' } });
MenuRegistry.addCommand({ id: 'workbench.action.tasks.configureDefaultTestTask', title: { value: nls.localize('ConfigureDefaultTestTask.label', "Configure Default Test Task"), original: 'Configure Default Test Task' }, category: { value: tasksCategory, original: 'Tasks' } });
1992 1993
// MenuRegistry.addCommand( { id: 'workbench.action.tasks.rebuild', title: nls.localize('RebuildAction.label', 'Run Rebuild Task'), category: tasksCategory });
// MenuRegistry.addCommand( { id: 'workbench.action.tasks.clean', title: nls.localize('CleanAction.label', 'Run Clean Task'), category: tasksCategory });
1994 1995 1996 1997 1998

// Task Service
registerSingleton(ITaskService, TaskService);

// Register Quick Open
1999
const quickOpenRegistry = (<IQuickOpenRegistry>Registry.as(QuickOpenExtensions.Quickopen));
2000
const tasksPickerContextKey = 'inTasksPicker';
2001 2002

quickOpenRegistry.registerQuickOpenHandler(
2003 2004 2005 2006
	new QuickOpenHandlerDescriptor(
		'vs/workbench/parts/tasks/browser/taskQuickOpen',
		'QuickOpenHandler',
		'task ',
2007
		tasksPickerContextKey,
2008 2009 2010 2011
		nls.localize('quickOpen.task', "Run Task")
	)
);

D
Dirk Baeumer 已提交
2012 2013 2014
const actionBarRegistry = Registry.as<IActionBarRegistry>(ActionBarExtensions.Actionbar);
actionBarRegistry.registerActionBarContributor(Scope.VIEWER, QuickOpenActionContributor);

2015 2016
// Status bar
let statusbarRegistry = <IStatusbarRegistry>Registry.as(StatusbarExtensions.Statusbar);
2017 2018
statusbarRegistry.registerStatusbarItem(new StatusbarItemDescriptor(BuildStatusBarItem, StatusbarAlignment.LEFT, 50 /* Medium Priority */));
statusbarRegistry.registerStatusbarItem(new StatusbarItemDescriptor(TaskStatusBarItem, StatusbarAlignment.LEFT, 50 /* Medium Priority */));
2019 2020 2021 2022 2023 2024 2025 2026 2027

// Output channel
let outputChannelRegistry = <IOutputChannelRegistry>Registry.as(OutputExt.OutputChannels);
outputChannelRegistry.registerChannel(TaskService.OutputChannelId, TaskService.OutputChannelLabel);

// (<IWorkbenchContributionsRegistry>Registry.as(WorkbenchExtensions.Workbench)).registerWorkbenchContribution(TaskServiceParticipant);

// tasks.json validation
let schemaId = 'vscode://schemas/tasks';
D
Dirk Baeumer 已提交
2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038
let schema: IJSONSchema = {
	id: schemaId,
	description: 'Task definition file',
	type: 'object',
	default: {
		version: '0.1.0',
		command: 'myCommand',
		isShellCommand: false,
		args: [],
		showOutput: 'always',
		tasks: [
2039
			{
D
Dirk Baeumer 已提交
2040 2041 2042 2043
				taskName: 'build',
				showOutput: 'silent',
				isBuildCommand: true,
				problemMatcher: ['$tsc', '$lessCompile']
2044 2045
			}
		]
D
Dirk Baeumer 已提交
2046 2047 2048 2049 2050 2051 2052 2053 2054
	}
};

import schemaVersion1 from './jsonSchema_v1';
import schemaVersion2 from './jsonSchema_v2';
schema.definitions = {
	...schemaVersion1.definitions,
	...schemaVersion2.definitions,
};
2055
schema.oneOf = [...schemaVersion2.oneOf, ...schemaVersion1.oneOf];
D
Dirk Baeumer 已提交
2056 2057


2058
let jsonRegistry = <jsonContributionRegistry.IJSONContributionRegistry>Registry.as(jsonContributionRegistry.Extensions.JSONContribution);
2059
jsonRegistry.registerSchema(schemaId, schema);