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

7 8
import * as crypto from 'crypto';

9
import * as nls from 'vs/nls';
E
Erich Gamma 已提交
10 11 12

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

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

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

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

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 64
export enum ShellQuoting {
	/**
	 * 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 已提交
65 66 67
export interface ShellConfiguration {
	executable: string;
	args?: string[];
68
	quoting?: ShellQuotingOptions;
D
Dirk Baeumer 已提交
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
}

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;
}

90 91 92 93 94 95
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 已提交
96 97

	/**
98 99 100 101 102 103 104 105 106 107 108
	 * 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 已提交
109
	 */
110 111 112 113
	panel?: string;
}

export interface TaskIdentifier {
D
Dirk Baeumer 已提交
114
	type?: string;
115
}
D
Dirk Baeumer 已提交
116

117
export interface LegacyTaskProperties {
E
Erich Gamma 已提交
118
	/**
119 120
	 * @deprecated Use `isBackground` instead.
	 * Whether the executed command is kept alive and is watching the file system.
121
	 */
122 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
	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;

157 158 159 160 161
	/**
	 * @deprecated Use presentation instead
	 */
	terminal?: PresentationOptions;

162 163 164 165 166 167 168 169 170 171 172 173
	/**
	 * @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;
174 175

	/**
D
Dirk Baeumer 已提交
176
	 * @deprecated use the task type instead.
177 178 179 180 181
	 * 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 已提交
182
	isShellCommand?: boolean | ShellConfiguration;
183 184
}

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

187 188 189 190
export namespace CommandString {
	export function value(value: CommandString): string {
		if (Types.isString(value)) {
			return value;
191 192
		} else if (Types.isStringArray(value)) {
			return value.join(' ');
193
		} else {
194 195 196 197 198
			if (Types.isString(value.value)) {
				return value.value;
			} else {
				return value.value.join(' ');
			}
199 200 201 202 203
		}
	}
}

export interface BaseCommandProperties {
204 205 206 207 208

	/**
	 * The command to be executed. Can be an external program or a shell
	 * command.
	 */
209
	command?: CommandString;
210 211 212 213

	/**
	 * The command options used when the command is executed. Can be omitted.
	 */
D
Dirk Baeumer 已提交
214
	options?: CommandOptions;
215 216 217 218

	/**
	 * The arguments passed to the command or additional arguments passed to the
	 * command when using a global command.
E
Erich Gamma 已提交
219
	 */
220
	args?: CommandString[];
221 222 223
}


224
export interface CommandProperties extends BaseCommandProperties {
D
Dirk Baeumer 已提交
225

226
	/**
227
	 * Windows specific command properties
228
	 */
229
	windows?: BaseCommandProperties;
230

231
	/**
232
	 * OSX specific command properties
233
	 */
234
	osx?: BaseCommandProperties;
235 236

	/**
237
	 * linux specific command properties
238
	 */
239 240
	linux?: BaseCommandProperties;
}
241

D
Dirk Baeumer 已提交
242 243
export interface GroupKind {
	kind?: string;
244
	isDefault?: boolean;
D
Dirk Baeumer 已提交
245 246
}

247
export interface ConfigurationProperties {
248
	/**
249
	 * The task's name
250
	 */
251
	taskName?: string;
E
Erich Gamma 已提交
252

253 254 255 256 257
	/**
	 * The UI label used for the task.
	 */
	label?: string;

E
Erich Gamma 已提交
258
	/**
259 260
	 * An optional indentifier which can be used to reference a task
	 * in a dependsOn or other attributes.
E
Erich Gamma 已提交
261
	 */
262
	identifier?: string;
E
Erich Gamma 已提交
263

264 265 266 267 268
	/**
	 * Whether the executed command is kept alive and runs in the background.
	 */
	isBackground?: boolean;

D
Dirk Baeumer 已提交
269 270 271 272 273
	/**
	 * Whether the task should prompt on close for confirmation if running.
	 */
	promptOnClose?: boolean;

E
Erich Gamma 已提交
274
	/**
275 276
	 * Defines the group the task belongs too.
	 */
D
Dirk Baeumer 已提交
277
	group?: string | GroupKind;
278 279

	/**
280
	 * The other tasks the task depend on
E
Erich Gamma 已提交
281
	 */
282
	dependsOn?: string | string[];
E
Erich Gamma 已提交
283 284

	/**
285
	 * Controls the behavior of the used terminal
E
Erich Gamma 已提交
286
	 */
287
	presentation?: PresentationOptions;
E
Erich Gamma 已提交
288

289 290 291 292 293
	/**
	 * Controls shell options.
	 */
	options?: CommandOptions;

E
Erich Gamma 已提交
294
	/**
295 296
	 * The problem matcher(s) to use to capture problems in the tasks
	 * output.
E
Erich Gamma 已提交
297
	 */
298
	problemMatcher?: ProblemMatcherConfig.ProblemMatcherType;
299 300 301 302 303

	/**
	 * Whether to show the `Terminal will be reused by tasks, press any key to close it` message.
	 */
	showTerminalReuseAlert?: boolean;
304
}
E
Erich Gamma 已提交
305

306
export interface CustomTask extends CommandProperties, ConfigurationProperties {
E
Erich Gamma 已提交
307
	/**
308
	 * Custom tasks have the type 'custom'
E
Erich Gamma 已提交
309
	 */
310
	type?: string;
E
Erich Gamma 已提交
311

312
}
313

314
export interface ConfiguringTask extends ConfigurationProperties {
E
Erich Gamma 已提交
315
	/**
316
	 * The contributed type of the task
E
Erich Gamma 已提交
317
	 */
318
	type?: string;
E
Erich Gamma 已提交
319 320 321 322 323
}

