taskConfiguration.ts 60.8 KB
Newer Older
E
Erich Gamma 已提交
1 2 3 4 5
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

6
import * as nls from 'vs/nls';
E
Erich Gamma 已提交
7 8 9

import * as Objects from 'vs/base/common/objects';
import { IStringDictionary } from 'vs/base/common/collections';
10
import { Platform } from 'vs/base/common/platform';
E
Erich Gamma 已提交
11 12 13
import * as Types from 'vs/base/common/types';
import * as UUID from 'vs/base/common/uuid';

M
Matt Bierner 已提交
14
import { ValidationStatus, IProblemReporter as IProblemReporterBase } from 'vs/base/common/parsers';
15 16
import {
	NamedProblemMatcher, ProblemMatcher, ProblemMatcherParser, Config as ProblemMatcherConfig,
17
	isNamedProblemMatcher, ProblemMatcherRegistry
18
} from 'vs/workbench/parts/tasks/common/problemMatcher';
19

S
Sandeep Somavarapu 已提交
20
import { IWorkspaceFolder } from 'vs/platform/workspace/common/workspace';
21

22
import * as Tasks from '../common/tasks';
D
Dirk Baeumer 已提交
23
import { TaskDefinitionRegistry } from '../common/taskDefinitionRegistry';
E
Erich Gamma 已提交
24

25 26
import { TaskDefinition } from 'vs/workbench/parts/tasks/node/tasks';

27
export const enum ShellQuoting {
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
	/**
	 * Default is character escaping.
	 */
	escape = 1,

	/**
	 * Default is strong quoting
	 */
	strong = 2,

	/**
	 * Default is weak quoting.
	 */
	weak = 3
}

export interface ShellQuotingOptions {
	/**
	 * The character used to do character escaping.
	 */
	escape?: string | {
		escapeChar: string;
		charsToEscape: string;
	};

	/**
	 * The character used for string quoting.
	 */
	strong?: string;

	/**
	 * The character used for weak quoting.
	 */
	weak?: string;
}

D
Dirk Baeumer 已提交
64
export interface ShellConfiguration {
65
	executable?: string;
D
Dirk Baeumer 已提交
66
	args?: string[];
67
	quoting?: ShellQuotingOptions;
D
Dirk Baeumer 已提交
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
}

export interface CommandOptions {
	/**
	 * The current working directory of the executed program or shell.
	 * If omitted VSCode's current workspace root is used.
	 */
	cwd?: string;

	/**
	 * The additional environment of the executed program or shell. If omitted
	 * the parent process' environment is used.
	 */
	env?: IStringDictionary<string>;

	/**
	 * The shell configuration;
	 */
	shell?: ShellConfiguration;
}

89 90 91 92 93 94
export interface PresentationOptions {
	/**
	 * Controls whether the terminal executing a task is brought to front or not.
	 * Defaults to `RevealKind.Always`.
	 */
	reveal?: string;
D
Dirk Baeumer 已提交
95 96

	/**
97 98 99 100 101 102 103 104 105 106 107
	 * Controls whether the executed command is printed to the output window or terminal as well.
	 */
	echo?: boolean;

	/**
	 * Controls whether the terminal is focus when this task is executed
	 */
	focus?: boolean;

	/**
	 * Controls whether the task runs in a new terminal
D
Dirk Baeumer 已提交
108
	 */
109
	panel?: string;
110 111 112 113

	/**
	 * Controls whether to show the "Terminal will be reused by tasks, press any key to close it" message.
	 */
D
Dirk Baeumer 已提交
114
	showReuseMessage?: boolean;
115 116 117 118 119

	/**
	 * Controls whether the terminal should be cleared before running the task.
	 */
	clearBeforeExecuting?: boolean;
120 121 122
}

export interface TaskIdentifier {
D
Dirk Baeumer 已提交
123
	type?: string;
124 125 126 127 128 129 130 131
	[name: string]: any;
}

export namespace TaskIdentifier {
	export function is(value: any): value is TaskIdentifier {
		let candidate: TaskIdentifier = value;
		return candidate !== void 0 && Types.isString(value.type);
	}
132
}
D
Dirk Baeumer 已提交
133

134
export interface LegacyTaskProperties {
E
Erich Gamma 已提交
135
	/**
136 137
	 * @deprecated Use `isBackground` instead.
	 * Whether the executed command is kept alive and is watching the file system.
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 167 168 169 170 171 172 173
	isWatching?: boolean;

	/**
	 * @deprecated Use `group` instead.
	 * Whether this task maps to the default build command.
	 */
	isBuildCommand?: boolean;

	/**
	 * @deprecated Use `group` instead.
	 * Whether this task maps to the default test command.
	 */
	isTestCommand?: boolean;
}

export interface LegacyCommandProperties {

	/**
	 * Whether this is a shell or process
	 */
	type?: string;

	/**
	 * @deprecated Use presentation options
	 * Controls whether the output view of the running tasks is brought to front or not.
	 * See BaseTaskRunnerConfiguration#showOutput for details.
	 */
	showOutput?: string;

	/**
	 * @deprecated Use presentation options
	 * Controls whether the executed command is printed to the output windows as well.
	 */
	echoCommand?: boolean;

174 175 176 177 178
	/**
	 * @deprecated Use presentation instead
	 */
	terminal?: PresentationOptions;

179 180 181 182 183 184 185 186 187 188 189 190
	/**
	 * @deprecated Use inline commands.
	 * See BaseTaskRunnerConfiguration#suppressTaskName for details.
	 */
	suppressTaskName?: boolean;

	/**
	 * Some commands require that the task argument is highlighted with a special
	 * prefix (e.g. /t: for msbuild). This property can be used to control such
	 * a prefix.
	 */
	taskSelector?: string;
191 192

	/**
D
Dirk Baeumer 已提交
193
	 * @deprecated use the task type instead.
194 195 196 197 198
	 * Specifies whether the command is a shell command and therefore must
	 * be executed in a shell interpreter (e.g. cmd.exe, bash, ...).
	 *
	 * Defaults to false if omitted.
	 */
D
Dirk Baeumer 已提交
199
	isShellCommand?: boolean | ShellConfiguration;
200 201
}

202
export type CommandString = string | string[] | { value: string | string[], quoting: 'escape' | 'strong' | 'weak' };
203

204 205 206 207
export namespace CommandString {
	export function value(value: CommandString): string {
		if (Types.isString(value)) {
			return value;
208 209
		} else if (Types.isStringArray(value)) {
			return value.join(' ');
210
		} else {
211 212 213 214 215
			if (Types.isString(value.value)) {
				return value.value;
			} else {
				return value.value.join(' ');
			}
216 217 218 219 220
		}
	}
}

export interface BaseCommandProperties {
221 222 223 224 225

	/**
	 * The command to be executed. Can be an external program or a shell
	 * command.
	 */
226
	command?: CommandString;
227 228 229 230

	/**
	 * The command options used when the command is executed. Can be omitted.
	 */
D
Dirk Baeumer 已提交
231
	options?: CommandOptions;
232 233 234 235

	/**
	 * The arguments passed to the command or additional arguments passed to the
	 * command when using a global command.
E
Erich Gamma 已提交
236
	 */
237
	args?: CommandString[];
238 239 240
}


241
export interface CommandProperties extends BaseCommandProperties {
D
Dirk Baeumer 已提交
242

243
	/**
244
	 * Windows specific command properties
245
	 */
246
	windows?: BaseCommandProperties;
247

248
	/**
249
	 * OSX specific command properties
250
	 */
251
	osx?: BaseCommandProperties;
252 253

	/**
254
	 * linux specific command properties
255
	 */
256 257
	linux?: BaseCommandProperties;
}
258

D
Dirk Baeumer 已提交
259 260
export interface GroupKind {
	kind?: string;
261
	isDefault?: boolean;
D
Dirk Baeumer 已提交
262 263
}

264
export interface ConfigurationProperties {
265
	/**
266
	 * The task's name
267
	 */
268
	taskName?: string;
E
Erich Gamma 已提交
269

270 271 272 273 274
	/**
	 * The UI label used for the task.
	 */
	label?: string;

E
Erich Gamma 已提交
275
	/**
276 277
	 * An optional indentifier which can be used to reference a task
	 * in a dependsOn or other attributes.
E
Erich Gamma 已提交
278
	 */
279
	identifier?: string;
E
Erich Gamma 已提交
280

281 282 283 284 285
	/**
	 * Whether the executed command is kept alive and runs in the background.
	 */
	isBackground?: boolean;

D
Dirk Baeumer 已提交
286 287 288 289 290
	/**
	 * Whether the task should prompt on close for confirmation if running.
	 */
	promptOnClose?: boolean;

E
Erich Gamma 已提交
291
	/**
292 293
	 * Defines the group the task belongs too.
	 */
D
Dirk Baeumer 已提交
294
	group?: string | GroupKind;
295 296

	/**
297
	 * The other tasks the task depend on
E
Erich Gamma 已提交
298
	 */
299
	dependsOn?: string | TaskIdentifier | (string | TaskIdentifier)[];
E
Erich Gamma 已提交
300 301

	/**
302
	 * Controls the behavior of the used terminal
E
Erich Gamma 已提交
303
	 */
304
	presentation?: PresentationOptions;
E
Erich Gamma 已提交
305

306 307 308 309 310
	/**
	 * Controls shell options.
	 */
	options?: CommandOptions;

E
Erich Gamma 已提交
311
	/**
312 313
	 * The problem matcher(s) to use to capture problems in the tasks
	 * output.
E
Erich Gamma 已提交
314
	 */
315 316
	problemMatcher?: ProblemMatcherConfig.ProblemMatcherType;
}
E
Erich Gamma 已提交
317

