taskConfiguration.ts 59.5 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 nls = require('vs/nls');
E
Erich Gamma 已提交
10 11 12 13 14 15 16

import * as Objects from 'vs/base/common/objects';
import { IStringDictionary } from 'vs/base/common/collections';
import * as Platform from 'vs/base/common/platform';
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 | { value: string, quoting: 'escape' | 'strong' | 'weak' };
186

187 188 189 190 191 192 193 194 195 196 197
export namespace CommandString {
	export function value(value: CommandString): string {
		if (Types.isString(value)) {
			return value;
		} else {
			return value.value;
		}
	}
}

export interface BaseCommandProperties {
198 199 200 201 202

	/**
	 * The command to be executed. Can be an external program or a shell
	 * command.
	 */
203
	command?: CommandString;
204 205 206 207

	/**
	 * The command options used when the command is executed. Can be omitted.
	 */
D
Dirk Baeumer 已提交
208
	options?: CommandOptions;
209 210 211 212

	/**
	 * The arguments passed to the command or additional arguments passed to the
	 * command when using a global command.
E
Erich Gamma 已提交
213
	 */
214
	args?: CommandString[];
215 216 217
}


218
export interface CommandProperties extends BaseCommandProperties {
D
Dirk Baeumer 已提交
219

220
	/**
221
	 * Windows specific command properties
222
	 */
223
	windows?: BaseCommandProperties;
224

225
	/**
226
	 * OSX specific command properties
227
	 */
228
	osx?: BaseCommandProperties;
229 230

	/**
231
	 * linux specific command properties
232
	 */
233 234
	linux?: BaseCommandProperties;
}
235

D
Dirk Baeumer 已提交
236 237
export interface GroupKind {
	kind?: string;
238
	isDefault?: boolean;
D
Dirk Baeumer 已提交
239 240
}

241
export interface ConfigurationProperties {
242
	/**
243
	 * The task's name
244
	 */
245
	taskName?: string;
E
Erich Gamma 已提交
246

247 248 249 250 251
	/**
	 * The UI label used for the task.
	 */
	label?: string;

E
Erich Gamma 已提交
252
	/**
253 254
	 * An optional indentifier which can be used to reference a task
	 * in a dependsOn or other attributes.
E
Erich Gamma 已提交
255
	 */
256
	identifier?: string;
E
Erich Gamma 已提交
257

258 259 260 261 262
	/**
	 * Whether the executed command is kept alive and runs in the background.
	 */
	isBackground?: boolean;

D
Dirk Baeumer 已提交
263 264 265 266 267
	/**
	 * Whether the task should prompt on close for confirmation if running.
	 */
	promptOnClose?: boolean;

E
Erich Gamma 已提交
268
	/**
269 270
	 * Defines the group the task belongs too.
	 */
D
Dirk Baeumer 已提交
271
	group?: string | GroupKind;
272 273

	/**
274
	 * The other tasks the task depend on
E
Erich Gamma 已提交
275
	 */
276
	dependsOn?: string | string[];
E
Erich Gamma 已提交
277 278

	/**
279
	 * Controls the behavior of the used terminal
E
Erich Gamma 已提交
280
	 */
281
	presentation?: PresentationOptions;
E
Erich Gamma 已提交
282

283 284 285 286 287
	/**
	 * Controls shell options.
	 */
	options?: CommandOptions;

E
Erich Gamma 已提交
288
	/**
289 290
	 * The problem matcher(s) to use to capture problems in the tasks
	 * output.
E
Erich Gamma 已提交
291
	 */
292 293
	problemMatcher?: ProblemMatcherConfig.ProblemMatcherType;
}
E
Erich Gamma 已提交
294

295
export interface CustomTask extends CommandProperties, ConfigurationProperties {
E
Erich Gamma 已提交
296
	/**
297
	 * Custom tasks have the type 'custom'
E
Erich Gamma 已提交
298
	 */
299
	type?: string;
E
Erich Gamma 已提交
300

301
}
302

303
export interface ConfiguringTask extends ConfigurationProperties {
E
Erich Gamma 已提交
304
	/**
305
	 * The contributed type of the task
E
Erich Gamma 已提交
306
	 */
307
	type?: string;
E
Erich Gamma 已提交
308 309 310 311 312
}

/**
 * The base task runner configuration
 */
313
export interface BaseTaskRunnerConfiguration {
E
Erich Gamma 已提交
314 315 316 317 318

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

	/**
322 323
	 * @deprecated Use type instead
	 *
E
Erich Gamma 已提交
324 325 326 327 328 329 330
	 * 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;

331 332 333 334 335
	/**
	 * The task type
	 */
	type?: string;

E
Erich Gamma 已提交
336 337 338
	/**
	 * The command options used when the command is executed. Can be omitted.
	 */
D
Dirk Baeumer 已提交
339
	options?: CommandOptions;
E
Erich Gamma 已提交
340 341 342 343