/**
 * The base task runner configuration
 */
324
export interface BaseTaskRunnerConfiguration {
E
Erich Gamma 已提交
325 326 327 328 329

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

	/**
333 334
	 * @deprecated Use type instead
	 *
E
Erich Gamma 已提交
335 336 337 338 339 340 341
	 * 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;

342 343 344 345 346
	/**
	 * The task type
	 */
	type?: string;

E
Erich Gamma 已提交
347 348 349
	/**
	 * The command options used when the command is executed. Can be omitted.
	 */
D
Dirk Baeumer 已提交
350
	options?: CommandOptions;
E
Erich Gamma 已提交
351 352 353 354

	/**
	 * The arguments passed to the command. Can be omitted.
	 */
355
	args?: CommandString[];
E
Erich Gamma 已提交
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372

	/**
	 * 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;

373 374 375 376
	/**
	 * The group
	 */
	group?: string | GroupKind;
D
Dirk Baeumer 已提交
377 378 379
	/**
	 * Controls the behavior of the used terminal
	 */
380
	presentation?: PresentationOptions;
D
Dirk Baeumer 已提交
381

E
Erich Gamma 已提交
382 383 384 385 386 387 388 389 390 391 392 393
	/**
	 * 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 已提交
394
	taskSelector?: string;
E
Erich Gamma 已提交
395 396 397 398 399 400 401 402 403

	/**
	 * 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;

	/**
404 405
	 * @deprecated Use `isBackground` instead.
	 *
E
Erich Gamma 已提交
406
	 * Specifies whether a global command is a watching the filesystem. A task.json
407
	 * file can either contain a global isWatching property or a tasks property
E
Erich Gamma 已提交
408 409 410 411
	 * but not both.
	 */
	isWatching?: boolean;

412 413 414 415 416
	/**
	 * Specifies whether a global command is a background task.
	 */
	isBackground?: boolean;

D
Dirk Baeumer 已提交
417 418 419 420 421
	/**
	 * Whether the task should prompt on close for confirmation if running.
	 */
	promptOnClose?: boolean;

E
Erich Gamma 已提交
422 423 424 425
	/**
	 * The configuration of the available tasks. A tasks.json file can either
	 * contain a global problemMatcher property or a tasks property but not both.
	 */
426
	tasks?: (CustomTask | ConfiguringTask)[];
E
Erich Gamma 已提交
427 428 429 430 431

	/**
	 * Problem matcher declarations
	 */
	declares?: ProblemMatcherConfig.NamedProblemMatcher[];
432 433 434 435 436 437

	/**
	 * Controls whether the message `Terminal will be reused by tasks, press any key to close it` is shown or not.
	 * If omitted true is used.
	 */
	showTerminalReuseAlert?: boolean;
E
Erich Gamma 已提交
438 439 440 441 442 443 444 445
}

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

446 447
	_runner?: string;

448 449 450 451 452
	/**
	 * Determines the runner to use
	 */
	runner?: string;