318
export interface CustomTask extends CommandProperties, ConfigurationProperties {
E
Erich Gamma 已提交
319
	/**
320
	 * Custom tasks have the type 'custom'
E
Erich Gamma 已提交
321
	 */
322
	type?: string;
E
Erich Gamma 已提交
323

324
}
325

326
export interface ConfiguringTask extends ConfigurationProperties {
E
Erich Gamma 已提交
327
	/**
328
	 * The contributed type of the task
E
Erich Gamma 已提交
329
	 */
330
	type?: string;
E
Erich Gamma 已提交
331 332 333 334 335
}

/**
 * The base task runner configuration
 */
336
export interface BaseTaskRunnerConfiguration {
E
Erich Gamma 已提交
337 338 339 340 341

	/**
	 * The command to be executed. Can be an external program or a shell
	 * command.
	 */
342
	command?: CommandString;
E
Erich Gamma 已提交
343 344

	/**
345 346
	 * @deprecated Use type instead
	 *
E
Erich Gamma 已提交
347 348 349 350 351 352 353
	 * Specifies whether the command is a shell command and therefore must
	 * be executed in a shell interpreter (e.g. cmd.exe, bash, ...).
	 *
	 * Defaults to false if omitted.
	 */
	isShellCommand?: boolean;

354 355 356 357 358
	/**
	 * The task type
	 */
	type?: string;

E
Erich Gamma 已提交
359 360 361
	/**
	 * The command options used when the command is executed. Can be omitted.
	 */
D
Dirk Baeumer 已提交
362
	options?: CommandOptions;
E
Erich Gamma 已提交
363 364 365 366

	/**
	 * The arguments passed to the command. Can be omitted.
	 */
367
	args?: CommandString[];
E
Erich Gamma 已提交
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384

	/**
	 * Controls whether the output view of the running tasks is brought to front or not.
	 * Valid values are:
	 *   "always": bring the output window always to front when a task is executed.
	 *   "silent": only bring it to front if no problem matcher is defined for the task executed.
	 *   "never": never bring the output window to front.
	 *
	 * If omitted "always" is used.
	 */
	showOutput?: string;

	/**
	 * Controls whether the executed command is printed to the output windows as well.
	 */
	echoCommand?: boolean;

385 386 387 388
	/**
	 * The group
	 */
	group?: string | GroupKind;
D
Dirk Baeumer 已提交
389 390 391
	/**
	 * Controls the behavior of the used terminal
	 */
392
	presentation?: PresentationOptions;
D
Dirk Baeumer 已提交
393

E
Erich Gamma 已提交
394 395 396 397 398 399 400 401 402 403 404 405
	/**
	 * If set to false the task name is added as an additional argument to the
	 * command when executed. If set to true the task name is suppressed. If
	 * omitted false is used.
	 */
	suppressTaskName?: boolean;

	/**
	 * Some commands require that the task argument is highlighted with a special
	 * prefix (e.g. /t: for msbuild). This property can be used to control such
	 * a prefix.
	 */
J
Johannes Rieken 已提交
406
	taskSelector?: string;
E
Erich Gamma 已提交
407 408 409 410 411 412 413 414 415

	/**
	 * The problem matcher(s) to used if a global command is exucuted (e.g. no tasks
	 * are defined). A tasks.json file can either contain a global problemMatcher
	 * property or a tasks property but not both.
	 */
	problemMatcher?: ProblemMatcherConfig.ProblemMatcherType;

	/**
416 417
	 * @deprecated Use `isBackground` instead.
	 *
E
Erich Gamma 已提交
418
	 * Specifies whether a global command is a watching the filesystem. A task.json
419
	 * file can either contain a global isWatching property or a tasks property
E
Erich Gamma 已提交
420 421 422 423
	 * but not both.
	 */
	isWatching?: boolean;

424 425 426 427 428
	/**
	 * Specifies whether a global command is a background task.
	 */
	isBackground?: boolean;

D
Dirk Baeumer 已提交
429 430 431 432 433
	/**
	 * Whether the task should prompt on close for confirmation if running.
	 */
	promptOnClose?: boolean;

E
Erich Gamma 已提交
434 435 436 437
	/**
	 * The configuration of the available tasks. A tasks.json file can either
	 * contain a global problemMatcher property or a tasks property but not both.
	 */
438
	tasks?: (CustomTask | ConfiguringTask)[];
E
Erich Gamma 已提交
439 440 441 442 443 444 445 446 447 448 449 450 451

	/**
	 * Problem matcher declarations
	 */
	declares?: ProblemMatcherConfig.NamedProblemMatcher[];
}

/**
 * A configuration of an external build system. BuildConfiguration.buildSystem
 * must be set to 'program'
 */
export interface ExternalTaskRunnerConfiguration extends BaseTaskRunnerConfiguration {

452 453
	_runner?: string;

454 455 456 457 458
	/**
	 * Determines the runner to use
	 */
	runner?: string;

E
Erich Gamma 已提交
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
	/**
	 * The config's version number
	 */
	version: string;

	/**
	 * Windows specific task configuration
	 */
	windows?: BaseTaskRunnerConfiguration;

	/**
	 * Mac specific task configuration
	 */
	osx?: BaseTaskRunnerConfiguration;

	/**
	 * Linux speciif task configuration
	 */
	linux?: BaseTaskRunnerConfiguration;
}

enum ProblemMatcherKind {
	Unknown,
	String,
	ProblemMatcher,
	Array
}

487 488
const EMPTY_ARRAY: any[] = [];
Object.freeze(EMPTY_ARRAY);
E
Erich Gamma 已提交
489

490
function assignProperty<T, K extends keyof T>(target: T, source: Partial<T>, key: K) {
491 492 493
	if (source[key] !== void 0) {
		target[key] = source[key];
	}
E
Erich Gamma 已提交
494 495
}

496
function fillProperty<T, K extends keyof T>(target: T, source: Partial<T>, key: K) {
497 498 499 500 501 502
	if (target[key] === void 0 && source[key] !== void 0) {
		target[key] = source[key];
	}
}


503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
interface ParserType<T> {
	isEmpty(value: T): boolean;
	assignProperties(target: T, source: T): T;
	fillProperties(target: T, source: T): T;
	fillDefaults(value: T, context: ParseContext): T;
	freeze(value: T): Readonly<T>;
}

interface MetaData<T, U> {
	property: keyof T;
	type?: ParserType<U>;
}


function _isEmpty<T>(this: void, value: T, properties: MetaData<T, any>[]): boolean {
	if (value === void 0 || value === null) {
		return true;
	}
	for (let meta of properties) {
		let property = value[meta.property];
		if (property !== void 0 && property !== null) {
			if (meta.type !== void 0 && !meta.type.isEmpty(property)) {
				return false;
			} else if (!Array.isArray(property) || property.length > 0) {
				return false;
			}
		}
	}
	return true;
}

function _assignProperties<T>(this: void, target: T, source: T, properties: MetaData<T, any>[]): T {
	if (_isEmpty(source, properties)) {
		return target;
	}
	if (_isEmpty(target, properties)) {
		return source;
	}
	for (let meta of properties) {
		let property = meta.property;
		let value: any;
		if (meta.type !== void 0) {
			value = meta.type.assignProperties(target[property], source[property]);
		} else {
			value = source[property];
		}
		if (value !== void 0 && value !== null) {
			target[property] = value;
		}
	}
	return target;
}

function _fillProperties<T>(this: void, target: T, source: T, properties: MetaData<T, any>[]): T {
	if (_isEmpty(source, properties)) {
		return target;
	}
	if (_isEmpty(target, properties)) {
		return source;
	}
	for (let meta of properties) {
		let property = meta.property;
		let value: any;
		if (meta.type) {
			value = meta.type.fillProperties(target[property], source[property]);
568
		} else if (target[property] === void 0) {
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
			value = source[property];
		}
		if (value !== void 0 && value !== null) {
			target[property] = value;
		}
	}
	return target;
}

function _fillDefaults<T>(this: void, target: T, defaults: T, properties: MetaData<T, any>[], context: ParseContext): T {
	if (target && Object.isFrozen(target)) {
		return target;
	}
	if (target === void 0 || target === null) {
		if (defaults !== void 0 && defaults !== null) {
J
Johannes Rieken 已提交
584
			return Objects.deepClone(defaults);
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
		} else {
			return undefined;
		}
	}
	for (let meta of properties) {
		let property = meta.property;
		if (target[property] !== void 0) {
			continue;
		}
		let value: any;
		if (meta.type) {
			value = meta.type.fillDefaults(target[property], context);
		} else {
			value = defaults[property];
		}

		if (value !== void 0 && value !== null) {
			target[property] = value;
		}
	}
	return target;
}

function _freeze<T>(this: void, target: T, properties: MetaData<T, any>[]): Readonly<T> {
	if (target === void 0 || target === null) {
		return undefined;
	}
	if (Object.isFrozen(target)) {
		return target;
	}
	for (let meta of properties) {
		if (meta.type) {
			let value = target[meta.property];
			if (value) {
				meta.type.freeze(value);
			}
		}
	}
	Object.freeze(target);
	return target;
}

627
interface ParseContext {
S
Sandeep Somavarapu 已提交
628
	workspaceFolder: IWorkspaceFolder;
629
	problemReporter: IProblemReporter;
630
	namedProblemMatchers: IStringDictionary<NamedProblemMatcher>;
631
	uuidMap: UUIDMap;
632 633
	engine: Tasks.ExecutionEngine;
	schemaVersion: Tasks.JsonSchemaVersion;
634
	platform: Platform;
E
Erich Gamma 已提交
635 636
}

637

638
namespace ShellConfiguration {
639

640
	const properties: MetaData<Tasks.ShellConfiguration, void>[] = [{ property: 'executable' }, { property: 'args' }, { property: 'quoting' }];
641

642 643
	export function is(value: any): value is ShellConfiguration {
		let candidate: ShellConfiguration = value;
D
Dirk Baeumer 已提交
644
		return candidate && (Types.isString(candidate.executable) || Types.isStringArray(candidate.args));
645 646 647 648 649 650
	}