	/**
	 * The arguments passed to the command. Can be omitted.
	 */
344
	args?: CommandString[];
E
Erich Gamma 已提交
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361

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

362 363 364 365
	/**
	 * The group
	 */
	group?: string | GroupKind;
D
Dirk Baeumer 已提交
366 367 368
	/**
	 * Controls the behavior of the used terminal
	 */
369
	presentation?: PresentationOptions;
D
Dirk Baeumer 已提交
370

E
Erich Gamma 已提交
371 372 373 374 375 376 377 378 379 380 381 382
	/**
	 * 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 已提交
383
	taskSelector?: string;
E
Erich Gamma 已提交
384 385 386 387 388 389 390 391 392

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

	/**
393 394
	 * @deprecated Use `isBackground` instead.
	 *
E
Erich Gamma 已提交
395
	 * Specifies whether a global command is a watching the filesystem. A task.json
396
	 * file can either contain a global isWatching property or a tasks property
E
Erich Gamma 已提交
397 398 399 400
	 * but not both.
	 */
	isWatching?: boolean;

401 402 403 404 405
	/**
	 * Specifies whether a global command is a background task.
	 */
	isBackground?: boolean;

D
Dirk Baeumer 已提交
406 407 408 409 410
	/**
	 * Whether the task should prompt on close for confirmation if running.
	 */
	promptOnClose?: boolean;

E
Erich Gamma 已提交
411 412 413 414
	/**
	 * The configuration of the available tasks. A tasks.json file can either
	 * contain a global problemMatcher property or a tasks property but not both.
	 */
415
	tasks?: (CustomTask | ConfiguringTask)[];
E
Erich Gamma 已提交
416 417 418 419 420 421 422 423 424 425 426 427 428

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

429 430
	_runner?: string;

431 432 433 434 435
	/**
	 * Determines the runner to use
	 */
	runner?: string;

E
Erich Gamma 已提交
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
	/**
	 * 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
}

464 465
const EMPTY_ARRAY: any[] = [];
Object.freeze(EMPTY_ARRAY);
E
Erich Gamma 已提交
466

467
function assignProperty<T, K extends keyof T>(target: T, source: Partial<T>, key: K) {
468 469 470
	if (source[key] !== void 0) {
		target[key] = source[key];
	}
E
Erich Gamma 已提交
471 472
}

473
function fillProperty<T, K extends keyof T>(target: T, source: Partial<T>, key: K) {
474 475 476 477 478 479
	if (target[key] === void 0 && source[key] !== void 0) {
		target[key] = source[key];
	}
}


480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 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
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]);
545
		} else if (target[property] === void 0) {
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
			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 已提交
561
			return Objects.deepClone(defaults);
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
		} 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;
}

604
interface ParseContext {
S
Sandeep Somavarapu 已提交
605
	workspaceFolder: IWorkspaceFolder;
606
	problemReporter: IProblemReporter;
607
	namedProblemMatchers: IStringDictionary<NamedProblemMatcher>;
608
	uuidMap: UUIDMap;
609 610
	engine: Tasks.ExecutionEngine;
	schemaVersion: Tasks.JsonSchemaVersion;
E
Erich Gamma 已提交
611 612
}

613

614
namespace ShellConfiguration {
615

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

618 619 620 621 622 623 624 625 626 627 628 629 630
	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();
		}
631 632 633 634
		if (config.quoting !== void 0) {
			result.quoting = Objects.deepClone(config.quoting);
		}

635 636 637
		return result;
	}

638 639
	export function isEmpty(this: void, value: Tasks.ShellConfiguration): boolean {
		return _isEmpty(value, properties);
640 641
	}

642 643
	export function assignProperties(this: void, target: Tasks.ShellConfiguration, source: Tasks.ShellConfiguration): Tasks.ShellConfiguration {
		return _assignProperties(target, source, properties);
644 645
	}

646 647
	export function fillProperties(this: void, target: Tasks.ShellConfiguration, source: Tasks.ShellConfiguration): Tasks.ShellConfiguration {
		return _fillProperties(target, source, properties);
648 649
	}

650 651
	export function fillDefaults(this: void, value: Tasks.ShellConfiguration, context: ParseContext): Tasks.ShellConfiguration {
		return value;
652 653
	}

654
	export function freeze(this: void, value: Tasks.ShellConfiguration): Readonly<Tasks.ShellConfiguration> {
655
		if (!value) {
656
			return undefined;
657
		}
658
		return Object.freeze(value);
659 660 661
	}
}

662
namespace CommandOptions {
663 664

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

D
Dirk Baeumer 已提交
667
	export function from(this: void, options: CommandOptions, context: ParseContext): Tasks.CommandOptions {
668
		let result: Tasks.CommandOptions = {};
669 670 671 672
		if (options.cwd !== void 0) {
			if (Types.isString(options.cwd)) {
				result.cwd = options.cwd;
			} else {
673
				context.problemReporter.warn(nls.localize('ConfigurationParser.invalidCWD', 'Warning: options.cwd must be of type string. Ignoring value {0}\n', options.cwd));
674 675 676
			}
		}
		if (options.env !== void 0) {
J
Johannes Rieken 已提交
677
			result.env = Objects.deepClone(options.env);
678
		}
D
Dirk Baeumer 已提交
679
		result.shell = ShellConfiguration.from(options.shell, context);
680
		return isEmpty(result) ? undefined : result;
E
Erich Gamma 已提交
681 682
	}

683
	export function isEmpty(value: Tasks.CommandOptions): boolean {
684
		return _isEmpty(value, properties);
E
Erich Gamma 已提交
685 686
	}

687
	export function assignProperties(target: Tasks.CommandOptions, source: Tasks.CommandOptions): Tasks.CommandOptions {
688 689
		if (isEmpty(source)) {
			return target;
E
Erich Gamma 已提交
690
		}
691 692
		if (isEmpty(target)) {
			return source;
E
Erich Gamma 已提交
693
		}
694
		assignProperty(target, source, 'cwd');
695 696 697 698 699
		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]);
700
			Object.keys(source.env).forEach(key => env[key] = source.env[key]);
701 702
			target.env = env;
		}
703 704 705 706 707
		target.shell = ShellConfiguration.assignProperties(target.shell, source.shell);
		return target;
	}

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

711 712
	export function fillDefaults(value: Tasks.CommandOptions, context: ParseContext): Tasks.CommandOptions {
		return _fillDefaults(value, defaults, properties, context);
713 714
	}

715 716
	export function freeze(value: Tasks.CommandOptions): Readonly<Tasks.CommandOptions> {
		return _freeze(value, properties);
E
Erich Gamma 已提交
717
	}
718
}
E
Erich Gamma 已提交
719

720
namespace CommandConfiguration {
721

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

725 726 727 728 729
		interface PresentationOptionsShape extends LegacyCommandProperties {
			presentation?: PresentationOptions;
		}

		export function from(this: void, config: PresentationOptionsShape, context: ParseContext): Tasks.PresentationOptions {
730 731 732
			let echo: boolean;
			let reveal: Tasks.RevealKind;
			let focus: boolean;
733
			let panel: Tasks.PanelKind;
D
Dirk Baeumer 已提交
734 735 736 737 738 739
			if (Types.isBoolean(config.echoCommand)) {
				echo = config.echoCommand;
			}
			if (Types.isString(config.showOutput)) {
				reveal = Tasks.RevealKind.fromString(config.showOutput);
			}
740 741 742 743
			let presentation = config.presentation || config.terminal;
			if (presentation) {
				if (Types.isBoolean(presentation.echo)) {
					echo = presentation.echo;
D
Dirk Baeumer 已提交
744
				}
745 746
				if (Types.isString(presentation.reveal)) {
					reveal = Tasks.RevealKind.fromString(presentation.reveal);
D
Dirk Baeumer 已提交
747
				}
748 749
				if (Types.isBoolean(presentation.focus)) {
					focus = presentation.focus;
750
				}
751 752
				if (Types.isString(presentation.panel)) {
					panel = Tasks.PanelKind.fromString(presentation.panel);
753
				}
D
Dirk Baeumer 已提交
754
			}
755
			if (echo === void 0 && reveal === void 0 && focus === void 0 && panel === void 0) {
D
Dirk Baeumer 已提交
756 757
				return undefined;
			}
758
			return { echo, reveal, focus, panel };
D
Dirk Baeumer 已提交
759 760
		}

761
		export function assignProperties(target: Tasks.PresentationOptions, source: Tasks.PresentationOptions): Tasks.PresentationOptions {
762
			return _assignProperties(target, source, properties);
763 764
		}

765
		export function fillProperties(target: Tasks.PresentationOptions, source: Tasks.PresentationOptions): Tasks.PresentationOptions {
766
			return _fillProperties(target, source, properties);
D
Dirk Baeumer 已提交
767 768
		}

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

774
		export function freeze(value: Tasks.PresentationOptions): Readonly<Tasks.PresentationOptions> {
775
			return _freeze(value, properties);
D
Dirk Baeumer 已提交
776 777
		}

778
		export function isEmpty(this: void, value: Tasks.PresentationOptions): boolean {
779
			return _isEmpty(value, properties);
D
Dirk Baeumer 已提交
780 781 782
		}
	}

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
	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;
			}
			if (Types.isString(value.value)) {
				return {
					value: value.value,
					quoting: Tasks.ShellQuoting.from(value.quoting)
				};
			}
			return undefined;
		}
	}

801 802 803 804 805 806 807 808 809 810 811
	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 },
812
		{ property: 'args' }, { property: 'taskSelector' }, { property: 'suppressTaskName' },
813
		{ property: 'presentation', type: PresentationOptions }
814 815
	];

816 817
	export function from(this: void, config: CommandConfiguationShape, context: ParseContext): Tasks.CommandConfiguration {
		let result: Tasks.CommandConfiguration = fromBase(config, context);
818

819
		let osConfig: Tasks.CommandConfiguration = undefined;
820 821 822 823 824 825 826 827
		if (config.windows && Platform.platform === Platform.Platform.Windows) {
			osConfig = fromBase(config.windows, context);
		} else if (config.osx && Platform.platform === Platform.Platform.Mac) {
			osConfig = fromBase(config.osx, context);
		} else if (config.linux && Platform.platform === Platform.Platform.Linux) {
			osConfig = fromBase(config.linux, context);
		}
		if (osConfig) {
828
			result = assignProperties(result, osConfig);
829 830 831 832
		}
		return isEmpty(result) ? undefined : result;
	}

833 834 835
	function fromBase(this: void, config: BaseCommandConfiguationShape, context: ParseContext): Tasks.CommandConfiguration {
		let result: Tasks.CommandConfiguration = {
			name: undefined,
836
			runtime: undefined,
837
			presentation: undefined
838
		};
839 840

		result.name = ShellString.from(config.command);
D
Dirk Baeumer 已提交
841
		if (Types.isString(config.type)) {
842 843 844
			if (config.type === 'shell' || config.type === 'process') {
				result.runtime = Tasks.RuntimeType.fromString(config.type);
			}
D
Dirk Baeumer 已提交
845 846 847
		}
		let isShellConfiguration = ShellConfiguration.is(config.isShellCommand);
		if (Types.isBoolean(config.isShellCommand) || isShellConfiguration) {
848
			result.runtime = Tasks.RuntimeType.Shell;
849
		} else if (config.isShellCommand !== void 0) {
850 851
			result.runtime = !!config.isShellCommand ? Tasks.RuntimeType.Shell : Tasks.RuntimeType.Process;
		}
852

853
		if (config.args !== void 0) {
854 855 856
			result.args = [];
			for (let arg of config.args) {
				let converted = ShellString.from(arg);
D
Dirk Baeumer 已提交
857
				if (converted !== void 0) {
858 859 860 861
					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'))));
				}
862
			}
E
Erich Gamma 已提交
863
		}
864 865
		if (config.options !== void 0) {
			result.options = CommandOptions.from(config.options, context);
D
Dirk Baeumer 已提交
866 867
			if (result.options && result.options.shell === void 0 && isShellConfiguration) {
				result.options.shell = ShellConfiguration.from(config.isShellCommand as ShellConfiguration, context);
868
				if (context.engine !== Tasks.ExecutionEngine.Terminal) {
D
Dirk Baeumer 已提交
869 870 871
					context.problemReporter.warn(nls.localize('ConfigurationParser.noShell', 'Warning: shell configuration is only supported when executing tasks in the terminal.'));
				}
			}
E
Erich Gamma 已提交
872
		}
873 874 875
		let panel = PresentationOptions.from(config, context);
		if (panel) {
			result.presentation = panel;
E
Erich Gamma 已提交
876
		}
877 878
		if (Types.isString(config.taskSelector)) {
			result.taskSelector = config.taskSelector;
E
Erich Gamma 已提交
879
		}
880 881 882
		if (Types.isBoolean(config.suppressTaskName)) {
			result.suppressTaskName = config.suppressTaskName;
		}
883
		return isEmpty(result) ? undefined : result;
E
Erich Gamma 已提交
884 885
	}

886 887 888 889
	export function hasCommand(value: Tasks.CommandConfiguration): boolean {
		return value && !!value.name;
	}

890
	export function isEmpty(value: Tasks.CommandConfiguration): boolean {
891
		return _isEmpty(value, properties);
892 893
	}

894
	export function assignProperties(target: Tasks.CommandConfiguration, source: Tasks.CommandConfiguration): Tasks.CommandConfiguration {
895 896
		if (isEmpty(source)) {
			return target;
E
Erich Gamma 已提交
897
		}
898 899
		if (isEmpty(target)) {
			return source;
E
Erich Gamma 已提交
900
		}
901
		assignProperty(target, source, 'name');
902
		assignProperty(target, source, 'runtime');
903 904
		assignProperty(target, source, 'taskSelector');
		assignProperty(target, source, 'suppressTaskName');
905 906 907 908 909
		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 已提交
910 911
			}
		}
912
		target.presentation = PresentationOptions.assignProperties(target.presentation, source.presentation);
913 914 915 916
		target.options = CommandOptions.assignProperties(target.options, source.options);
		return target;
	}

917 918 919 920
	export function fillProperties(target: Tasks.CommandConfiguration, source: Tasks.CommandConfiguration): Tasks.CommandConfiguration {
		return _fillProperties(target, source, properties);
	}

921 922 923 924 925 926
	export function fillGlobals(target: Tasks.CommandConfiguration, source: Tasks.CommandConfiguration, taskName: string): Tasks.CommandConfiguration {
		if (isEmpty(source)) {
			return target;
		}
		target = target || {
			name: undefined,
927
			runtime: undefined,
928
			presentation: undefined
929
		};
930 931 932 933
		if (target.name === void 0) {
			fillProperty(target, source, 'name');
			fillProperty(target, source, 'taskSelector');
			fillProperty(target, source, 'suppressTaskName');
934
			let args: Tasks.CommandString[] = source.args ? source.args.slice() : [];
935 936 937 938 939 940 941 942 943 944 945 946
			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;
		}
947
		fillProperty(target, source, 'runtime');
948

949
		target.presentation = PresentationOptions.fillProperties(target.presentation, source.presentation);
950 951
		target.options = CommandOptions.fillProperties(target.options, source.options);

952
		return target;
E
Erich Gamma 已提交
953 954
	}

955
	export function fillDefaults(value: Tasks.CommandConfiguration, context: ParseContext): void {
956 957 958
		if (!value || Object.isFrozen(value)) {
			return;
		}
959 960
		if (value.name !== void 0 && value.runtime === void 0) {
			value.runtime = Tasks.RuntimeType.Process;
961
		}
962
		value.presentation = PresentationOptions.fillDefaults(value.presentation, context);
963
		if (!isEmpty(value)) {
964
			value.options = CommandOptions.fillDefaults(value.options, context);
965
		}
966 967 968
		if (value.args === void 0) {
			value.args = EMPTY_ARRAY;
		}
969 970
		if (value.suppressTaskName === void 0) {
			value.suppressTaskName = false;
E
Erich Gamma 已提交
971 972 973
		}
	}

974 975
	export function freeze(value: Tasks.CommandConfiguration): Readonly<Tasks.CommandConfiguration> {
		return _freeze(value, properties);
E
Erich Gamma 已提交
976
	}
977
}
E
Erich Gamma 已提交
978

979 980 981
namespace ProblemMatcherConverter {

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

		if (!Types.isArray(declares)) {
E
Erich Gamma 已提交
985 986
			return result;
		}
987
		(<ProblemMatcherConfig.NamedProblemMatcher[]>declares).forEach((value) => {
988
			let namedProblemMatcher = (new ProblemMatcherParser(context.problemReporter)).parse(value);
989
			if (isNamedProblemMatcher(namedProblemMatcher)) {
E
Erich Gamma 已提交
990
				result[namedProblemMatcher.name] = namedProblemMatcher;
991
			} else {
992
				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 已提交
993 994 995 996 997
			}
		});
		return result;
	}

998 999 1000 1001 1002 1003 1004
	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) {
1005
			context.problemReporter.warn(nls.localize(
1006 1007 1008
				'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 已提交
1009
			return result;
1010
		} else if (kind === ProblemMatcherKind.String || kind === ProblemMatcherKind.ProblemMatcher) {
1011
			let matcher = resolveProblemMatcher(config as ProblemMatcherConfig.ProblemMatcher, context);
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
			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 已提交
1034
		} else {
1035
			return ProblemMatcherKind.Unknown;
E
Erich Gamma 已提交
1036 1037 1038
		}
	}

1039 1040 1041 1042 1043 1044 1045
	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 已提交
1046
					return Objects.deepClone(global);
1047 1048 1049
				}
				let localProblemMatcher = context.namedProblemMatchers[variableName];
				if (localProblemMatcher) {
J
Johannes Rieken 已提交
1050
					localProblemMatcher = Objects.deepClone(localProblemMatcher);
1051 1052 1053 1054 1055
					// remove the name
					delete localProblemMatcher.name;
					return localProblemMatcher;
				}
			}
1056
			context.problemReporter.error(nls.localize('ConfigurationParser.invalidVaraibleReference', 'Error: Invalid problemMatcher reference: {0}\n', value));
1057 1058 1059
			return undefined;
		} else {
			let json = <ProblemMatcherConfig.ProblemMatcher>value;
1060
			return new ProblemMatcherParser(context.problemReporter).parse(json);
1061 1062 1063 1064
		}
	}
}

1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
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;
	}
1080 1081
}

1082 1083 1084
const source: Tasks.TaskSource = {
	kind: Tasks.TaskSourceKind.Workspace,
	label: 'Workspace',
1085
	config: undefined
1086
};
1087

1088
namespace GroupKind {
1089
	export function from(this: void, external: string | GroupKind): [string, Tasks.GroupType] {
1090 1091 1092 1093 1094
		if (external === void 0) {
			return undefined;
		}
		if (Types.isString(external)) {
			if (Tasks.TaskGroup.is(external)) {
1095
				return [external, Tasks.GroupType.user];
1096
			} else {
D
Dirk Baeumer 已提交
1097 1098 1099
				return undefined;
			}
		}
1100 1101 1102 1103
		if (!Types.isString(external.kind) || !Tasks.TaskGroup.is(external.kind)) {
			return undefined;
		}
		let group: string = external.kind;
1104
		let isDefault: boolean = !!external.isDefault;
1105

1106
		return [group, isDefault ? Tasks.GroupType.default : Tasks.GroupType.user];
D
Dirk Baeumer 已提交
1107
	}
1108 1109 1110
}

namespace ConfigurationProperties {
D
Dirk Baeumer 已提交
1111

1112
	const properties: MetaData<Tasks.ConfigurationProperties, any>[] = [
1113

1114 1115 1116 1117
		{ property: 'name' }, { property: 'identifier' }, { property: 'group' }, { property: 'isBackground' },
		{ property: 'promptOnClose' }, { property: 'dependsOn' },
		{ property: 'presentation', type: CommandConfiguration.PresentationOptions }, { property: 'problemMatchers' }
	];
1118

1119
	export function from(this: void, external: ConfigurationProperties, context: ParseContext, includeCommandOptions: boolean): Tasks.ConfigurationProperties {
1120
		if (!external) {
1121
			return undefined;
E
Erich Gamma 已提交
1122
		}
1123 1124 1125 1126
		let result: Tasks.ConfigurationProperties = {};
		if (Types.isString(external.taskName)) {
			result.name = external.taskName;
		}
1127 1128 1129
		if (Types.isString(external.label) && context.schemaVersion === Tasks.JsonSchemaVersion.V2_0_0) {
			result.name = external.label;
		}
1130 1131 1132 1133 1134 1135 1136 1137 1138
		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 已提交
1139 1140 1141
		if (external.group !== void 0) {
			if (Types.isString(external.group) && Tasks.TaskGroup.is(external.group)) {
				result.group = external.group;
1142
				result.groupType = Tasks.GroupType.user;
D
Dirk Baeumer 已提交
1143 1144 1145 1146
			} else {
				let values = GroupKind.from(external.group);
				if (values) {
					result.group = values[0];
1147
					result.groupType = values[1];
D
Dirk Baeumer 已提交
1148 1149
				}
			}
1150 1151 1152
		}
		if (external.dependsOn !== void 0) {
			if (Types.isString(external.dependsOn)) {
1153
				result.dependsOn = [{ workspaceFolder: context.workspaceFolder, task: external.dependsOn }];
1154
			} else if (Types.isStringArray(external.dependsOn)) {
1155
				result.dependsOn = external.dependsOn.map((task) => { return { workspaceFolder: context.workspaceFolder, task: task }; });
1156
			}
1157
		}
1158
		if (includeCommandOptions && (external.presentation !== void 0 || (external as LegacyCommandProperties).terminal !== void 0)) {
1159 1160
			result.presentation = CommandConfiguration.PresentationOptions.from(external, context);
		}
1161 1162 1163
		if (includeCommandOptions && (external.options !== void 0)) {
			result.options = CommandOptions.from(external.options, context);
		}
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
		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 {

1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
	const grunt = 'grunt.';
	const jake = 'jake.';
	const gulp = 'gulp.';
	const npm = 'vscode.npm.';
	const typescript = 'vscode.typescript.';

	interface CustomizeShape {
		customize: string;
	}

1187
	export function from(this: void, external: ConfiguringTask, context: ParseContext, index: number): Tasks.ConfiguringTask {
1188 1189 1190 1191
		if (!external) {
			return undefined;
		}
		let type = external.type;
1192 1193
		let customize = (external as CustomizeShape).customize;
		if (!type && !customize) {
1194
			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)));
1195 1196
			return undefined;
		}
D
Dirk Baeumer 已提交
1197
		let typeDeclaration = TaskDefinitionRegistry.get(type);
1198
		if (!typeDeclaration) {
1199
			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);
1200 1201 1202
			context.problemReporter.error(message);
			return undefined;
		}
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
		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 已提交
1215
			}
1216 1217 1218 1219
		} else {
			identifier = {
				type
			};
1220 1221 1222 1223 1224 1225
			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)) {
1226 1227 1228
				let value = external[property];
				if (value !== void 0 && value !== null) {
					identifier[property] = value;
1229 1230 1231
				} else if (required.has(property)) {
					let schema = properties[property];
					if (schema.default !== void 0) {
J
Johannes Rieken 已提交
1232
						identifier[property] = Objects.deepClone(schema.default);
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
					} 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;
						}
					}
1254
				}
1255
			}
1256
		}
1257
		let taskIdentifier = TaskIdentifier.from(identifier);
1258
		let configElement: Tasks.TaskSourceConfigElement = {
1259
			workspaceFolder: context.workspaceFolder,
1260 1261 1262 1263
			file: '.vscode\\tasks.json',
			index,
			element: external
		};
1264 1265 1266
		let result: Tasks.ConfiguringTask = {
			type: type,
			configures: taskIdentifier,
1267
			_id: `${typeDeclaration.extensionId}.${taskIdentifier._key}`,
1268
			_source: Objects.assign({}, source, { config: configElement }),
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
			_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 已提交
1286
				}
1287
				result._label = label;
1288
			}
1289 1290
			if (!result.identifier) {
				result.identifier = taskIdentifier._key;
E
Erich Gamma 已提交
1291
			}
1292 1293 1294 1295 1296 1297 1298
		}
		return result;
	}
}

namespace CustomTask {

1299
	export function from(this: void, external: CustomTask, context: ParseContext, index: number): Tasks.CustomTask {
1300 1301 1302 1303 1304 1305 1306 1307
		if (!external) {
			return undefined;
		}
		let type = external.type;
		if (type === void 0 || type === null) {
			type = 'custom';
		}
		if (type !== 'custom' && type !== 'shell' && type !== 'process') {
1308
			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)));
1309 1310 1311
			return undefined;
		}
		let taskName = external.taskName;
1312 1313 1314
		if (Types.isString(external.label) && context.schemaVersion === Tasks.JsonSchemaVersion.V2_0_0) {
			taskName = external.label;
		}
1315
		if (!taskName) {
D
Dirk Baeumer 已提交
1316
			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)));
1317 1318 1319 1320 1321 1322
			return undefined;
		}

		let result: Tasks.CustomTask = {
			type: 'custom',
			_id: context.uuidMap.getUUID(taskName),
D
Dirk Baeumer 已提交
1323
			_source: Objects.assign({}, source, { config: { index, element: external, file: '.vscode\\tasks.json', workspaceFolder: context.workspaceFolder } }),
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
			_label: taskName,
			name: taskName,
			identifier: taskName,
			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;
1338
			}
1339 1340 1341 1342 1343
			if (result.group === void 0) {
				if (legacy.isBuildCommand === true) {
					result.group = Tasks.TaskGroup.Build;
				} else if (legacy.isTestCommand === true) {
					result.group = Tasks.TaskGroup.Test;
1344
				}
1345
			}
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
		}
		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
1361 1362
		// or there is a dependsOn and a defined command.
		if (CommandConfiguration.hasCommand(task.command) || task.dependsOn === void 0) {
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381
			task.command = CommandConfiguration.fillGlobals(task.command, globals.command, task.name);
		}
		// 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;
		}
1382 1383
		if (task.group !== void 0 && task.groupType === void 0) {
			task.groupType = Tasks.GroupType.user;
1384
		}
1385 1386
	}

1387
	export function createCustomTask(contributedTask: Tasks.ContributedTask, configuredProps: Tasks.ConfigurationProperties & { _id: string, _source: Tasks.WorkspaceTaskSource }): Tasks.CustomTask {
1388
		let result: Tasks.CustomTask = {
1389
			_id: configuredProps._id,
1390
			_source: Objects.assign({}, configuredProps._source, { customizes: contributedTask.defines }),
1391 1392 1393 1394 1395 1396 1397 1398 1399
			_label: configuredProps.name || contributedTask._label,
			type: 'custom',
			command: contributedTask.command,
			name: configuredProps.name || contributedTask.name,
			identifier: configuredProps.identifier || contributedTask.identifier
		};
		let resultConfigProps: Tasks.ConfigurationProperties = result;

		assignProperty(resultConfigProps, configuredProps, 'group');
1400
		assignProperty(resultConfigProps, configuredProps, 'groupType');
1401 1402 1403 1404 1405 1406
		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);
1407
		result.command.options = CommandOptions.assignProperties(result.command.options, configuredProps.options);
1408 1409 1410

		let contributedConfigProps: Tasks.ConfigurationProperties = contributedTask;
		fillProperty(resultConfigProps, contributedConfigProps, 'group');
1411
		fillProperty(resultConfigProps, contributedConfigProps, 'groupType');
1412 1413 1414 1415 1416 1417
		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);
1418
		result.command.options = CommandOptions.fillProperties(result.command.options, contributedConfigProps.options);
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432

		return result;
	}
}

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

namespace TaskParser {

	function isCustomTask(value: CustomTask | ConfiguringTask): value is CustomTask {
		let type = value.type;
1433 1434
		let customize = (value as any).customize;
		return customize === void 0 && (type === void 0 || type === null || type === 'custom' || type === 'shell' || type === 'process');
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
	}

	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;

1446 1447
		for (let index = 0; index < externals.length; index++) {
			let external = externals[index];
1448
			if (isCustomTask(external)) {
1449
				let customTask = CustomTask.from(external, context, index);
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483
				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 已提交
1484 1485
				}
			} else {
1486
				let configuredTask = ConfiguringTask.from(external, context, index);
1487 1488
				if (configuredTask) {
					result.configured.push(configuredTask);
D
Dirk Baeumer 已提交
1489
				}
E
Erich Gamma 已提交
1490
			}
1491
		}
1492
		if (defaultBuildTask.rank > -1 && defaultBuildTask.rank < 2) {
1493
			defaultBuildTask.task.group = Tasks.TaskGroup.Build;
1494
			defaultBuildTask.task.groupType = Tasks.GroupType.user;
1495
		} else if (defaultTestTask.rank > -1 && defaultTestTask.rank < 2) {
1496
			defaultTestTask.task.group = Tasks.TaskGroup.Test;
1497
			defaultTestTask.task.groupType = Tasks.GroupType.user;
E
Erich Gamma 已提交
1498
		}
1499 1500

		return result;
E
Erich Gamma 已提交
1501 1502
	}

1503
	export function assignTasks(target: Tasks.CustomTask[], source: Tasks.CustomTask[]): Tasks.CustomTask[] {
1504
		if (source === void 0 || source.length === 0) {
1505 1506
			return target;
		}
1507
		if (target === void 0 || target.length === 0) {
1508 1509 1510
			return source;
		}

1511
		if (source) {
1512
			// Tasks are keyed by ID but we need to merge by name
1513
			let map: IStringDictionary<Tasks.CustomTask> = Object.create(null);
1514 1515
			target.forEach((task) => {
				map[task.name] = task;
1516 1517
			});

1518 1519
			source.forEach((task) => {
				map[task.name] = task;
1520
			});
1521
			let newTarget: Tasks.CustomTask[] = [];
1522 1523 1524
			target.forEach(task => {
				newTarget.push(map[task.name]);
				delete map[task.name];
E
Erich Gamma 已提交
1525
			});
1526 1527
			Object.keys(map).forEach(key => newTarget.push(map[key]));
			target = newTarget;
E
Erich Gamma 已提交
1528
		}
1529 1530 1531 1532 1533
		return target;
	}
}

interface Globals {
1534
	command?: Tasks.CommandConfiguration;
1535 1536 1537 1538 1539
	promptOnClose?: boolean;
	suppressTaskName?: boolean;
}

namespace Globals {
1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551

	export function from(config: ExternalTaskRunnerConfiguration, context: ParseContext): Globals {
		let result = fromBase(config, context);
		let osGlobals: Globals = undefined;
		if (config.windows && Platform.platform === Platform.Platform.Windows) {
			osGlobals = fromBase(config.windows, context);
		} else if (config.osx && Platform.platform === Platform.Platform.Mac) {
			osGlobals = fromBase(config.osx, context);
		} else if (config.linux && Platform.platform === Platform.Platform.Linux) {
			osGlobals = fromBase(config.linux, context);
		}
		if (osGlobals) {
1552
			result = Globals.assignProperties(result, osGlobals);
1553 1554 1555 1556 1557
		}
		let command = CommandConfiguration.from(config, context);
		if (command) {
			result.command = command;
		}
1558
		Globals.fillDefaults(result, context);
1559 1560 1561 1562 1563
		Globals.freeze(result);
		return result;
	}

	export function fromBase(this: void, config: BaseTaskRunnerConfiguration, context: ParseContext): Globals {
1564 1565 1566 1567 1568 1569 1570
		let result: Globals = {};
		if (config.suppressTaskName !== void 0) {
			result.suppressTaskName = !!config.suppressTaskName;
		}
		if (config.promptOnClose !== void 0) {
			result.promptOnClose = !!config.promptOnClose;
		}
E
Erich Gamma 已提交
1571 1572 1573
		return result;
	}

1574
	export function isEmpty(value: Globals): boolean {
D
Dirk Baeumer 已提交
1575
		return !value || value.command === void 0 && value.promptOnClose === void 0 && value.suppressTaskName === void 0;
1576 1577
	}

1578
	export function assignProperties(target: Globals, source: Globals): Globals {
1579 1580
		if (isEmpty(source)) {
			return target;
E
Erich Gamma 已提交
1581
		}
1582 1583 1584
		if (isEmpty(target)) {
			return source;
		}
1585 1586
		assignProperty(target, source, 'promptOnClose');
		assignProperty(target, source, 'suppressTaskName');
1587
		return target;
E
Erich Gamma 已提交
1588 1589
	}

1590
	export function fillDefaults(value: Globals, context: ParseContext): void {
1591 1592 1593
		if (!value) {
			return;
		}
1594
		CommandConfiguration.fillDefaults(value.command, context);
1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610
		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);
		}
	}
}

1611 1612
export namespace ExecutionEngine {

1613
	export function from(config: ExternalTaskRunnerConfiguration): Tasks.ExecutionEngine {
1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
		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.');
		}
1634
	}
1635
}
1636

1637 1638
export namespace JsonSchemaVersion {

1639
	const _default: Tasks.JsonSchemaVersion = Tasks.JsonSchemaVersion.V2_0_0;
1640

1641 1642 1643
	export function from(config: ExternalTaskRunnerConfiguration): Tasks.JsonSchemaVersion {
		let version = config.version;
		if (!version) {
1644
			return _default;
1645 1646 1647 1648
		}
		switch (version) {
			case '0.1.0':
				return Tasks.JsonSchemaVersion.V0_1_0;
1649
			case '2.0.0':
1650
				return Tasks.JsonSchemaVersion.V2_0_0;
1651 1652
			default:
				return _default;
1653
		}
1654 1655 1656
	}
}

1657 1658
export interface ParseResult {
	validationStatus: ValidationStatus;
1659 1660
	custom: Tasks.CustomTask[];
	configured: Tasks.ConfiguringTask[];
1661
	engine: Tasks.ExecutionEngine;
1662 1663
}

1664
export interface IProblemReporter extends IProblemReporterBase {
1665 1666
}

1667 1668 1669 1670 1671
class UUIDMap {

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

1672
	constructor(other?: UUIDMap) {
1673
		this.current = Object.create(null);
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683
		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;
				}
			}
		}
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727
	}

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

1728 1729
class ConfigurationParser {

S
Sandeep Somavarapu 已提交
1730
	private workspaceFolder: IWorkspaceFolder;
1731
	private problemReporter: IProblemReporter;
1732 1733
	private uuidMap: UUIDMap;

S
Sandeep Somavarapu 已提交
1734
	constructor(workspaceFolder: IWorkspaceFolder, problemReporter: IProblemReporter, uuidMap: UUIDMap) {
1735
		this.workspaceFolder = workspaceFolder;
1736
		this.problemReporter = problemReporter;
1737
		this.uuidMap = uuidMap;
1738 1739 1740
	}

	public run(fileConfig: ExternalTaskRunnerConfiguration): ParseResult {
1741
		let engine = ExecutionEngine.from(fileConfig);
1742
		let schemaVersion = JsonSchemaVersion.from(fileConfig);
1743
		let context: ParseContext = {
1744
			workspaceFolder: this.workspaceFolder,
1745
			problemReporter: this.problemReporter,
1746
			uuidMap: this.uuidMap,
1747
			namedProblemMatchers: undefined,
1748
			engine,
1749
			schemaVersion
1750 1751
		};
		let taskParseResult = this.createTaskRunnerConfiguration(fileConfig, context);
1752
		return {
1753
			validationStatus: this.problemReporter.status,
1754 1755
			custom: taskParseResult.custom,
			configured: taskParseResult.configured,
1756
			engine
1757 1758 1759
		};
	}

1760
	private createTaskRunnerConfiguration(fileConfig: ExternalTaskRunnerConfiguration, context: ParseContext): TaskParseResult {
1761
		let globals = Globals.from(fileConfig, context);
1762
		if (this.problemReporter.status.isFatal()) {
1763
			return { custom: [], configured: [] };
1764 1765
		}
		context.namedProblemMatchers = ProblemMatcherConverter.namedFrom(fileConfig.declares, context);
1766
		let globalTasks: Tasks.CustomTask[];
1767
		let externalGlobalTasks: (ConfiguringTask | CustomTask)[];
1768
		if (fileConfig.windows && Platform.platform === Platform.Platform.Windows) {
1769
			globalTasks = TaskParser.from(fileConfig.windows.tasks, globals, context).custom;
1770
			externalGlobalTasks = fileConfig.windows.tasks;
1771
		} else if (fileConfig.osx && Platform.platform === Platform.Platform.Mac) {
1772
			globalTasks = TaskParser.from(fileConfig.osx.tasks, globals, context).custom;
1773
			externalGlobalTasks = fileConfig.osx.tasks;
1774
		} else if (fileConfig.linux && Platform.platform === Platform.Platform.Linux) {
1775
			globalTasks = TaskParser.from(fileConfig.linux.tasks, globals, context).custom;
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785
			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',
1786
					'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'))
1787
			);
1788 1789
		}

1790
		let result: TaskParseResult = { custom: undefined, configured: undefined };
1791
		if (fileConfig.tasks) {
1792
			result = TaskParser.from(fileConfig.tasks, globals, context);
1793
		}
1794
		if (globalTasks) {
1795
			result.custom = TaskParser.assignTasks(result.custom, globalTasks);
1796 1797
		}

1798
		if ((!result.custom || result.custom.length === 0) && (globals.command && globals.command.name)) {
1799
			let matchers: ProblemMatcher[] = ProblemMatcherConverter.from(fileConfig.problemMatcher, context);
1800
			let isBackground = fileConfig.isBackground ? !!fileConfig.isBackground : fileConfig.isWatching ? !!fileConfig.isWatching : undefined;
1801
			let name = Tasks.CommandString.value(globals.command.name);
1802
			let task: Tasks.CustomTask = {
1803
				_id: context.uuidMap.getUUID(name),
D
Dirk Baeumer 已提交
1804
				_source: Objects.assign({}, source, { config: { index: -1, element: fileConfig, workspaceFolder: context.workspaceFolder } }),
1805
				_label: name,
1806
				type: 'custom',
1807 1808
				name: name,
				identifier: name,
1809
				group: Tasks.TaskGroup.Build,
1810 1811
				command: {
					name: undefined,
1812
					runtime: undefined,
1813
					presentation: undefined,
1814 1815
					suppressTaskName: true
				},
1816 1817 1818
				isBackground: isBackground,
				problemMatchers: matchers
			};
1819 1820 1821
			let value = GroupKind.from(fileConfig.group);
			if (value) {
				task.group = value[0];
1822
				task.groupType = value[1];
1823 1824 1825
			} else if (fileConfig.group === 'none') {
				task.group = undefined;
			}
1826 1827 1828
			CustomTask.fillGlobals(task, globals);
			CustomTask.fillDefaults(task, context);
			result.custom = [task];
1829
		}
1830 1831
		result.custom = result.custom || [];
		result.configured = result.configured || [];
1832
		return result;
1833
	}
E
Erich Gamma 已提交
1834 1835
}

1836
let uuidMaps: Map<string, UUIDMap> = new Map();
S
Sandeep Somavarapu 已提交
1837
export function parse(workspaceFolder: IWorkspaceFolder, configuration: ExternalTaskRunnerConfiguration, logger: IProblemReporter): ParseResult {
1838 1839 1840 1841 1842
	let uuidMap = uuidMaps.get(workspaceFolder.uri.toString());
	if (!uuidMap) {
		uuidMap = new UUIDMap();
		uuidMaps.set(workspaceFolder.uri.toString(), uuidMap);
	}
1843 1844
	try {
		uuidMap.start();
1845
		return (new ConfigurationParser(workspaceFolder, logger, uuidMap)).run(configuration);
1846 1847 1848
	} finally {
		uuidMap.finish();
	}
1849 1850
}

1851
export function createCustomTask(contributedTask: Tasks.ContributedTask, configuredProps: Tasks.ConfigurationProperties & { _id: string; _source: Tasks.WorkspaceTaskSource }): Tasks.CustomTask {
1852 1853 1854 1855 1856
	return CustomTask.createCustomTask(contributedTask, configuredProps);
}

export function getTaskIdentifier(value: TaskIdentifier): Tasks.TaskIdentifier {
	return TaskIdentifier.from(value);
D
Dirk Baeumer 已提交
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934
}

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