E
Erich Gamma 已提交
453 454 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
	/**
	 * 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
}

481 482
const EMPTY_ARRAY: any[] = [];
Object.freeze(EMPTY_ARRAY);
E
Erich Gamma 已提交
483

484
function assignProperty<T, K extends keyof T>(target: T, source: Partial<T>, key: K) {
485 486 487
	if (source[key] !== void 0) {
		target[key] = source[key];
	}
E
Erich Gamma 已提交
488 489
}

490
function fillProperty<T, K extends keyof T>(target: T, source: Partial<T>, key: K) {
491 492 493 494 495 496
	if (target[key] === void 0 && source[key] !== void 0) {
		target[key] = source[key];
	}
}


497 498 499 500 501 502 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
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]);
562
		} else if (target[property] === void 0) {
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
			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 已提交
578
			return Objects.deepClone(defaults);
579 580 581 582 583 584 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
		} 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;
}

621
interface ParseContext {
S
Sandeep Somavarapu 已提交
622
	workspaceFolder: IWorkspaceFolder;
623
	problemReporter: IProblemReporter;
624
	namedProblemMatchers: IStringDictionary<NamedProblemMatcher>;
625
	uuidMap: UUIDMap;
626 627
	engine: Tasks.ExecutionEngine;
	schemaVersion: Tasks.JsonSchemaVersion;
628
	platform: Platform;
E
Erich Gamma 已提交
629 630
}

631

632
namespace ShellConfiguration {
633

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

636 637 638 639 640 641 642 643 644 645 646 647 648
	export function is(value: any): value is ShellConfiguration {
		let candidate: ShellConfiguration = value;
		return candidate && Types.isString(candidate.executable) && (candidate.args === void 0 || Types.isStringArray(candidate.args));
	}

	export function from(this: void, config: ShellConfiguration, context: ParseContext): Tasks.ShellConfiguration {
		if (!is(config)) {
			return undefined;
		}
		let result: ShellConfiguration = { executable: config.executable };
		if (config.args !== void 0) {
			result.args = config.args.slice();
		}
649 650 651 652
		if (config.quoting !== void 0) {
			result.quoting = Objects.deepClone(config.quoting);
		}

653 654 655
		return result;
	}

656 657
	export function isEmpty(this: void, value: Tasks.ShellConfiguration): boolean {
		return _isEmpty(value, properties);
658 659
	}

660 661
	export function assignProperties(this: void, target: Tasks.ShellConfiguration, source: Tasks.ShellConfiguration): Tasks.ShellConfiguration {
		return _assignProperties(target, source, properties);
662 663
	}

664 665
	export function fillProperties(this: void, target: Tasks.ShellConfiguration, source: Tasks.ShellConfiguration): Tasks.ShellConfiguration {
		return _fillProperties(target, source, properties);
666 667
	}

668 669
	export function fillDefaults(this: void, value: Tasks.ShellConfiguration, context: ParseContext): Tasks.ShellConfiguration {
		return value;
670 671
	}

672
	export function freeze(this: void, value: Tasks.ShellConfiguration): Readonly<Tasks.ShellConfiguration> {
673
		if (!value) {
674
			return undefined;
675
		}
676
		return Object.freeze(value);
677 678 679
	}
}

680
namespace CommandOptions {
681 682

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

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

701
	export function isEmpty(value: Tasks.CommandOptions): boolean {
702
		return _isEmpty(value, properties);
E
Erich Gamma 已提交
703 704
	}

705
	export function assignProperties(target: Tasks.CommandOptions, source: Tasks.CommandOptions): Tasks.CommandOptions {
706 707
		if (isEmpty(source)) {
			return target;
E
Erich Gamma 已提交
708
		}
709 710
		if (isEmpty(target)) {
			return source;
E
Erich Gamma 已提交
711
		}
712
		assignProperty(target, source, 'cwd');
713 714 715 716 717
		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]);
718
			Object.keys(source.env).forEach(key => env[key] = source.env[key]);
719 720
			target.env = env;
		}
721 722 723 724 725
		target.shell = ShellConfiguration.assignProperties(target.shell, source.shell);
		return target;
	}

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

729 730
	export function fillDefaults(value: Tasks.CommandOptions, context: ParseContext): Tasks.CommandOptions {
		return _fillDefaults(value, defaults, properties, context);
731 732
	}

733 734
	export function freeze(value: Tasks.CommandOptions): Readonly<Tasks.CommandOptions> {
		return _freeze(value, properties);
E
Erich Gamma 已提交
735
	}
736
}
E
Erich Gamma 已提交
737

738
namespace CommandConfiguration {
739

740 741
	export namespace PresentationOptions {
		const properties: MetaData<Tasks.PresentationOptions, void>[] = [{ property: 'echo' }, { property: 'reveal' }, { property: 'focus' }, { property: 'panel' }];
742

743 744 745 746 747
		interface PresentationOptionsShape extends LegacyCommandProperties {
			presentation?: PresentationOptions;
		}

		export function from(this: void, config: PresentationOptionsShape, context: ParseContext): Tasks.PresentationOptions {
748 749 750
			let echo: boolean;
			let reveal: Tasks.RevealKind;
			let focus: boolean;
751
			let panel: Tasks.PanelKind;
D
Dirk Baeumer 已提交
752 753 754 755 756 757
			if (Types.isBoolean(config.echoCommand)) {
				echo = config.echoCommand;
			}
			if (Types.isString(config.showOutput)) {
				reveal = Tasks.RevealKind.fromString(config.showOutput);
			}
758 759 760 761
			let presentation = config.presentation || config.terminal;
			if (presentation) {
				if (Types.isBoolean(presentation.echo)) {
					echo = presentation.echo;
D
Dirk Baeumer 已提交
762
				}
763 764
				if (Types.isString(presentation.reveal)) {
					reveal = Tasks.RevealKind.fromString(presentation.reveal);
D
Dirk Baeumer 已提交
765
				}
766 767
				if (Types.isBoolean(presentation.focus)) {
					focus = presentation.focus;
768
				}
769 770
				if (Types.isString(presentation.panel)) {
					panel = Tasks.PanelKind.fromString(presentation.panel);
771
				}
D
Dirk Baeumer 已提交
772
			}
773
			if (echo === void 0 && reveal === void 0 && focus === void 0 && panel === void 0) {
D
Dirk Baeumer 已提交
774 775
				return undefined;
			}
776
			return { echo, reveal, focus, panel };
D
Dirk Baeumer 已提交
777 778
		}

779
		export function assignProperties(target: Tasks.PresentationOptions, source: Tasks.PresentationOptions): Tasks.PresentationOptions {
780
			return _assignProperties(target, source, properties);
781 782
		}

783
		export function fillProperties(target: Tasks.PresentationOptions, source: Tasks.PresentationOptions): Tasks.PresentationOptions {
784
			return _fillProperties(target, source, properties);
D
Dirk Baeumer 已提交
785 786
		}

787
		export function fillDefaults(value: Tasks.PresentationOptions, context: ParseContext): Tasks.PresentationOptions {
788
			let defaultEcho = context.engine === Tasks.ExecutionEngine.Terminal ? true : false;
789
			return _fillDefaults(value, { echo: defaultEcho, reveal: Tasks.RevealKind.Always, focus: false, panel: Tasks.PanelKind.Shared }, properties, context);
D
Dirk Baeumer 已提交
790 791
		}

792
		export function freeze(value: Tasks.PresentationOptions): Readonly<Tasks.PresentationOptions> {
793
			return _freeze(value, properties);
D
Dirk Baeumer 已提交
794 795
		}

796
		export function isEmpty(this: void, value: Tasks.PresentationOptions): boolean {
797
			return _isEmpty(value, properties);
D
Dirk Baeumer 已提交
798 799 800
		}
	}

801 802 803 804 805 806 807
	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;
808 809 810 811 812 813 814 815 816 817 818 819 820
			} 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;
				}
821 822 823 824
			}
		}
	}

825 826 827 828 829 830 831 832 833 834 835
	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 },
836
		{ property: 'args' }, { property: 'taskSelector' }, { property: 'suppressTaskName' },
837
		{ property: 'presentation', type: PresentationOptions }
838 839
	];

840 841
	export function from(this: void, config: CommandConfiguationShape, context: ParseContext): Tasks.CommandConfiguration {
		let result: Tasks.CommandConfiguration = fromBase(config, context);
842

843
		let osConfig: Tasks.CommandConfiguration = undefined;
844
		if (config.windows && context.platform === Platform.Windows) {
845
			osConfig = fromBase(config.windows, context);
846
		} else if (config.osx && context.platform === Platform.Mac) {
847
			osConfig = fromBase(config.osx, context);
848
		} else if (config.linux && context.platform === Platform.Linux) {
849 850 851
			osConfig = fromBase(config.linux, context);
		}
		if (osConfig) {
852
			result = assignProperties(result, osConfig);
853 854 855 856
		}
		return isEmpty(result) ? undefined : result;
	}

857 858 859
	function fromBase(this: void, config: BaseCommandConfiguationShape, context: ParseContext): Tasks.CommandConfiguration {
		let result: Tasks.CommandConfiguration = {
			name: undefined,
860
			runtime: undefined,
861
			presentation: undefined
862
		};
863 864

		result.name = ShellString.from(config.command);
D
Dirk Baeumer 已提交
865
		if (Types.isString(config.type)) {
866 867 868
			if (config.type === 'shell' || config.type === 'process') {
				result.runtime = Tasks.RuntimeType.fromString(config.type);
			}
D
Dirk Baeumer 已提交
869 870 871
		}
		let isShellConfiguration = ShellConfiguration.is(config.isShellCommand);
		if (Types.isBoolean(config.isShellCommand) || isShellConfiguration) {
872
			result.runtime = Tasks.RuntimeType.Shell;
873
		} else if (config.isShellCommand !== void 0) {
874 875
			result.runtime = !!config.isShellCommand ? Tasks.RuntimeType.Shell : Tasks.RuntimeType.Process;
		}
876

877
		if (config.args !== void 0) {
878 879 880
			result.args = [];
			for (let arg of config.args) {
				let converted = ShellString.from(arg);
D
Dirk Baeumer 已提交
881
				if (converted !== void 0) {
882 883 884 885
					result.args.push(converted);
				} else {
					context.problemReporter.error(nls.localize('ConfigurationParser.inValidArg', 'Error: command argument must either be a string or a quoted string. Provided value is:\n{0}', context.problemReporter.error(nls.localize('ConfigurationParser.noargs', 'Error: command arguments must be an array of strings. Provided value is:\n{0}', arg ? JSON.stringify(arg, undefined, 4) : 'undefined'))));
				}
886
			}
E
Erich Gamma 已提交
887
		}
888 889
		if (config.options !== void 0) {
			result.options = CommandOptions.from(config.options, context);
D
Dirk Baeumer 已提交
890 891
			if (result.options && result.options.shell === void 0 && isShellConfiguration) {
				result.options.shell = ShellConfiguration.from(config.isShellCommand as ShellConfiguration, context);
892
				if (context.engine !== Tasks.ExecutionEngine.Terminal) {
D
Dirk Baeumer 已提交
893 894 895
					context.problemReporter.warn(nls.localize('ConfigurationParser.noShell', 'Warning: shell configuration is only supported when executing tasks in the terminal.'));
				}
			}
E
Erich Gamma 已提交
896
		}
897 898 899
		let panel = PresentationOptions.from(config, context);
		if (panel) {
			result.presentation = panel;
E
Erich Gamma 已提交
900
		}
901 902
		if (Types.isString(config.taskSelector)) {
			result.taskSelector = config.taskSelector;
E
Erich Gamma 已提交
903
		}
904 905 906
		if (Types.isBoolean(config.suppressTaskName)) {
			result.suppressTaskName = config.suppressTaskName;
		}
907
		return isEmpty(result) ? undefined : result;
E
Erich Gamma 已提交
908 909
	}

910 911 912 913
	export function hasCommand(value: Tasks.CommandConfiguration): boolean {
		return value && !!value.name;
	}

914
	export function isEmpty(value: Tasks.CommandConfiguration): boolean {
915
		return _isEmpty(value, properties);
916 917
	}

918
	export function assignProperties(target: Tasks.CommandConfiguration, source: Tasks.CommandConfiguration): Tasks.CommandConfiguration {
919 920
		if (isEmpty(source)) {
			return target;
E
Erich Gamma 已提交
921
		}
922 923
		if (isEmpty(target)) {
			return source;
E
Erich Gamma 已提交
924
		}
925
		assignProperty(target, source, 'name');
926
		assignProperty(target, source, 'runtime');
927 928
		assignProperty(target, source, 'taskSelector');
		assignProperty(target, source, 'suppressTaskName');
929 930 931 932 933
		if (source.args !== void 0) {
			if (target.args === void 0) {
				target.args = source.args;
			} else {
				target.args = target.args.concat(source.args);
E
Erich Gamma 已提交
934 935
			}
		}
936
		target.presentation = PresentationOptions.assignProperties(target.presentation, source.presentation);
937 938 939 940
		target.options = CommandOptions.assignProperties(target.options, source.options);
		return target;
	}

941 942 943 944
	export function fillProperties(target: Tasks.CommandConfiguration, source: Tasks.CommandConfiguration): Tasks.CommandConfiguration {
		return _fillProperties(target, source, properties);
	}

945 946 947 948 949 950
	export function fillGlobals(target: Tasks.CommandConfiguration, source: Tasks.CommandConfiguration, taskName: string): Tasks.CommandConfiguration {
		if (isEmpty(source)) {
			return target;
		}
		target = target || {
			name: undefined,
951
			runtime: undefined,
952
			presentation: undefined
953
		};
954 955 956 957
		if (target.name === void 0) {
			fillProperty(target, source, 'name');
			fillProperty(target, source, 'taskSelector');
			fillProperty(target, source, 'suppressTaskName');
958
			let args: Tasks.CommandString[] = source.args ? source.args.slice() : [];
959 960 961 962 963 964 965 966 967 968 969 970
			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;
		}
971
		fillProperty(target, source, 'runtime');
972

973
		target.presentation = PresentationOptions.fillProperties(target.presentation, source.presentation);
974 975
		target.options = CommandOptions.fillProperties(target.options, source.options);

976
		return target;
E
Erich Gamma 已提交
977 978
	}

979
	export function fillDefaults(value: Tasks.CommandConfiguration, context: ParseContext): void {
980 981 982
		if (!value || Object.isFrozen(value)) {
			return;
		}
983 984
		if (value.name !== void 0 && value.runtime === void 0) {
			value.runtime = Tasks.RuntimeType.Process;
985
		}
986
		value.presentation = PresentationOptions.fillDefaults(value.presentation, context);
987
		if (!isEmpty(value)) {
988
			value.options = CommandOptions.fillDefaults(value.options, context);
989
		}
990 991 992
		if (value.args === void 0) {
			value.args = EMPTY_ARRAY;
		}
993 994
		if (value.suppressTaskName === void 0) {
			value.suppressTaskName = false;
E
Erich Gamma 已提交
995 996 997
		}
	}

998 999
	export function freeze(value: Tasks.CommandConfiguration): Readonly<Tasks.CommandConfiguration> {
		return _freeze(value, properties);
E
Erich Gamma 已提交
1000
	}
1001
}
E
Erich Gamma 已提交
1002

1003 1004 1005
namespace ProblemMatcherConverter {

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

		if (!Types.isArray(declares)) {
E
Erich Gamma 已提交
1009 1010
			return result;
		}
1011
		(<ProblemMatcherConfig.NamedProblemMatcher[]>declares).forEach((value) => {
1012
			let namedProblemMatcher = (new ProblemMatcherParser(context.problemReporter)).parse(value);
1013
			if (isNamedProblemMatcher(namedProblemMatcher)) {
E
Erich Gamma 已提交
1014
				result[namedProblemMatcher.name] = namedProblemMatcher;
1015
			} else {
1016
				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 已提交
1017 1018 1019 1020 1021
			}
		});
		return result;
	}

1022 1023 1024 1025 1026 1027 1028
	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) {
1029
			context.problemReporter.warn(nls.localize(
1030 1031 1032
				'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 已提交
1033
			return result;
1034
		} else if (kind === ProblemMatcherKind.String || kind === ProblemMatcherKind.ProblemMatcher) {
1035
			let matcher = resolveProblemMatcher(config as ProblemMatcherConfig.ProblemMatcher, context);
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
			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 已提交
1058
		} else {
1059
			return ProblemMatcherKind.Unknown;
E
Erich Gamma 已提交
1060 1061 1062
		}
	}

1063 1064 1065 1066 1067 1068 1069
	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 已提交
1070
					return Objects.deepClone(global);
1071 1072 1073
				}
				let localProblemMatcher = context.namedProblemMatchers[variableName];
				if (localProblemMatcher) {
J
Johannes Rieken 已提交
1074
					localProblemMatcher = Objects.deepClone(localProblemMatcher);
1075 1076 1077 1078 1079
					// remove the name
					delete localProblemMatcher.name;
					return localProblemMatcher;
				}
			}
1080
			context.problemReporter.error(nls.localize('ConfigurationParser.invalidVaraibleReference', 'Error: Invalid problemMatcher reference: {0}\n', value));
1081 1082 1083
			return undefined;
		} else {
			let json = <ProblemMatcherConfig.ProblemMatcher>value;
1084
			return new ProblemMatcherParser(context.problemReporter).parse(json);
1085 1086 1087 1088
		}
	}
}

1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
namespace TaskIdentifier {
	export function from(this: void, value: TaskIdentifier): Tasks.TaskIdentifier {
		if (!value || !Types.isString(value.type)) {
			return undefined;
		}
		const hash = crypto.createHash('md5');
		hash.update(JSON.stringify(value));
		let key = hash.digest('hex');
		let result: Tasks.TaskIdentifier = {
			_key: key,
			type: value.type
		};
		result = Objects.assign(result, value);
		return result;
	}
1104 1105
}

1106 1107 1108
const source: Tasks.TaskSource = {
	kind: Tasks.TaskSourceKind.Workspace,
	label: 'Workspace',
1109
	config: undefined
1110
};
1111

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

1130
		return [group, isDefault ? Tasks.GroupType.default : Tasks.GroupType.user];
D
Dirk Baeumer 已提交
1131
	}
1132 1133 1134
}

namespace ConfigurationProperties {
D
Dirk Baeumer 已提交
1135

1136
	const properties: MetaData<Tasks.ConfigurationProperties, any>[] = [
1137

1138 1139 1140 1141
		{ property: 'name' }, { property: 'identifier' }, { property: 'group' }, { property: 'isBackground' },
		{ property: 'promptOnClose' }, { property: 'dependsOn' },
		{ property: 'presentation', type: CommandConfiguration.PresentationOptions }, { property: 'problemMatchers' }
	];
1142

1143
	export function from(this: void, external: ConfigurationProperties, context: ParseContext, includeCommandOptions: boolean): Tasks.ConfigurationProperties {
1144
		if (!external) {
1145
			return undefined;
E
Erich Gamma 已提交
1146
		}
1147 1148 1149 1150
		let result: Tasks.ConfigurationProperties = {};
		if (Types.isString(external.taskName)) {
			result.name = external.taskName;
		}
1151 1152 1153
		if (Types.isString(external.label) && context.schemaVersion === Tasks.JsonSchemaVersion.V2_0_0) {
			result.name = external.label;
		}
1154 1155 1156 1157 1158 1159 1160 1161 1162
		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 已提交
1163 1164 1165
		if (external.group !== void 0) {
			if (Types.isString(external.group) && Tasks.TaskGroup.is(external.group)) {
				result.group = external.group;
1166
				result.groupType = Tasks.GroupType.user;
D
Dirk Baeumer 已提交
1167 1168 1169 1170
			} else {
				let values = GroupKind.from(external.group);
				if (values) {
					result.group = values[0];
1171
					result.groupType = values[1];
D
Dirk Baeumer 已提交
1172 1173
				}
			}
1174 1175 1176
		}
		if (external.dependsOn !== void 0) {
			if (Types.isString(external.dependsOn)) {
1177
				result.dependsOn = [{ workspaceFolder: context.workspaceFolder, task: external.dependsOn }];
1178
			} else if (Types.isStringArray(external.dependsOn)) {
1179
				result.dependsOn = external.dependsOn.map((task) => { return { workspaceFolder: context.workspaceFolder, task: task }; });
1180
			}
1181
		}
1182
		if (includeCommandOptions && (external.presentation !== void 0 || (external as LegacyCommandProperties).terminal !== void 0)) {
1183 1184
			result.presentation = CommandConfiguration.PresentationOptions.from(external, context);
		}
1185 1186 1187
		if (includeCommandOptions && (external.options !== void 0)) {
			result.options = CommandOptions.from(external.options, context);
		}
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
		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 {

1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
	const grunt = 'grunt.';
	const jake = 'jake.';
	const gulp = 'gulp.';
	const npm = 'vscode.npm.';
	const typescript = 'vscode.typescript.';

	interface CustomizeShape {
		customize: string;
	}

1211
	export function from(this: void, external: ConfiguringTask, context: ParseContext, index: number): Tasks.ConfiguringTask {
1212 1213 1214 1215
		if (!external) {
			return undefined;
		}
		let type = external.type;
1216 1217
		let customize = (external as CustomizeShape).customize;
		if (!type && !customize) {
1218
			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)));
1219 1220
			return undefined;
		}
D
Dirk Baeumer 已提交
1221
		let typeDeclaration = TaskDefinitionRegistry.get(type);
1222
		if (!typeDeclaration) {
1223
			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);
1224 1225 1226
			context.problemReporter.error(message);
			return undefined;
		}
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
		let identifier: TaskIdentifier;
		if (Types.isString(customize)) {
			if (customize.indexOf(grunt) === 0) {
				identifier = { type: 'grunt', task: customize.substring(grunt.length) } as TaskIdentifier;
			} else if (customize.indexOf(jake) === 0) {
				identifier = { type: 'jake', task: customize.substring(jake.length) } as TaskIdentifier;
			} else if (customize.indexOf(gulp) === 0) {
				identifier = { type: 'gulp', task: customize.substring(gulp.length) } as TaskIdentifier;
			} else if (customize.indexOf(npm) === 0) {
				identifier = { type: 'npm', script: customize.substring(npm.length + 4) } as TaskIdentifier;
			} else if (customize.indexOf(typescript) === 0) {
				identifier = { type: 'typescript', tsconfig: customize.substring(typescript.length + 6) } as TaskIdentifier;
E
Erich Gamma 已提交
1239
			}
1240 1241 1242 1243
		} else {
			identifier = {
				type
			};
1244 1245 1246 1247 1248 1249
			let properties = typeDeclaration.properties;
			let required: Set<string> = new Set();
			if (Array.isArray(typeDeclaration.required)) {
				typeDeclaration.required.forEach(element => Types.isString(element) ? required.add(element) : required);
			}
			for (let property of Object.keys(properties)) {
1250 1251 1252
				let value = external[property];
				if (value !== void 0 && value !== null) {
					identifier[property] = value;
1253 1254 1255
				} else if (required.has(property)) {
					let schema = properties[property];
					if (schema.default !== void 0) {
J
Johannes Rieken 已提交
1256
						identifier[property] = Objects.deepClone(schema.default);
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
					} else {
						switch (schema.type) {
							case 'boolean':
								identifier[property] = false;
								break;
							case 'number':
							case 'integer':
								identifier[property] = 0;
								break;
							case 'string':
								identifier[property] = '';
								break;
							default:
								let message = nls.localize(
									'ConfigurationParser.missingRequiredProperty',
									'Error: the task configuration \'{0}\' missed the required property \'{1}\'. The task configuration will be ignored.', JSON.stringify(external, undefined, 0), property
								);
								context.problemReporter.error(message);
								return undefined;
						}
					}
1278
				}
1279
			}
1280
		}
1281
		let taskIdentifier = TaskIdentifier.from(identifier);
1282
		let configElement: Tasks.TaskSourceConfigElement = {
1283
			workspaceFolder: context.workspaceFolder,
1284 1285 1286 1287
			file: '.vscode\\tasks.json',
			index,
			element: external
		};
1288 1289 1290
		let result: Tasks.ConfiguringTask = {
			type: type,
			configures: taskIdentifier,
1291
			_id: `${typeDeclaration.extensionId}.${taskIdentifier._key}`,
1292
			_source: Objects.assign({}, source, { config: configElement }),
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
			_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 已提交
1310
				}
1311
				result._label = label;
1312
			}
1313 1314
			if (!result.identifier) {
				result.identifier = taskIdentifier._key;
E
Erich Gamma 已提交
1315
			}
1316 1317 1318 1319 1320 1321 1322
		}
		return result;
	}
}

namespace CustomTask {

1323
	export function from(this: void, external: CustomTask, context: ParseContext, index: number): Tasks.CustomTask {
1324 1325 1326 1327 1328 1329 1330 1331
		if (!external) {
			return undefined;
		}
		let type = external.type;
		if (type === void 0 || type === null) {
			type = 'custom';
		}
		if (type !== 'custom' && type !== 'shell' && type !== 'process') {
1332
			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)));
1333 1334 1335
			return undefined;
		}
		let taskName = external.taskName;
1336 1337 1338
		if (Types.isString(external.label) && context.schemaVersion === Tasks.JsonSchemaVersion.V2_0_0) {
			taskName = external.label;
		}
1339
		if (!taskName) {
D
Dirk Baeumer 已提交
1340
			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)));
1341 1342 1343 1344 1345 1346
			return undefined;
		}

		let result: Tasks.CustomTask = {
			type: 'custom',
			_id: context.uuidMap.getUUID(taskName),
D
Dirk Baeumer 已提交
1347
			_source: Objects.assign({}, source, { config: { index, element: external, file: '.vscode\\tasks.json', workspaceFolder: context.workspaceFolder } }),
1348 1349 1350
			_label: taskName,
			name: taskName,
			identifier: taskName,
1351
			hasDefinedMatchers: false,
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362
			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;
1363
			}
1364 1365 1366 1367 1368
			if (result.group === void 0) {
				if (legacy.isBuildCommand === true) {
					result.group = Tasks.TaskGroup.Build;
				} else if (legacy.isTestCommand === true) {
					result.group = Tasks.TaskGroup.Test;
1369
				}
1370
			}
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
		}
		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
1386 1387
		// or there is a dependsOn and a defined command.
		if (CommandConfiguration.hasCommand(task.command) || task.dependsOn === void 0) {
1388 1389
			task.command = CommandConfiguration.fillGlobals(task.command, globals.command, task.name);
		}
1390 1391 1392 1393
		if (task.problemMatchers === void 0 && globals.problemMatcher !== void 0) {
			task.problemMatchers = Objects.deepClone(globals.problemMatcher);
			task.hasDefinedMatchers = true;
		}
1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410
		// 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;
		}
1411 1412
		if (task.group !== void 0 && task.groupType === void 0) {
			task.groupType = Tasks.GroupType.user;
1413
		}
1414 1415
	}

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

		assignProperty(resultConfigProps, configuredProps, 'group');
1430
		assignProperty(resultConfigProps, configuredProps, 'groupType');
1431 1432 1433 1434 1435 1436
		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);
1437
		result.command.options = CommandOptions.assignProperties(result.command.options, configuredProps.options);
1438 1439 1440

		let contributedConfigProps: Tasks.ConfigurationProperties = contributedTask;
		fillProperty(resultConfigProps, contributedConfigProps, 'group');
1441
		fillProperty(resultConfigProps, contributedConfigProps, 'groupType');
1442 1443 1444 1445 1446 1447
		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);
1448
		result.command.options = CommandOptions.fillProperties(result.command.options, contributedConfigProps.options);
1449

1450 1451 1452 1453
		if (contributedTask.hasDefinedMatchers === true) {
			result.hasDefinedMatchers = true;
		}

1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466
		return result;
	}
}

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

namespace TaskParser {

	function isCustomTask(value: CustomTask | ConfiguringTask): value is CustomTask {
		let type = value.type;
1467 1468
		let customize = (value as any).customize;
		return customize === void 0 && (type === void 0 || type === null || type === 'custom' || type === 'shell' || type === 'process');
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
	}

	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;

1480 1481
		for (let index = 0; index < externals.length; index++) {
			let external = externals[index];
1482
			if (isCustomTask(external)) {
1483
				let customTask = CustomTask.from(external, context, index);
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 1513 1514 1515 1516 1517
				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 已提交
1518 1519
				}
			} else {
1520
				let configuredTask = ConfiguringTask.from(external, context, index);
1521 1522
				if (configuredTask) {
					result.configured.push(configuredTask);
D
Dirk Baeumer 已提交
1523
				}
E
Erich Gamma 已提交
1524
			}
1525
		}
1526
		if (defaultBuildTask.rank > -1 && defaultBuildTask.rank < 2) {
1527
			defaultBuildTask.task.group = Tasks.TaskGroup.Build;
1528
			defaultBuildTask.task.groupType = Tasks.GroupType.user;
1529
		} else if (defaultTestTask.rank > -1 && defaultTestTask.rank < 2) {
1530
			defaultTestTask.task.group = Tasks.TaskGroup.Test;
1531
			defaultTestTask.task.groupType = Tasks.GroupType.user;
E
Erich Gamma 已提交
1532
		}
1533 1534

		return result;
E
Erich Gamma 已提交
1535 1536
	}

1537
	export function assignTasks(target: Tasks.CustomTask[], source: Tasks.CustomTask[]): Tasks.CustomTask[] {
1538
		if (source === void 0 || source.length === 0) {
1539 1540
			return target;
		}
1541
		if (target === void 0 || target.length === 0) {
1542 1543 1544
			return source;
		}

1545
		if (source) {
1546
			// Tasks are keyed by ID but we need to merge by name
1547
			let map: IStringDictionary<Tasks.CustomTask> = Object.create(null);
1548 1549
			target.forEach((task) => {
				map[task.name] = task;
1550 1551
			});

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

interface Globals {
1568
	command?: Tasks.CommandConfiguration;
1569
	problemMatcher?: ProblemMatcher[];
1570 1571 1572 1573 1574
	promptOnClose?: boolean;
	suppressTaskName?: boolean;
}

namespace Globals {
1575 1576 1577 1578

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

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

1612
	export function isEmpty(value: Globals): boolean {
D
Dirk Baeumer 已提交
1613
		return !value || value.command === void 0 && value.promptOnClose === void 0 && value.suppressTaskName === void 0;
1614 1615
	}

1616
	export function assignProperties(target: Globals, source: Globals): Globals {
1617 1618
		if (isEmpty(source)) {
			return target;
E
Erich Gamma 已提交
1619
		}
1620 1621 1622
		if (isEmpty(target)) {
			return source;
		}
1623 1624
		assignProperty(target, source, 'promptOnClose');
		assignProperty(target, source, 'suppressTaskName');
1625
		return target;
E
Erich Gamma 已提交
1626 1627
	}

1628
	export function fillDefaults(value: Globals, context: ParseContext): void {
1629 1630 1631
		if (!value) {
			return;
		}
1632
		CommandConfiguration.fillDefaults(value.command, context);
1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648
		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);
		}
	}
}

1649 1650
export namespace ExecutionEngine {

1651
	export function from(config: ExternalTaskRunnerConfiguration): Tasks.ExecutionEngine {
1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
		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.');
		}
1672
	}
1673
}
1674

1675 1676
export namespace JsonSchemaVersion {

1677
	const _default: Tasks.JsonSchemaVersion = Tasks.JsonSchemaVersion.V2_0_0;
1678

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

1695 1696
export interface ParseResult {
	validationStatus: ValidationStatus;
1697 1698
	custom: Tasks.CustomTask[];
	configured: Tasks.ConfiguringTask[];
1699
	engine: Tasks.ExecutionEngine;
1700 1701
}

1702
export interface IProblemReporter extends IProblemReporterBase {
1703 1704
}

1705 1706 1707 1708 1709
class UUIDMap {

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

1710
	constructor(other?: UUIDMap) {
1711
		this.current = Object.create(null);
1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
		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;
				}
			}
		}
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 1761 1762 1763 1764 1765
	}

	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;
	}
}

1766 1767
class ConfigurationParser {

S
Sandeep Somavarapu 已提交
1768
	private workspaceFolder: IWorkspaceFolder;
1769
	private problemReporter: IProblemReporter;
1770
	private uuidMap: UUIDMap;
1771
	private platform: Platform;
1772

1773
	constructor(workspaceFolder: IWorkspaceFolder, platform: Platform, problemReporter: IProblemReporter, uuidMap: UUIDMap) {
1774
		this.workspaceFolder = workspaceFolder;
1775
		this.platform = platform;
1776
		this.problemReporter = problemReporter;
1777
		this.uuidMap = uuidMap;
1778 1779 1780
	}

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

1801
	private createTaskRunnerConfiguration(fileConfig: ExternalTaskRunnerConfiguration, context: ParseContext): TaskParseResult {
1802
		let globals = Globals.from(fileConfig, context);
1803
		if (this.problemReporter.status.isFatal()) {
1804
			return { custom: [], configured: [] };
1805 1806
		}
		context.namedProblemMatchers = ProblemMatcherConverter.namedFrom(fileConfig.declares, context);
1807
		let globalTasks: Tasks.CustomTask[];
1808
		let externalGlobalTasks: (ConfiguringTask | CustomTask)[];
1809
		if (fileConfig.windows && context.platform === Platform.Windows) {
1810
			globalTasks = TaskParser.from(fileConfig.windows.tasks, globals, context).custom;
1811
			externalGlobalTasks = fileConfig.windows.tasks;
1812
		} else if (fileConfig.osx && context.platform === Platform.Mac) {
1813
			globalTasks = TaskParser.from(fileConfig.osx.tasks, globals, context).custom;
1814
			externalGlobalTasks = fileConfig.osx.tasks;
1815
		} else if (fileConfig.linux && context.platform === Platform.Linux) {
1816
			globalTasks = TaskParser.from(fileConfig.linux.tasks, globals, context).custom;
1817 1818 1819 1820 1821 1822 1823 1824 1825 1826
			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',
1827
					'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'))
1828
			);
1829 1830
		}

1831
		let result: TaskParseResult = { custom: undefined, configured: undefined };
1832
		if (fileConfig.tasks) {
1833
			result = TaskParser.from(fileConfig.tasks, globals, context);
1834
		}
1835
		if (globalTasks) {
1836
			result.custom = TaskParser.assignTasks(result.custom, globalTasks);
1837 1838
		}

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

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

1893
export function createCustomTask(contributedTask: Tasks.ContributedTask, configuredProps: Tasks.ConfigurationProperties & { _id: string; _source: Tasks.WorkspaceTaskSource }): Tasks.CustomTask {
1894 1895 1896 1897 1898
	return CustomTask.createCustomTask(contributedTask, configuredProps);
}

export function getTaskIdentifier(value: TaskIdentifier): Tasks.TaskIdentifier {
	return TaskIdentifier.from(value);
D
Dirk Baeumer 已提交
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 1968 1969 1970 1971 1972 1973 1974 1975 1976
}

/*
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 已提交
1977
*/