	export function from(this: void, config: ShellConfiguration, context: ParseContext): Tasks.ShellConfiguration {
		if (!is(config)) {
			return undefined;
		}
D
Dirk Baeumer 已提交
651 652 653 654
		let result: ShellConfiguration = {};
		if (config.executable !== void 0) {
			result.executable = config.executable;
		}
655 656 657
		if (config.args !== void 0) {
			result.args = config.args.slice();
		}
658 659 660 661
		if (config.quoting !== void 0) {
			result.quoting = Objects.deepClone(config.quoting);
		}

662 663 664
		return result;
	}

665 666
	export function isEmpty(this: void, value: Tasks.ShellConfiguration): boolean {
		return _isEmpty(value, properties);
667 668
	}

669 670
	export function assignProperties(this: void, target: Tasks.ShellConfiguration, source: Tasks.ShellConfiguration): Tasks.ShellConfiguration {
		return _assignProperties(target, source, properties);
671 672
	}

673 674
	export function fillProperties(this: void, target: Tasks.ShellConfiguration, source: Tasks.ShellConfiguration): Tasks.ShellConfiguration {
		return _fillProperties(target, source, properties);
675 676
	}

677 678
	export function fillDefaults(this: void, value: Tasks.ShellConfiguration, context: ParseContext): Tasks.ShellConfiguration {
		return value;
679 680
	}

681
	export function freeze(this: void, value: Tasks.ShellConfiguration): Readonly<Tasks.ShellConfiguration> {
682
		if (!value) {
683
			return undefined;
684
		}
685
		return Object.freeze(value);
686 687 688
	}
}

689
namespace CommandOptions {
690 691

	const properties: MetaData<Tasks.CommandOptions, Tasks.ShellConfiguration>[] = [{ property: 'cwd' }, { property: 'env' }, { property: 'shell', type: ShellConfiguration }];
692
	const defaults: CommandOptions = { cwd: '${workspaceFolder}' };
693

D
Dirk Baeumer 已提交
694
	export function from(this: void, options: CommandOptions, context: ParseContext): Tasks.CommandOptions {
695
		let result: Tasks.CommandOptions = {};
696 697 698 699
		if (options.cwd !== void 0) {
			if (Types.isString(options.cwd)) {
				result.cwd = options.cwd;
			} else {
700
				context.problemReporter.warn(nls.localize('ConfigurationParser.invalidCWD', 'Warning: options.cwd must be of type string. Ignoring value {0}\n', options.cwd));
701 702 703
			}
		}
		if (options.env !== void 0) {
J
Johannes Rieken 已提交
704
			result.env = Objects.deepClone(options.env);
705
		}
D
Dirk Baeumer 已提交
706
		result.shell = ShellConfiguration.from(options.shell, context);
707
		return isEmpty(result) ? undefined : result;
E
Erich Gamma 已提交
708 709
	}

710
	export function isEmpty(value: Tasks.CommandOptions): boolean {
711
		return _isEmpty(value, properties);
E
Erich Gamma 已提交
712 713
	}

714
	export function assignProperties(target: Tasks.CommandOptions, source: Tasks.CommandOptions): Tasks.CommandOptions {
715 716
		if (isEmpty(source)) {
			return target;
E
Erich Gamma 已提交
717
		}
718 719
		if (isEmpty(target)) {
			return source;
E
Erich Gamma 已提交
720
		}
721
		assignProperty(target, source, 'cwd');
722 723 724 725 726
		if (target.env === void 0) {
			target.env = source.env;
		} else if (source.env !== void 0) {
			let env: { [key: string]: string; } = Object.create(null);
			Object.keys(target.env).forEach(key => env[key] = target.env[key]);
727
			Object.keys(source.env).forEach(key => env[key] = source.env[key]);
728 729
			target.env = env;
		}
730 731 732 733 734
		target.shell = ShellConfiguration.assignProperties(target.shell, source.shell);
		return target;
	}

	export function fillProperties(target: Tasks.CommandOptions, source: Tasks.CommandOptions): Tasks.CommandOptions {
735
		return _fillProperties(target, source, properties);
E
Erich Gamma 已提交
736 737
	}

738 739
	export function fillDefaults(value: Tasks.CommandOptions, context: ParseContext): Tasks.CommandOptions {
		return _fillDefaults(value, defaults, properties, context);
740 741
	}

742 743
	export function freeze(value: Tasks.CommandOptions): Readonly<Tasks.CommandOptions> {
		return _freeze(value, properties);
E
Erich Gamma 已提交
744
	}
745
}
E
Erich Gamma 已提交
746

747
namespace CommandConfiguration {
748

749
	export namespace PresentationOptions {
D
Dirk Baeumer 已提交
750
		const properties: MetaData<Tasks.PresentationOptions, void>[] = [{ property: 'echo' }, { property: 'reveal' }, { property: 'focus' }, { property: 'panel' }, { property: 'showReuseMessage' }];
751

752 753 754 755 756
		interface PresentationOptionsShape extends LegacyCommandProperties {
			presentation?: PresentationOptions;
		}

		export function from(this: void, config: PresentationOptionsShape, context: ParseContext): Tasks.PresentationOptions {
757 758 759
			let echo: boolean;
			let reveal: Tasks.RevealKind;
			let focus: boolean;
760
			let panel: Tasks.PanelKind;
D
Dirk Baeumer 已提交
761
			let showReuseMessage: boolean;
762
			let clearBeforeExecuting: boolean;
D
Dirk Baeumer 已提交
763 764 765 766 767 768
			if (Types.isBoolean(config.echoCommand)) {
				echo = config.echoCommand;
			}
			if (Types.isString(config.showOutput)) {
				reveal = Tasks.RevealKind.fromString(config.showOutput);
			}
769 770 771 772
			let presentation = config.presentation || config.terminal;
			if (presentation) {
				if (Types.isBoolean(presentation.echo)) {
					echo = presentation.echo;
D
Dirk Baeumer 已提交
773
				}
774 775
				if (Types.isString(presentation.reveal)) {
					reveal = Tasks.RevealKind.fromString(presentation.reveal);
D
Dirk Baeumer 已提交
776
				}
777 778
				if (Types.isBoolean(presentation.focus)) {
					focus = presentation.focus;
779
				}
780 781
				if (Types.isString(presentation.panel)) {
					panel = Tasks.PanelKind.fromString(presentation.panel);
782
				}
D
Dirk Baeumer 已提交
783 784
				if (Types.isBoolean(presentation.showReuseMessage)) {
					showReuseMessage = presentation.showReuseMessage;
785
				}
786 787 788
				if (Types.isBoolean(presentation.clearBeforeExecuting)) {
					clearBeforeExecuting = presentation.clearBeforeExecuting;
				}
D
Dirk Baeumer 已提交
789
			}
D
Dirk Baeumer 已提交
790
			if (echo === void 0 && reveal === void 0 && focus === void 0 && panel === void 0 && showReuseMessage === void 0) {
D
Dirk Baeumer 已提交
791 792
				return undefined;
			}
793
			return { echo, reveal, focus, panel, showReuseMessage, clearBeforeExecuting };
D
Dirk Baeumer 已提交
794 795
		}

796
		export function assignProperties(target: Tasks.PresentationOptions, source: Tasks.PresentationOptions): Tasks.PresentationOptions {
797
			return _assignProperties(target, source, properties);
798 799
		}

800
		export function fillProperties(target: Tasks.PresentationOptions, source: Tasks.PresentationOptions): Tasks.PresentationOptions {
801
			return _fillProperties(target, source, properties);
D
Dirk Baeumer 已提交
802 803
		}

804
		export function fillDefaults(value: Tasks.PresentationOptions, context: ParseContext): Tasks.PresentationOptions {
805
			let defaultEcho = context.engine === Tasks.ExecutionEngine.Terminal ? true : false;
806
			return _fillDefaults(value, { echo: defaultEcho, reveal: Tasks.RevealKind.Always, focus: false, panel: Tasks.PanelKind.Shared, showReuseMessage: true, clearBeforeExecuting: false }, properties, context);
D
Dirk Baeumer 已提交
807 808
		}

809
		export function freeze(value: Tasks.PresentationOptions): Readonly<Tasks.PresentationOptions> {
810
			return _freeze(value, properties);
D
Dirk Baeumer 已提交
811 812
		}

813
		export function isEmpty(this: void, value: Tasks.PresentationOptions): boolean {
814
			return _isEmpty(value, properties);
D
Dirk Baeumer 已提交
815 816 817
		}
	}

818 819 820 821 822 823 824
	namespace ShellString {
		export function from(this: void, value: CommandString): Tasks.CommandString {
			if (value === void 0 || value === null) {
				return undefined;
			}
			if (Types.isString(value)) {
				return value;
825 826 827 828 829 830 831 832 833 834 835 836 837
			} else if (Types.isStringArray(value)) {
				return value.join(' ');
			} else {
				let quoting = Tasks.ShellQuoting.from(value.quoting);
				let result = Types.isString(value.value) ? value.value : Types.isStringArray(value.value) ? value.value.join(' ') : undefined;
				if (result) {
					return {
						value: result,
						quoting: quoting
					};
				} else {
					return undefined;
				}
838 839 840 841
			}
		}
	}

842 843 844 845 846 847 848 849 850 851 852
	interface BaseCommandConfiguationShape extends BaseCommandProperties, LegacyCommandProperties {
	}

	interface CommandConfiguationShape extends BaseCommandConfiguationShape {
		windows?: BaseCommandConfiguationShape;
		osx?: BaseCommandConfiguationShape;
		linux?: BaseCommandConfiguationShape;
	}

	const properties: MetaData<Tasks.CommandConfiguration, any>[] = [
		{ property: 'runtime' }, { property: 'name' }, { property: 'options', type: CommandOptions },
853
		{ property: 'args' }, { property: 'taskSelector' }, { property: 'suppressTaskName' },
854
		{ property: 'presentation', type: PresentationOptions }
855 856
	];

857 858
	export function from(this: void, config: CommandConfiguationShape, context: ParseContext): Tasks.CommandConfiguration {
		let result: Tasks.CommandConfiguration = fromBase(config, context);
859

860
		let osConfig: Tasks.CommandConfiguration = undefined;
861
		if (config.windows && context.platform === Platform.Windows) {
862
			osConfig = fromBase(config.windows, context);
863
		} else if (config.osx && context.platform === Platform.Mac) {
864
			osConfig = fromBase(config.osx, context);
865
		} else if (config.linux && context.platform === Platform.Linux) {
866 867 868
			osConfig = fromBase(config.linux, context);
		}
		if (osConfig) {
869
			result = assignProperties(result, osConfig, context.schemaVersion === Tasks.JsonSchemaVersion.V2_0_0);
870 871 872 873
		}
		return isEmpty(result) ? undefined : result;
	}

874 875 876
	function fromBase(this: void, config: BaseCommandConfiguationShape, context: ParseContext): Tasks.CommandConfiguration {
		let result: Tasks.CommandConfiguration = {
			name: undefined,
877
			runtime: undefined,
878
			presentation: undefined
879
		};
880 881

		result.name = ShellString.from(config.command);
D
Dirk Baeumer 已提交
882
		if (Types.isString(config.type)) {
883 884 885
			if (config.type === 'shell' || config.type === 'process') {
				result.runtime = Tasks.RuntimeType.fromString(config.type);
			}
D
Dirk Baeumer 已提交
886 887 888
		}
		let isShellConfiguration = ShellConfiguration.is(config.isShellCommand);
		if (Types.isBoolean(config.isShellCommand) || isShellConfiguration) {
889
			result.runtime = Tasks.RuntimeType.Shell;
890
		} else if (config.isShellCommand !== void 0) {
891 892
			result.runtime = !!config.isShellCommand ? Tasks.RuntimeType.Shell : Tasks.RuntimeType.Process;
		}
893

894
		if (config.args !== void 0) {
895 896 897
			result.args = [];
			for (let arg of config.args) {
				let converted = ShellString.from(arg);
D
Dirk Baeumer 已提交
898
				if (converted !== void 0) {
899 900
					result.args.push(converted);
				} else {
901 902 903 904 905 906
					context.problemReporter.error(
						nls.localize(
							'ConfigurationParser.inValidArg',
							'Error: command argument must either be a string or a quoted string. Provided value is:\n{0}',
							arg ? JSON.stringify(arg, undefined, 4) : 'undefined'
						));
907
				}
908
			}
E
Erich Gamma 已提交
909
		}
910 911
		if (config.options !== void 0) {
			result.options = CommandOptions.from(config.options, context);
D
Dirk Baeumer 已提交
912 913
			if (result.options && result.options.shell === void 0 && isShellConfiguration) {
				result.options.shell = ShellConfiguration.from(config.isShellCommand as ShellConfiguration, context);
914
				if (context.engine !== Tasks.ExecutionEngine.Terminal) {
D
Dirk Baeumer 已提交
915 916 917
					context.problemReporter.warn(nls.localize('ConfigurationParser.noShell', 'Warning: shell configuration is only supported when executing tasks in the terminal.'));
				}
			}
E
Erich Gamma 已提交
918
		}
919 920 921
		let panel = PresentationOptions.from(config, context);
		if (panel) {
			result.presentation = panel;
E
Erich Gamma 已提交
922
		}
923 924
		if (Types.isString(config.taskSelector)) {
			result.taskSelector = config.taskSelector;
E
Erich Gamma 已提交
925
		}
926 927 928
		if (Types.isBoolean(config.suppressTaskName)) {
			result.suppressTaskName = config.suppressTaskName;
		}
929
		return isEmpty(result) ? undefined : result;
E
Erich Gamma 已提交
930 931
	}

932 933 934 935
	export function hasCommand(value: Tasks.CommandConfiguration): boolean {
		return value && !!value.name;
	}

936
	export function isEmpty(value: Tasks.CommandConfiguration): boolean {
937
		return _isEmpty(value, properties);
938 939
	}

940
	export function assignProperties(target: Tasks.CommandConfiguration, source: Tasks.CommandConfiguration, overwriteArgs: boolean): Tasks.CommandConfiguration {
941 942
		if (isEmpty(source)) {
			return target;
E
Erich Gamma 已提交
943
		}
944 945
		if (isEmpty(target)) {
			return source;
E
Erich Gamma 已提交
946
		}
947
		assignProperty(target, source, 'name');
948
		assignProperty(target, source, 'runtime');
949 950
		assignProperty(target, source, 'taskSelector');
		assignProperty(target, source, 'suppressTaskName');
951
		if (source.args !== void 0) {
952
			if (target.args === void 0 || overwriteArgs) {
953 954 955
				target.args = source.args;
			} else {
				target.args = target.args.concat(source.args);
E
Erich Gamma 已提交
956 957
			}
		}
958
		target.presentation = PresentationOptions.assignProperties(target.presentation, source.presentation);
959 960 961 962
		target.options = CommandOptions.assignProperties(target.options, source.options);
		return target;
	}

963 964 965 966
	export function fillProperties(target: Tasks.CommandConfiguration, source: Tasks.CommandConfiguration): Tasks.CommandConfiguration {
		return _fillProperties(target, source, properties);
	}

967 968 969 970 971 972
	export function fillGlobals(target: Tasks.CommandConfiguration, source: Tasks.CommandConfiguration, taskName: string): Tasks.CommandConfiguration {
		if (isEmpty(source)) {
			return target;
		}
		target = target || {
			name: undefined,
973
			runtime: undefined,
974
			presentation: undefined
975
		};
976 977 978 979
		if (target.name === void 0) {
			fillProperty(target, source, 'name');
			fillProperty(target, source, 'taskSelector');
			fillProperty(target, source, 'suppressTaskName');
980
			let args: Tasks.CommandString[] = source.args ? source.args.slice() : [];
981 982 983 984 985 986 987 988 989 990 991 992
			if (!target.suppressTaskName) {
				if (target.taskSelector !== void 0) {
					args.push(target.taskSelector + taskName);
				} else {
					args.push(taskName);
				}
			}
			if (target.args) {
				args = args.concat(target.args);
			}
			target.args = args;
		}
993
		fillProperty(target, source, 'runtime');
994

995
		target.presentation = PresentationOptions.fillProperties(target.presentation, source.presentation);
996 997
		target.options = CommandOptions.fillProperties(target.options, source.options);

998
		return target;
E
Erich Gamma 已提交
999 1000
	}

1001
	export function fillDefaults(value: Tasks.CommandConfiguration, context: ParseContext): void {
1002 1003 1004
		if (!value || Object.isFrozen(value)) {
			return;
		}
1005 1006
		if (value.name !== void 0 && value.runtime === void 0) {
			value.runtime = Tasks.RuntimeType.Process;
1007
		}
1008
		value.presentation = PresentationOptions.fillDefaults(value.presentation, context);
1009
		if (!isEmpty(value)) {
1010
			value.options = CommandOptions.fillDefaults(value.options, context);
1011
		}
1012 1013 1014
		if (value.args === void 0) {
			value.args = EMPTY_ARRAY;
		}
1015 1016
		if (value.suppressTaskName === void 0) {
			value.suppressTaskName = false;
E
Erich Gamma 已提交
1017 1018 1019
		}
	}

1020 1021
	export function freeze(value: Tasks.CommandConfiguration): Readonly<Tasks.CommandConfiguration> {
		return _freeze(value, properties);
E
Erich Gamma 已提交
1022
	}
1023
}
E
Erich Gamma 已提交
1024

1025 1026 1027
namespace ProblemMatcherConverter {

	export function namedFrom(this: void, declares: ProblemMatcherConfig.NamedProblemMatcher[], context: ParseContext): IStringDictionary<NamedProblemMatcher> {
J
Johannes Rieken 已提交
1028
		let result: IStringDictionary<NamedProblemMatcher> = Object.create(null);
1029 1030

		if (!Types.isArray(declares)) {
E
Erich Gamma 已提交
1031 1032
			return result;
		}
1033
		(<ProblemMatcherConfig.NamedProblemMatcher[]>declares).forEach((value) => {
1034
			let namedProblemMatcher = (new ProblemMatcherParser(context.problemReporter)).parse(value);
1035
			if (isNamedProblemMatcher(namedProblemMatcher)) {
E
Erich Gamma 已提交
1036
				result[namedProblemMatcher.name] = namedProblemMatcher;
1037
			} else {
1038
				context.problemReporter.error(nls.localize('ConfigurationParser.noName', 'Error: Problem Matcher in declare scope must have a name:\n{0}\n', JSON.stringify(value, undefined, 4)));
E
Erich Gamma 已提交
1039 1040 1041 1042 1043
			}
		});
		return result;
	}

1044 1045 1046 1047 1048 1049 1050
	export function from(this: void, config: ProblemMatcherConfig.ProblemMatcherType, context: ParseContext): ProblemMatcher[] {
		let result: ProblemMatcher[] = [];
		if (config === void 0) {
			return result;
		}
		let kind = getProblemMatcherKind(config);
		if (kind === ProblemMatcherKind.Unknown) {
1051
			context.problemReporter.warn(nls.localize(
1052 1053 1054
				'ConfigurationParser.unknownMatcherKind',
				'Warning: the defined problem matcher is unknown. Supported types are string | ProblemMatcher | (string | ProblemMatcher)[].\n{0}\n',
				JSON.stringify(config, null, 4)));
E
Erich Gamma 已提交
1055
			return result;
1056
		} else if (kind === ProblemMatcherKind.String || kind === ProblemMatcherKind.ProblemMatcher) {
1057
			let matcher = resolveProblemMatcher(config as ProblemMatcherConfig.ProblemMatcher, context);
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
			if (matcher) {
				result.push(matcher);
			}
		} else if (kind === ProblemMatcherKind.Array) {
			let problemMatchers = <(string | ProblemMatcherConfig.ProblemMatcher)[]>config;
			problemMatchers.forEach(problemMatcher => {
				let matcher = resolveProblemMatcher(problemMatcher, context);
				if (matcher) {
					result.push(matcher);
				}
			});
		}
		return result;
	}

	function getProblemMatcherKind(this: void, value: ProblemMatcherConfig.ProblemMatcherType): ProblemMatcherKind {
		if (Types.isString(value)) {
			return ProblemMatcherKind.String;
		} else if (Types.isArray(value)) {
			return ProblemMatcherKind.Array;
		} else if (!Types.isUndefined(value)) {
			return ProblemMatcherKind.ProblemMatcher;
E
Erich Gamma 已提交
1080
		} else {
1081
			return ProblemMatcherKind.Unknown;
E
Erich Gamma 已提交
1082 1083 1084
		}
	}

1085 1086 1087 1088 1089 1090 1091
	function resolveProblemMatcher(this: void, value: string | ProblemMatcherConfig.ProblemMatcher, context: ParseContext): ProblemMatcher {
		if (Types.isString(value)) {
			let variableName = <string>value;
			if (variableName.length > 1 && variableName[0] === '$') {
				variableName = variableName.substring(1);
				let global = ProblemMatcherRegistry.get(variableName);
				if (global) {
J
Johannes Rieken 已提交
1092
					return Objects.deepClone(global);
1093 1094 1095
				}
				let localProblemMatcher = context.namedProblemMatchers[variableName];
				if (localProblemMatcher) {
J
Johannes Rieken 已提交
1096
					localProblemMatcher = Objects.deepClone(localProblemMatcher);
1097 1098 1099 1100 1101
					// remove the name
					delete localProblemMatcher.name;
					return localProblemMatcher;
				}
			}
1102
			context.problemReporter.error(nls.localize('ConfigurationParser.invalidVaraibleReference', 'Error: Invalid problemMatcher reference: {0}\n', value));
1103 1104 1105
			return undefined;
		} else {
			let json = <ProblemMatcherConfig.ProblemMatcher>value;
1106
			return new ProblemMatcherParser(context.problemReporter).parse(json);
1107 1108 1109 1110
		}
	}
}

1111 1112 1113
const source: Tasks.TaskSource = {
	kind: Tasks.TaskSourceKind.Workspace,
	label: 'Workspace',
1114
	config: undefined
1115
};
1116

1117
namespace GroupKind {
1118
	export function from(this: void, external: string | GroupKind): [string, Tasks.GroupType] {
1119 1120 1121 1122 1123
		if (external === void 0) {
			return undefined;
		}
		if (Types.isString(external)) {
			if (Tasks.TaskGroup.is(external)) {
1124
				return [external, Tasks.GroupType.user];
1125
			} else {
D
Dirk Baeumer 已提交
1126 1127 1128
				return undefined;
			}
		}
1129 1130 1131 1132
		if (!Types.isString(external.kind) || !Tasks.TaskGroup.is(external.kind)) {
			return undefined;
		}
		let group: string = external.kind;
1133
		let isDefault: boolean = !!external.isDefault;
1134

1135
		return [group, isDefault ? Tasks.GroupType.default : Tasks.GroupType.user];
D
Dirk Baeumer 已提交
1136
	}
1137 1138
}

1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
namespace TaskDependency {
	export function from(this: void, external: string | TaskIdentifier, context: ParseContext): Tasks.TaskDependency {
		if (Types.isString(external)) {
			return { workspaceFolder: context.workspaceFolder, task: external };
		} else if (TaskIdentifier.is(external)) {
			return { workspaceFolder: context.workspaceFolder, task: TaskDefinition.createTaskIdentifier(external as Tasks.TaskIdentifier, context.problemReporter) };
		} else {
			return undefined;
		}
	}
}

1151
namespace ConfigurationProperties {
D
Dirk Baeumer 已提交
1152

1153
	const properties: MetaData<Tasks.ConfigurationProperties, any>[] = [
1154

1155 1156 1157 1158
		{ property: 'name' }, { property: 'identifier' }, { property: 'group' }, { property: 'isBackground' },
		{ property: 'promptOnClose' }, { property: 'dependsOn' },
		{ property: 'presentation', type: CommandConfiguration.PresentationOptions }, { property: 'problemMatchers' }
	];
1159

1160
	export function from(this: void, external: ConfigurationProperties, context: ParseContext, includeCommandOptions: boolean): Tasks.ConfigurationProperties {
1161
		if (!external) {
1162
			return undefined;
E
Erich Gamma 已提交
1163
		}
1164 1165 1166 1167
		let result: Tasks.ConfigurationProperties = {};
		if (Types.isString(external.taskName)) {
			result.name = external.taskName;
		}
1168 1169 1170
		if (Types.isString(external.label) && context.schemaVersion === Tasks.JsonSchemaVersion.V2_0_0) {
			result.name = external.label;
		}
1171 1172 1173 1174 1175 1176 1177 1178 1179
		if (Types.isString(external.identifier)) {
			result.identifier = external.identifier;
		}
		if (external.isBackground !== void 0) {
			result.isBackground = !!external.isBackground;
		}
		if (external.promptOnClose !== void 0) {
			result.promptOnClose = !!external.promptOnClose;
		}
D
Dirk Baeumer 已提交
1180 1181 1182
		if (external.group !== void 0) {
			if (Types.isString(external.group) && Tasks.TaskGroup.is(external.group)) {
				result.group = external.group;
1183
				result.groupType = Tasks.GroupType.user;
D
Dirk Baeumer 已提交
1184 1185 1186 1187
			} else {
				let values = GroupKind.from(external.group);
				if (values) {
					result.group = values[0];
1188
					result.groupType = values[1];
D
Dirk Baeumer 已提交
1189 1190
				}
			}
1191 1192
		}
		if (external.dependsOn !== void 0) {
1193 1194 1195
			if (Types.isArray(external.dependsOn)) {
				result.dependsOn = external.dependsOn.map(item => TaskDependency.from(item, context));
			} else {
1196
				result.dependsOn = [TaskDependency.from(external.dependsOn, context)];
1197
			}
1198
		}
1199
		if (includeCommandOptions && (external.presentation !== void 0 || (external as LegacyCommandProperties).terminal !== void 0)) {
1200 1201
			result.presentation = CommandConfiguration.PresentationOptions.from(external, context);
		}
1202 1203 1204
		if (includeCommandOptions && (external.options !== void 0)) {
			result.options = CommandOptions.from(external.options, context);
		}
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
		if (external.problemMatcher) {
			result.problemMatchers = ProblemMatcherConverter.from(external.problemMatcher, context);
		}
		return isEmpty(result) ? undefined : result;
	}

	export function isEmpty(this: void, value: Tasks.ConfigurationProperties): boolean {
		return _isEmpty(value, properties);
	}
}

namespace ConfiguringTask {

1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
	const grunt = 'grunt.';
	const jake = 'jake.';
	const gulp = 'gulp.';
	const npm = 'vscode.npm.';
	const typescript = 'vscode.typescript.';

	interface CustomizeShape {
		customize: string;
	}

1228
	export function from(this: void, external: ConfiguringTask, context: ParseContext, index: number): Tasks.ConfiguringTask {
1229 1230 1231 1232
		if (!external) {
			return undefined;
		}
		let type = external.type;
1233 1234
		let customize = (external as CustomizeShape).customize;
		if (!type && !customize) {
1235
			context.problemReporter.error(nls.localize('ConfigurationParser.noTaskType', 'Error: tasks configuration must have a type property. The configuration will be ignored.\n{0}\n', JSON.stringify(external, null, 4)));
1236 1237
			return undefined;
		}
D
Dirk Baeumer 已提交
1238
		let typeDeclaration = TaskDefinitionRegistry.get(type);
1239
		if (!typeDeclaration) {
1240
			let message = nls.localize('ConfigurationParser.noTypeDefinition', 'Error: there is no registered task type \'{0}\'. Did you miss to install an extension that provides a corresponding task provider?', type);
1241 1242 1243
			context.problemReporter.error(message);
			return undefined;
		}
1244
		let identifier: Tasks.TaskIdentifier;
1245 1246
		if (Types.isString(customize)) {
			if (customize.indexOf(grunt) === 0) {
1247
				identifier = { type: 'grunt', task: customize.substring(grunt.length) };
1248
			} else if (customize.indexOf(jake) === 0) {
1249
				identifier = { type: 'jake', task: customize.substring(jake.length) };
1250
			} else if (customize.indexOf(gulp) === 0) {
1251
				identifier = { type: 'gulp', task: customize.substring(gulp.length) };
1252
			} else if (customize.indexOf(npm) === 0) {
1253
				identifier = { type: 'npm', script: customize.substring(npm.length + 4) };
1254
			} else if (customize.indexOf(typescript) === 0) {
1255
				identifier = { type: 'typescript', tsconfig: customize.substring(typescript.length + 6) };
1256
			}
1257
		} else {
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
			if (Types.isString(external.type)) {
				identifier = external as Tasks.TaskIdentifier;
			}
		}
		if (identifier === void 0) {
			context.problemReporter.error(nls.localize(
				'ConfigurationParser.missingType',
				'Error: the task configuration \'{0}\' is missing the required property \'type\'. The task configuration will be ignored.', JSON.stringify(external, undefined, 0)
			));
			return undefined;
1268
		}
1269
		let taskIdentifier: Tasks.KeyedTaskIdentifier = TaskDefinition.createTaskIdentifier(identifier, context.problemReporter);
1270
		if (taskIdentifier === void 0) {
1271 1272
			context.problemReporter.error(nls.localize(
				'ConfigurationParser.incorrectType',
D
Dániel Tar 已提交
1273
				'Error: the task configuration \'{0}\' is using an unknown type. The task configuration will be ignored.', JSON.stringify(external, undefined, 0)
1274
			));
1275
			return undefined;
1276
		}
1277
		let configElement: Tasks.TaskSourceConfigElement = {
1278
			workspaceFolder: context.workspaceFolder,
1279 1280 1281 1282
			file: '.vscode\\tasks.json',
			index,
			element: external
		};
1283 1284 1285
		let result: Tasks.ConfiguringTask = {
			type: type,
			configures: taskIdentifier,
1286
			_id: `${typeDeclaration.extensionId}.${taskIdentifier._key}`,
1287
			_source: Objects.assign({}, source, { config: configElement }),
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
			_label: undefined
		};
		let configuration = ConfigurationProperties.from(external, context, true);
		if (configuration) {
			result = Objects.assign(result, configuration);
			if (result.name) {
				result._label = result.name;
			} else {
				let label = result.configures.type;
				if (typeDeclaration.required && typeDeclaration.required.length > 0) {
					for (let required of typeDeclaration.required) {
						let value = result.configures[required];
						if (value) {
							label = label + ' ' + value;
							break;
						}
					}
D
Dirk Baeumer 已提交
1305
				}
1306
				result._label = label;
1307
			}
1308 1309
			if (!result.identifier) {
				result.identifier = taskIdentifier._key;
E
Erich Gamma 已提交
1310
			}
1311 1312 1313 1314 1315 1316 1317
		}
		return result;
	}
}

namespace CustomTask {

1318
	export function from(this: void, external: CustomTask, context: ParseContext, index: number): Tasks.CustomTask {
1319 1320 1321 1322 1323 1324 1325 1326
		if (!external) {
			return undefined;
		}
		let type = external.type;
		if (type === void 0 || type === null) {
			type = 'custom';
		}
		if (type !== 'custom' && type !== 'shell' && type !== 'process') {
1327
			context.problemReporter.error(nls.localize('ConfigurationParser.notCustom', 'Error: tasks is not declared as a custom task. The configuration will be ignored.\n{0}\n', JSON.stringify(external, null, 4)));
1328 1329 1330
			return undefined;
		}
		let taskName = external.taskName;
1331 1332 1333
		if (Types.isString(external.label) && context.schemaVersion === Tasks.JsonSchemaVersion.V2_0_0) {
			taskName = external.label;
		}
1334
		if (!taskName) {
D
Dirk Baeumer 已提交
1335
			context.problemReporter.error(nls.localize('ConfigurationParser.noTaskName', 'Error: a task must provide a label property. The task will be ignored.\n{0}\n', JSON.stringify(external, null, 4)));
1336 1337 1338 1339 1340 1341
			return undefined;
		}

		let result: Tasks.CustomTask = {
			type: 'custom',
			_id: context.uuidMap.getUUID(taskName),
D
Dirk Baeumer 已提交
1342
			_source: Objects.assign({}, source, { config: { index, element: external, file: '.vscode\\tasks.json', workspaceFolder: context.workspaceFolder } }),
1343 1344 1345
			_label: taskName,
			name: taskName,
			identifier: taskName,
1346
			hasDefinedMatchers: false,
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
			command: undefined
		};
		let configuration = ConfigurationProperties.from(external, context, false);
		if (configuration) {
			result = Objects.assign(result, configuration);
		}
		let supportLegacy: boolean = true; //context.schemaVersion === Tasks.JsonSchemaVersion.V2_0_0;
		if (supportLegacy) {
			let legacy: LegacyTaskProperties = external as LegacyTaskProperties;
			if (result.isBackground === void 0 && legacy.isWatching !== void 0) {
				result.isBackground = !!legacy.isWatching;
1358
			}
1359 1360 1361 1362 1363
			if (result.group === void 0) {
				if (legacy.isBuildCommand === true) {
					result.group = Tasks.TaskGroup.Build;
				} else if (legacy.isTestCommand === true) {
					result.group = Tasks.TaskGroup.Test;
1364
				}
1365
			}
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
		}
		let command: Tasks.CommandConfiguration = CommandConfiguration.from(external, context);
		if (command) {
			result.command = command;
		}
		if (external.command !== void 0) {
			// if the task has its own command then we suppress the
			// task name by default.
			command.suppressTaskName = true;
		}
		return result;
	}

	export function fillGlobals(task: Tasks.CustomTask, globals: Globals): void {
		// We only merge a command from a global definition if there is no dependsOn
1381 1382
		// or there is a dependsOn and a defined command.
		if (CommandConfiguration.hasCommand(task.command) || task.dependsOn === void 0) {
1383 1384
			task.command = CommandConfiguration.fillGlobals(task.command, globals.command, task.name);
		}
1385 1386 1387 1388
		if (task.problemMatchers === void 0 && globals.problemMatcher !== void 0) {
			task.problemMatchers = Objects.deepClone(globals.problemMatcher);
			task.hasDefinedMatchers = true;
		}
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
		// promptOnClose is inferred from isBackground if available
		if (task.promptOnClose === void 0 && task.isBackground === void 0 && globals.promptOnClose !== void 0) {
			task.promptOnClose = globals.promptOnClose;
		}
	}

	export function fillDefaults(task: Tasks.CustomTask, context: ParseContext): void {
		CommandConfiguration.fillDefaults(task.command, context);
		if (task.promptOnClose === void 0) {
			task.promptOnClose = task.isBackground !== void 0 ? !task.isBackground : true;
		}
		if (task.isBackground === void 0) {
			task.isBackground = false;
		}
		if (task.problemMatchers === void 0) {
			task.problemMatchers = EMPTY_ARRAY;
		}
1406 1407
		if (task.group !== void 0 && task.groupType === void 0) {
			task.groupType = Tasks.GroupType.user;
1408
		}
1409 1410
	}

1411
	export function createCustomTask(contributedTask: Tasks.ContributedTask, configuredProps: Tasks.ConfigurationProperties & { _id: string, _source: Tasks.WorkspaceTaskSource }): Tasks.CustomTask {
1412
		let result: Tasks.CustomTask = {
1413
			_id: configuredProps._id,
1414
			_source: Objects.assign({}, configuredProps._source, { customizes: contributedTask.defines }),
1415 1416 1417 1418
			_label: configuredProps.name || contributedTask._label,
			type: 'custom',
			command: contributedTask.command,
			name: configuredProps.name || contributedTask.name,
1419 1420
			identifier: configuredProps.identifier || contributedTask.identifier,
			hasDefinedMatchers: false
1421 1422 1423 1424
		};
		let resultConfigProps: Tasks.ConfigurationProperties = result;

		assignProperty(resultConfigProps, configuredProps, 'group');
1425
		assignProperty(resultConfigProps, configuredProps, 'groupType');
1426 1427 1428 1429 1430 1431
		assignProperty(resultConfigProps, configuredProps, 'isBackground');
		assignProperty(resultConfigProps, configuredProps, 'dependsOn');
		assignProperty(resultConfigProps, configuredProps, 'problemMatchers');
		assignProperty(resultConfigProps, configuredProps, 'promptOnClose');
		result.command.presentation = CommandConfiguration.PresentationOptions.assignProperties(
			result.command.presentation, configuredProps.presentation);
1432
		result.command.options = CommandOptions.assignProperties(result.command.options, configuredProps.options);
1433 1434 1435

		let contributedConfigProps: Tasks.ConfigurationProperties = contributedTask;
		fillProperty(resultConfigProps, contributedConfigProps, 'group');
1436
		fillProperty(resultConfigProps, contributedConfigProps, 'groupType');
1437 1438 1439 1440 1441 1442
		fillProperty(resultConfigProps, contributedConfigProps, 'isBackground');
		fillProperty(resultConfigProps, contributedConfigProps, 'dependsOn');
		fillProperty(resultConfigProps, contributedConfigProps, 'problemMatchers');
		fillProperty(resultConfigProps, contributedConfigProps, 'promptOnClose');
		result.command.presentation = CommandConfiguration.PresentationOptions.fillProperties(
			result.command.presentation, contributedConfigProps.presentation);
1443
		result.command.options = CommandOptions.fillProperties(result.command.options, contributedConfigProps.options);
1444

1445 1446 1447 1448
		if (contributedTask.hasDefinedMatchers === true) {
			result.hasDefinedMatchers = true;
		}

1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461
		return result;
	}
}

interface TaskParseResult {
	custom: Tasks.CustomTask[];
	configured: Tasks.ConfiguringTask[];
}

namespace TaskParser {

	function isCustomTask(value: CustomTask | ConfiguringTask): value is CustomTask {
		let type = value.type;
1462 1463
		let customize = (value as any).customize;
		return customize === void 0 && (type === void 0 || type === null || type === 'custom' || type === 'shell' || type === 'process');
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
	}

	export function from(this: void, externals: (CustomTask | ConfiguringTask)[], globals: Globals, context: ParseContext): TaskParseResult {
		let result: TaskParseResult = { custom: [], configured: [] };
		if (!externals) {
			return result;
		}
		let defaultBuildTask: { task: Tasks.Task; rank: number; } = { task: undefined, rank: -1 };
		let defaultTestTask: { task: Tasks.Task; rank: number; } = { task: undefined, rank: -1 };
		let schema2_0_0: boolean = context.schemaVersion === Tasks.JsonSchemaVersion.V2_0_0;

1475 1476
		for (let index = 0; index < externals.length; index++) {
			let external = externals[index];
1477
			if (isCustomTask(external)) {
1478
				let customTask = CustomTask.from(external, context, index);
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
				if (customTask) {
					CustomTask.fillGlobals(customTask, globals);
					CustomTask.fillDefaults(customTask, context);
					if (schema2_0_0) {
						if ((customTask.command === void 0 || customTask.command.name === void 0) && (customTask.dependsOn === void 0 || customTask.dependsOn.length === 0)) {
							context.problemReporter.error(nls.localize(
								'taskConfiguration.noCommandOrDependsOn', 'Error: the task \'{0}\' neither specifies a command nor a dependsOn property. The task will be ignored. Its definition is:\n{1}',
								customTask.name, JSON.stringify(external, undefined, 4)
							));
							continue;
						}
					} else {
						if (customTask.command === void 0 || customTask.command.name === void 0) {
							context.problemReporter.warn(nls.localize(
								'taskConfiguration.noCommand', 'Error: the task \'{0}\' doesn\'t define a command. The task will be ignored. Its definition is:\n{1}',
								customTask.name, JSON.stringify(external, undefined, 4)
							));
							continue;
						}
					}
					if (customTask.group === Tasks.TaskGroup.Build && defaultBuildTask.rank < 2) {
						defaultBuildTask.task = customTask;
						defaultBuildTask.rank = 2;
					} else if (customTask.group === Tasks.TaskGroup.Test && defaultTestTask.rank < 2) {
						defaultTestTask.task = customTask;
						defaultTestTask.rank = 2;
					} else if (customTask.name === 'build' && defaultBuildTask.rank < 1) {
						defaultBuildTask.task = customTask;
						defaultBuildTask.rank = 1;
					} else if (customTask.name === 'test' && defaultTestTask.rank < 1) {
						defaultTestTask.task = customTask;
						defaultTestTask.rank = 1;
					}
					result.custom.push(customTask);
D
Dirk Baeumer 已提交
1513 1514
				}
			} else {
1515
				let configuredTask = ConfiguringTask.from(external, context, index);
1516 1517
				if (configuredTask) {
					result.configured.push(configuredTask);
D
Dirk Baeumer 已提交
1518
				}
E
Erich Gamma 已提交
1519
			}
1520
		}
1521
		if (defaultBuildTask.rank > -1 && defaultBuildTask.rank < 2) {
1522
			defaultBuildTask.task.group = Tasks.TaskGroup.Build;
1523
			defaultBuildTask.task.groupType = Tasks.GroupType.user;
1524
		} else if (defaultTestTask.rank > -1 && defaultTestTask.rank < 2) {
1525
			defaultTestTask.task.group = Tasks.TaskGroup.Test;
1526
			defaultTestTask.task.groupType = Tasks.GroupType.user;
E
Erich Gamma 已提交
1527
		}
1528 1529

		return result;
E
Erich Gamma 已提交
1530 1531
	}

1532
	export function assignTasks(target: Tasks.CustomTask[], source: Tasks.CustomTask[]): Tasks.CustomTask[] {
1533
		if (source === void 0 || source.length === 0) {
1534 1535
			return target;
		}
1536
		if (target === void 0 || target.length === 0) {
1537 1538 1539
			return source;
		}

1540
		if (source) {
1541
			// Tasks are keyed by ID but we need to merge by name
1542
			let map: IStringDictionary<Tasks.CustomTask> = Object.create(null);
1543 1544
			target.forEach((task) => {
				map[task.name] = task;
1545 1546
			});

1547 1548
			source.forEach((task) => {
				map[task.name] = task;
1549
			});
1550
			let newTarget: Tasks.CustomTask[] = [];
1551 1552 1553
			target.forEach(task => {
				newTarget.push(map[task.name]);
				delete map[task.name];
E
Erich Gamma 已提交
1554
			});
1555 1556
			Object.keys(map).forEach(key => newTarget.push(map[key]));
			target = newTarget;
E
Erich Gamma 已提交
1557
		}
1558 1559 1560 1561 1562
		return target;
	}
}

interface Globals {
1563
	command?: Tasks.CommandConfiguration;
1564
	problemMatcher?: ProblemMatcher[];
1565 1566 1567 1568 1569
	promptOnClose?: boolean;
	suppressTaskName?: boolean;
}

namespace Globals {
1570 1571 1572

	export function from(config: ExternalTaskRunnerConfiguration, context: ParseContext): Globals {
		let result = fromBase(config, context);
1573
		let osGlobals: Globals | undefined = undefined;
1574
		if (config.windows && context.platform === Platform.Windows) {
1575
			osGlobals = fromBase(config.windows, context);
1576
		} else if (config.osx && context.platform === Platform.Mac) {
1577
			osGlobals = fromBase(config.osx, context);
1578
		} else if (config.linux && context.platform === Platform.Linux) {
1579 1580 1581
			osGlobals = fromBase(config.linux, context);
		}
		if (osGlobals) {
1582
			result = Globals.assignProperties(result, osGlobals);
1583 1584 1585 1586 1587
		}
		let command = CommandConfiguration.from(config, context);
		if (command) {
			result.command = command;
		}
1588
		Globals.fillDefaults(result, context);
1589 1590 1591 1592 1593
		Globals.freeze(result);
		return result;
	}

	export function fromBase(this: void, config: BaseTaskRunnerConfiguration, context: ParseContext): Globals {
1594 1595 1596 1597 1598 1599 1600
		let result: Globals = {};
		if (config.suppressTaskName !== void 0) {
			result.suppressTaskName = !!config.suppressTaskName;
		}
		if (config.promptOnClose !== void 0) {
			result.promptOnClose = !!config.promptOnClose;
		}
1601 1602 1603
		if (config.problemMatcher) {
			result.problemMatcher = ProblemMatcherConverter.from(config.problemMatcher, context);
		}
E
Erich Gamma 已提交
1604 1605 1606
		return result;
	}

1607
	export function isEmpty(value: Globals): boolean {
D
Dirk Baeumer 已提交
1608
		return !value || value.command === void 0 && value.promptOnClose === void 0 && value.suppressTaskName === void 0;
1609 1610
	}

1611
	export function assignProperties(target: Globals, source: Globals): Globals {
1612 1613
		if (isEmpty(source)) {
			return target;
E
Erich Gamma 已提交
1614
		}
1615 1616 1617
		if (isEmpty(target)) {
			return source;
		}
1618 1619
		assignProperty(target, source, 'promptOnClose');
		assignProperty(target, source, 'suppressTaskName');
1620
		return target;
E
Erich Gamma 已提交
1621 1622
	}

1623
	export function fillDefaults(value: Globals, context: ParseContext): void {
1624 1625 1626
		if (!value) {
			return;
		}
1627
		CommandConfiguration.fillDefaults(value.command, context);
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643
		if (value.suppressTaskName === void 0) {
			value.suppressTaskName = false;
		}
		if (value.promptOnClose === void 0) {
			value.promptOnClose = true;
		}
	}

	export function freeze(value: Globals): void {
		Object.freeze(value);
		if (value.command) {
			CommandConfiguration.freeze(value.command);
		}
	}
}

1644 1645
export namespace ExecutionEngine {

1646
	export function from(config: ExternalTaskRunnerConfiguration): Tasks.ExecutionEngine {
1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666
		let runner = config.runner || config._runner;
		let result: Tasks.ExecutionEngine;
		if (runner) {
			switch (runner) {
				case 'terminal':
					result = Tasks.ExecutionEngine.Terminal;
					break;
				case 'process':
					result = Tasks.ExecutionEngine.Process;
					break;
			}
		}
		let schemaVersion = JsonSchemaVersion.from(config);
		if (schemaVersion === Tasks.JsonSchemaVersion.V0_1_0) {
			return result || Tasks.ExecutionEngine.Process;
		} else if (schemaVersion === Tasks.JsonSchemaVersion.V2_0_0) {
			return Tasks.ExecutionEngine.Terminal;
		} else {
			throw new Error('Shouldn\'t happen.');
		}
1667
	}
1668
}
1669

1670 1671
export namespace JsonSchemaVersion {

1672
	const _default: Tasks.JsonSchemaVersion = Tasks.JsonSchemaVersion.V2_0_0;
1673

1674 1675 1676
	export function from(config: ExternalTaskRunnerConfiguration): Tasks.JsonSchemaVersion {
		let version = config.version;
		if (!version) {
1677
			return _default;
1678 1679 1680 1681
		}
		switch (version) {
			case '0.1.0':
				return Tasks.JsonSchemaVersion.V0_1_0;
1682
			case '2.0.0':
1683
				return Tasks.JsonSchemaVersion.V2_0_0;
1684 1685
			default:
				return _default;
1686
		}
1687 1688 1689
	}
}

1690 1691
export interface ParseResult {
	validationStatus: ValidationStatus;
1692 1693
	custom: Tasks.CustomTask[];
	configured: Tasks.ConfiguringTask[];
1694
	engine: Tasks.ExecutionEngine;
1695 1696
}

1697
export interface IProblemReporter extends IProblemReporterBase {
1698 1699
}

1700 1701 1702 1703 1704
class UUIDMap {

	private last: IStringDictionary<string | string[]>;
	private current: IStringDictionary<string | string[]>;

1705
	constructor(other?: UUIDMap) {
1706
		this.current = Object.create(null);
1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
		if (other) {
			for (let key of Object.keys(other.current)) {
				let value = other.current[key];
				if (Array.isArray(value)) {
					this.current[key] = value.slice();
				} else {
					this.current[key] = value;
				}
			}
		}
1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760
	}

	public start(): void {
		this.last = this.current;
		this.current = Object.create(null);
	}

	public getUUID(identifier: string): string {
		let lastValue = this.last[identifier];
		let result: string;
		if (lastValue !== void 0) {
			if (Array.isArray(lastValue)) {
				result = lastValue.shift();
				if (lastValue.length === 0) {
					delete this.last[identifier];
				}
			} else {
				result = lastValue;
				delete this.last[identifier];
			}
		}
		if (result === void 0) {
			result = UUID.generateUuid();
		}
		let currentValue = this.current[identifier];
		if (currentValue === void 0) {
			this.current[identifier] = result;
		} else {
			if (Array.isArray(currentValue)) {
				currentValue.push(result);
			} else {
				let arrayValue: string[] = [currentValue];
				arrayValue.push(result);
				this.current[identifier] = arrayValue;
			}
		}
		return result;
	}

	public finish(): void {
		this.last = undefined;
	}
}

1761 1762
class ConfigurationParser {

S
Sandeep Somavarapu 已提交
1763
	private workspaceFolder: IWorkspaceFolder;
1764
	private problemReporter: IProblemReporter;
1765
	private uuidMap: UUIDMap;
1766
	private platform: Platform;
1767

1768
	constructor(workspaceFolder: IWorkspaceFolder, platform: Platform, problemReporter: IProblemReporter, uuidMap: UUIDMap) {
1769
		this.workspaceFolder = workspaceFolder;
1770
		this.platform = platform;
1771
		this.problemReporter = problemReporter;
1772
		this.uuidMap = uuidMap;
1773 1774 1775
	}

	public run(fileConfig: ExternalTaskRunnerConfiguration): ParseResult {
1776
		let engine = ExecutionEngine.from(fileConfig);
1777
		let schemaVersion = JsonSchemaVersion.from(fileConfig);
1778
		let context: ParseContext = {
1779
			workspaceFolder: this.workspaceFolder,
1780
			problemReporter: this.problemReporter,
1781
			uuidMap: this.uuidMap,
1782
			namedProblemMatchers: undefined,
1783
			engine,
1784 1785
			schemaVersion,
			platform: this.platform
1786 1787
		};
		let taskParseResult = this.createTaskRunnerConfiguration(fileConfig, context);
1788
		return {
1789
			validationStatus: this.problemReporter.status,
1790 1791
			custom: taskParseResult.custom,
			configured: taskParseResult.configured,
1792
			engine
1793 1794 1795
		};
	}

1796
	private createTaskRunnerConfiguration(fileConfig: ExternalTaskRunnerConfiguration, context: ParseContext): TaskParseResult {
1797
		let globals = Globals.from(fileConfig, context);
1798
		if (this.problemReporter.status.isFatal()) {
1799
			return { custom: [], configured: [] };
1800 1801
		}
		context.namedProblemMatchers = ProblemMatcherConverter.namedFrom(fileConfig.declares, context);
1802
		let globalTasks: Tasks.CustomTask[];
1803
		let externalGlobalTasks: (ConfiguringTask | CustomTask)[];
1804
		if (fileConfig.windows && context.platform === Platform.Windows) {
1805
			globalTasks = TaskParser.from(fileConfig.windows.tasks, globals, context).custom;
1806
			externalGlobalTasks = fileConfig.windows.tasks;
1807
		} else if (fileConfig.osx && context.platform === Platform.Mac) {
1808
			globalTasks = TaskParser.from(fileConfig.osx.tasks, globals, context).custom;
1809
			externalGlobalTasks = fileConfig.osx.tasks;
1810
		} else if (fileConfig.linux && context.platform === Platform.Linux) {
1811
			globalTasks = TaskParser.from(fileConfig.linux.tasks, globals, context).custom;
1812 1813 1814 1815 1816 1817 1818 1819 1820 1821
			externalGlobalTasks = fileConfig.linux.tasks;
		}
		if (context.schemaVersion === Tasks.JsonSchemaVersion.V2_0_0 && globalTasks && globalTasks.length > 0 && externalGlobalTasks && externalGlobalTasks.length > 0) {
			let taskContent: string[] = [];
			for (let task of externalGlobalTasks) {
				taskContent.push(JSON.stringify(task, null, 4));
			}
			context.problemReporter.error(
				nls.localize(
					'TaskParse.noOsSpecificGlobalTasks',
1822
					'Task version 2.0.0 doesn\'t support global OS specific tasks. Convert them to a task with a OS specific command. Affected tasks are:\n{0}', taskContent.join('\n'))
1823
			);
1824 1825
		}

1826
		let result: TaskParseResult = { custom: undefined, configured: undefined };
1827
		if (fileConfig.tasks) {
1828
			result = TaskParser.from(fileConfig.tasks, globals, context);
1829
		}
1830
		if (globalTasks) {
1831
			result.custom = TaskParser.assignTasks(result.custom, globalTasks);
1832 1833
		}

1834
		if ((!result.custom || result.custom.length === 0) && (globals.command && globals.command.name)) {
1835
			let matchers: ProblemMatcher[] = ProblemMatcherConverter.from(fileConfig.problemMatcher, context);
1836
			let isBackground = fileConfig.isBackground ? !!fileConfig.isBackground : fileConfig.isWatching ? !!fileConfig.isWatching : undefined;
1837
			let name = Tasks.CommandString.value(globals.command.name);
1838
			let task: Tasks.CustomTask = {
1839
				_id: context.uuidMap.getUUID(name),
D
Dirk Baeumer 已提交
1840
				_source: Objects.assign({}, source, { config: { index: -1, element: fileConfig, workspaceFolder: context.workspaceFolder } }),
1841
				_label: name,
1842
				type: 'custom',
1843 1844
				name: name,
				identifier: name,
1845
				group: Tasks.TaskGroup.Build,
1846 1847
				command: {
					name: undefined,
1848
					runtime: undefined,
1849
					presentation: undefined,
1850 1851
					suppressTaskName: true
				},
1852
				isBackground: isBackground,
1853 1854
				problemMatchers: matchers,
				hasDefinedMatchers: false,
1855
			};
1856 1857 1858
			let value = GroupKind.from(fileConfig.group);
			if (value) {
				task.group = value[0];
1859
				task.groupType = value[1];
1860 1861 1862
			} else if (fileConfig.group === 'none') {
				task.group = undefined;
			}
1863 1864 1865
			CustomTask.fillGlobals(task, globals);
			CustomTask.fillDefaults(task, context);
			result.custom = [task];
1866
		}
1867 1868
		result.custom = result.custom || [];
		result.configured = result.configured || [];
1869
		return result;
1870
	}
E
Erich Gamma 已提交
1871 1872
}

1873
let uuidMaps: Map<string, UUIDMap> = new Map();
1874
export function parse(workspaceFolder: IWorkspaceFolder, platform: Platform, configuration: ExternalTaskRunnerConfiguration, logger: IProblemReporter): ParseResult {
1875 1876 1877 1878 1879
	let uuidMap = uuidMaps.get(workspaceFolder.uri.toString());
	if (!uuidMap) {
		uuidMap = new UUIDMap();
		uuidMaps.set(workspaceFolder.uri.toString(), uuidMap);
	}
1880 1881
	try {
		uuidMap.start();
1882
		return (new ConfigurationParser(workspaceFolder, platform, logger, uuidMap)).run(configuration);
1883 1884 1885
	} finally {
		uuidMap.finish();
	}
1886 1887
}

1888
export function createCustomTask(contributedTask: Tasks.ContributedTask, configuredProps: Tasks.ConfigurationProperties & { _id: string; _source: Tasks.WorkspaceTaskSource }): Tasks.CustomTask {
1889 1890 1891
	return CustomTask.createCustomTask(contributedTask, configuredProps);
}

D
Dirk Baeumer 已提交
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 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967
/*
class VersionConverter {
	constructor(private problemReporter: IProblemReporter) {
	}

	public convert(fromConfig: ExternalTaskRunnerConfiguration): ExternalTaskRunnerConfiguration {
		let result: ExternalTaskRunnerConfiguration;
		result.version = '2.0.0';
		if (Array.isArray(fromConfig.tasks)) {

		} else {
			result.tasks = [];
		}


		return result;
	}

	private convertGlobalTask(fromConfig: ExternalTaskRunnerConfiguration): TaskDescription {
		let command: string = this.getGlobalCommand(fromConfig);
		if (!command) {
			this.problemReporter.error(nls.localize('Converter.noGlobalName', 'No global command specified. Can\'t convert to 2.0.0 version.'));
			return undefined;
		}
		let result: TaskDescription = {
			taskName: command
		};
		if (fromConfig.isShellCommand) {
			result.type = 'shell';
		} else {
			result.type = 'process';
			result.args = fromConfig.args;
		}
		if (fromConfig.)

		return result;
	}

	private getGlobalCommand(fromConfig: ExternalTaskRunnerConfiguration): string {
		if (fromConfig.command) {
			return fromConfig.command;
		} else if (fromConfig.windows && fromConfig.windows.command) {
			return fromConfig.windows.command;
		} else if (fromConfig.osx && fromConfig.osx.command) {
			return fromConfig.osx.command;
		} else if (fromConfig.linux && fromConfig.linux.command) {
			return fromConfig.linux.command;
		} else {
			return undefined;
		}
	}

	private createCommandLine(command: string, args: string[], isWindows: boolean): string {
		let result: string[];
		let commandHasSpace = false;
		let argHasSpace = false;
		if (TaskDescription.hasUnescapedSpaces(command)) {
			result.push(`"${command}"`);
			commandHasSpace = true;
		} else {
			result.push(command);
		}
		if (args) {
			for (let arg of args) {
				if (TaskDescription.hasUnescapedSpaces(arg)) {
					result.push(`"${arg}"`);
					argHasSpace= true;
				} else {
					result.push(arg);
				}
			}
		}
		return result.join(' ');
	}

}
J
Johannes Rieken 已提交
1968
*/