Skip to content

V
vscode

xxadev / vscode
与 Fork 源项目一致

从无法访问的项目Fork

通知 2
Star 0
Fork 0
V
vscode

体验新版 GitCode，发现更多精彩内容 >>

切换分支/标签
查找文件 普通视图历史永久链接Permalink
i18n.ts 31.1 KB
Newer Older
D
Create nls files for vscode core  
Dirk Baeumer 已提交
1 2 3 4 5 6 7 8 9 10 11 12 
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import * as path from 'path';
import * as fs from 'fs';

import { through } from 'event-stream';
import { ThroughStream } from 'through';
import File = require('vinyl');
import * as Is from 'is';
M
Implemented transifex push and pull for translations together with json->xlf->json parsing.  
Michel Kaporin 已提交
13 14 
import xml2js = require('xml2js');
import * as glob from 'glob';
D
Create nls files for vscode core  
Dirk Baeumer 已提交
15 16 

var util = require('gulp-util');
M
Implemented transifex push and pull for translations together with json->xlf->json parsing.  
Michel Kaporin 已提交
17 18 19 
const request = require('request');
const es = require('event-stream');
var iconv  = require('iconv-lite');
J
reduce logging output during build  
Joao Moreno 已提交
20
D
Create nls files for vscode core  
Dirk Baeumer 已提交
21 
function log(message: any, ...rest: any[]): void {
J
reduce logging output during build  
Joao Moreno 已提交
22 
	util.log(util.colors.green('[i18n]'), message, ...rest);
D
Create nls files for vscode core  
Dirk Baeumer 已提交
23 24 25 26 27 28 
}

interface Map<V> {
	[key: string]: V;
}
M
Implemented transifex push and pull for translations together with json->xlf->json parsing.  
Michel Kaporin 已提交
29 30 31 32 33 34 35 36 37 38 39 
interface Item {
	id: string;
	message: string;
	comment: string;
}

interface Resource {
	name: string;
	project: string;
}
D
Create nls files for vscode core  
Dirk Baeumer 已提交
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 65 66 67 68 69 70 
interface LocalizeInfo {
	key: string;
	comment: string[];
}

module LocalizeInfo {
	export function is(value: any): value is LocalizeInfo {
		let candidate = value as LocalizeInfo;
		return Is.defined(candidate) && Is.string(candidate.key) && (Is.undef(candidate.comment) || (Is.array(candidate.comment) && candidate.comment.every(element => Is.string(element))));
	}
}

interface BundledFormat {
	keys: Map<(string | LocalizeInfo)[]>;
	messages: Map<string[]>;
	bundles: Map<string[]>;
}

module BundledFormat {
	export function is(value: any): value is BundledFormat {
		if (Is.undef(value)) {
			return false;
		}

		let candidate = value as BundledFormat;
		let length = Object.keys(value).length;

		return length === 3 && Is.defined(candidate.keys) && Is.defined(candidate.messages) && Is.defined(candidate.bundles);
	}
}
M
Implemented transifex push and pull for translations together with json->xlf->json parsing.  
Michel Kaporin 已提交
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 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 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 
interface ValueFormat {
	message: string;
	comment: string[];
}

interface PackageJsonFormat {
	[key: string]: string | ValueFormat;
}

module PackageJsonFormat {
	export function is(value: any): value is PackageJsonFormat {
		if (Is.undef(value) || !Is.object(value)) {
			return false;
		}
		return Object.keys(value).every(key => {
			let element = value[key];
			return Is.string(element) || (Is.object(element) && Is.defined(element.message) && Is.defined(element.comment));
		});
	}
}

interface ModuleJsonFormat {
	messages: string[];
	keys: (string | LocalizeInfo)[];
}

module ModuleJsonFormat {
	export function is(value: any): value is ModuleJsonFormat {
		let candidate = value as ModuleJsonFormat;
		return Is.defined(candidate)
			&& Is.array(candidate.messages) && candidate.messages.every(message => Is.string(message))
			&& Is.array(candidate.keys) && candidate.keys.every(key => Is.string(key) || LocalizeInfo.is(key));
	}
}

export class Line {
	private buffer: string[] = [];

	constructor(private indent: number = 0) {
		if (indent > 0) {
			this.buffer.push(new Array(indent + 1).join(' '));
		}
	}

	public append(value: string): Line {
		this.buffer.push(value);
		return this;
	}

	public toString(): string {
		return this.buffer.join('');
	}
}

class TextModel {
	private _lines: string[];

	constructor(contents: string) {
		this._lines = contents.split(/\r\n|\r|\n/);
	}

	public get lines(): string[] {
		return this._lines;
	}
}

export class XLF {
    private buffer: string[];
	private files: Map<Item[]>;

    constructor(public project: string) {
        this.buffer = [];
		this.files = Object.create(null);
	}

    public toString(): string {
        this.appendHeader();

		for (let file in this.files) {
			this.appendNewLine(`<file original="${file}" source-language="en" datatype="plaintext"><body>`, 2);
			for (let item of this.files[file]) {
				this.addStringItem(item);
			}
       		this.appendNewLine('</body></file>', 2);
		}

		this.appendFooter();
		return this.buffer.join('\r\n');
	}

	public addFile(original: string, keys: any[], messages: string[]) {
		this.files[original] = [];
		let existingKeys = [];

		for (let key of keys) {
			// Ignore duplicate keys because Transifex does not populate those with translated values.
			if (existingKeys.indexOf(key) !== -1) {
				continue;
			}
			existingKeys.push(key);

			let message: string = encodeEntities(messages[keys.indexOf(key)]);
			let comment: string = undefined;

			// Check if the message contains description (if so, it becomes an object type in JSON)
			if (Is.string(key)) {
				this.files[original].push({ id: key, message: message, comment: comment });
			} else {
				if (key['comment'] && key['comment'].length > 0) {
					comment = key['comment'].map(comment => encodeEntities(comment)).join('\r\n');
				}

				this.files[original].push({ id: key['key'], message: message, comment: comment });
			}
		}
	}

    private addStringItem(item: Item): void {
        if (!item.id || !item.message) {
            //throw new Error('No item ID or value specified.');
        }

        this.appendNewLine(`<trans-unit id="${item.id}">`, 4);
        this.appendNewLine(`<source xml:lang="en">${encodeEntities(item.message)}</source>`, 6);

        if (item.comment) {
            this.appendNewLine(`<note>${item.comment}</note>`, 6);
        }

        this.appendNewLine('</trans-unit>', 4);
	}

    private appendHeader(): void {
        this.appendNewLine('<?xml version="1.0" encoding="utf-8"?>', 0);
        this.appendNewLine('<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">', 0);
	}

    private appendFooter(): void {
        this.appendNewLine('</xliff>', 0);
    }

    private appendNewLine(content: string, indent?: number): void {
        let line = new Line(indent);
        line.append(content);
        this.buffer.push(line.toString());
    }

	static parse = function(xlfString: string) : Promise<{ messages: Map<string>,  originalFilePath: string, language: string }[]> {
		return new Promise((resolve, reject) => {
			let parser = new xml2js.Parser();

			let files: { messages: Map<string>, originalFilePath: string, language: string }[] = [];

			parser.parseString(xlfString, function(err, result) {
				if (err) {
					reject(`Failed to parse XLIFF string. ${err}`);
				}

				const fileNodes: any[] = result['xliff']['file'];
				if (!fileNodes) {
					reject('XLIFF file does not contain "xliff" or "file" node(s) required for parsing.');
				}

				fileNodes.forEach((file) => {
					const originalFilePath = file.$.original;
					if (!originalFilePath) {
						reject('XLIFF file node does not contain original attribute to determine the original location of the resource file.');
					}
					const language = file.$['target-language'].toLowerCase();
					if (!language) {
						reject('XLIFF file node does not contain target-language attribute to determine translated language.');
					}

					let messages: Map<string> = {};
					const transUnits = file.body[0]['trans-unit'];

					transUnits.forEach(unit => {
						const key = unit.$.id;
						if (!unit.target) {
							return; // No translation available
						}

						const val = unit.target.toString();
						if (key && val) {
							messages[key] = decodeEntities(val);
						} else {
							reject('XLIFF file does not contain full localization data. ID or target translation for one of the trans-unit nodes is not present.');
						}
					});

					files.push({ messages: messages, originalFilePath: originalFilePath, language: language });
				});

				resolve(files);
			});
		});
	};
}
D
Create nls files for vscode core  
Dirk Baeumer 已提交
270 271 272 273 274 275 276 277 278 279 280 281 282 
const vscodeLanguages: string[] = [
	'chs',
	'cht',
	'jpn',
	'kor',
	'deu',
	'fra',
	'esn',
	'rus',
	'ita'
];

const iso639_3_to_2: Map<string> = {
D
Fixes --locale switch incorrect for Simplified Chinese, should be zh-cn not zh-ch  
Dirk Baeumer 已提交
283 
	'chs': 'zh-cn',
D
Fixes #4520: Code will not start with locale='zh-cn' or locale='zh-tw'  
Dirk Baeumer 已提交
284 285 
	'cht': 'zh-tw',
	'csy': 'cs-cz',
D
Create nls files for vscode core  
Dirk Baeumer 已提交
286 287 288 289 290 291 292 293 294 295 
	'deu': 'de',
	'enu': 'en',
	'esn': 'es',
	'fra': 'fr',
	'hun': 'hu',
	'ita': 'it',
	'jpn': 'ja',
	'kor': 'ko',
	'nld': 'nl',
	'plk': 'pl',
D
Fixes #4520: Code will not start with locale='zh-cn' or locale='zh-tw'  
Dirk Baeumer 已提交
296 
	'ptb': 'pt-br',
D
Create nls files for vscode core  
Dirk Baeumer 已提交
297 298 
	'ptg': 'pt',
	'rus': 'ru',
D
Fixes #4520: Code will not start with locale='zh-cn' or locale='zh-tw'  
Dirk Baeumer 已提交
299 
	'sve': 'sv-se',
D
Create nls files for vscode core  
Dirk Baeumer 已提交
300 301 302 
	'trk': 'tr'
};
M
Implemented transifex push and pull for translations together with json->xlf->json parsing.  
Michel Kaporin 已提交
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 
const iso639_2_to_3: Map<string> = {
	'zh-cn': 'chs',
	'zh-tw': 'cht',
	'cs-cz': 'csy',
	'de': 'deu',
	'en': 'enu',
	'es': 'esn',
	'fr': 'fra',
	'hu': 'hun',
	'it': 'ita',
	'ja': 'jpn',
	'ko': 'kor',
	'nl': 'nld',
	'pl': 'plk',
	'pt-br': 'ptb',
	'pt': 'ptg',
	'ru': 'rus',
	'sv-se': 'sve',
	'tr': 'trk'
};
D
Create nls files for vscode core  
Dirk Baeumer 已提交
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 
interface IDirectoryInfo {
	name: string;
	iso639_2: string;
}

function sortLanguages(directoryNames: string[]): IDirectoryInfo[] {
	return directoryNames.map((dirName) => {
		var lower = dirName.toLowerCase();
		return {
			name: lower,
			iso639_2: iso639_3_to_2[lower]
		};
	}).sort((a: IDirectoryInfo, b: IDirectoryInfo): number => {
		if (!a.iso639_2 && !b.iso639_2) {
			return 0;
		}
		if (!a.iso639_2) {
			return -1;
		}
		if (!b.iso639_2) {
			return 1;
		}
		return a.iso639_2 < b.iso639_2 ? -1 : (a.iso639_2 > b.iso639_2 ? 1 : 0);
	});
}

function stripComments(content: string): string {
	/**
	* First capturing group matches double quoted string
	* Second matches single quotes string
	* Third matches block comments
	* Fourth matches line comments
	*/
	var regexp: RegExp = /("(?:[^\\\"]*(?:\\.)?)*")|('(?:[^\\\']*(?:\\.)?)*')|(\/\*(?:\r?\n|.)*?\*\/)|(\/{2,}.*?(?:(?:\r?\n)|$))/g;
	let result = content.replace(regexp, (match, m1, m2, m3, m4) => {
		// Only one of m1, m2, m3, m4 matches
		if (m3) {
			// A block comment. Replace with nothing
			return '';
		} else if (m4) {
			// A line comment. If it ends in \r?\n then keep it.
			let length = m4.length;
			if (length > 2 && m4[length - 1] === '\n') {
				return m4[length - 2] === '\r' ? '\r\n': '\n';
			} else {
				return '';
			}
		} else {
			// We match a string
			return match;
		}
	});
	return result;
M
Implemented transifex push and pull for translations together with json->xlf->json parsing.  
Michel Kaporin 已提交
376 
}
D
Create nls files for vscode core  
Dirk Baeumer 已提交
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 

function escapeCharacters(value:string):string {
	var result:string[] = [];
	for (var i = 0; i < value.length; i++) {
		var ch = value.charAt(i);
		switch(ch) {
			case '\'':
				result.push('\\\'');
				break;
			case '"':
				result.push('\\"');
				break;
			case '\\':
				result.push('\\\\');
				break;
			case '\n':
				result.push('\\n');
				break;
			case '\r':
				result.push('\\r');
				break;
			case '\t':
				result.push('\\t');
				break;
			case '\b':
				result.push('\\b');
				break;
			case '\f':
				result.push('\\f');
				break;
			default:
				result.push(ch);
		}
	}
	return result.join('');
}
A
Improve editor-distro gulp task  
Alex Dima 已提交
414 
function processCoreBundleFormat(fileHeader:string, json: BundledFormat, emitter: any) {
D
Create nls files for vscode core  
Dirk Baeumer 已提交
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 
	let keysSection = json.keys;
	let messageSection = json.messages;
	let bundleSection = json.bundles;

	let statistics: Map<number> = Object.create(null);

	let total: number = 0;
	let defaultMessages: Map<Map<string>> = Object.create(null);
	let modules = Object.keys(keysSection);
	modules.forEach((module) => {
		let keys = keysSection[module];
		let messages = messageSection[module];
		if (!messages || keys.length !== messages.length) {
			emitter.emit('error', `Message for module ${module} corrupted. Mismatch in number of keys and messages.`);
			return;
		}
		let messageMap: Map<string> = Object.create(null);
		defaultMessages[module] = messageMap;
		keys.map((key, i) => {
			total++;
			if (Is.string(key)) {
				messageMap[key] = messages[i];
			} else {
				messageMap[key.key] = messages[i];
			}
		});
	});

	let languageDirectory = path.join(__dirname, '..', '..', 'i18n');
	let languages = sortLanguages(fs.readdirSync(languageDirectory).filter((item) => fs.statSync(path.join(languageDirectory, item)).isDirectory()));
	languages.forEach((language) => {
		if (!language.iso639_2) {
			return;
		}
J
reduce logging output during build  
Joao Moreno 已提交
450 451 452 453 
		if (process.env['VSCODE_BUILD_VERBOSE']) {
			log(`Generating nls bundles for: ${language.iso639_2}`);
		}
D
Create nls files for vscode core  
Dirk Baeumer 已提交
454 455 456 457 458 459 460 461 462 463 464 
		statistics[language.iso639_2] = 0;
		let localizedModules: Map<string[]> = Object.create(null);
		let cwd = path.join(languageDirectory, language.name, 'src');
		modules.forEach((module) => {
			let order = keysSection[module];
			let i18nFile = path.join(cwd, module) + '.i18n.json';
			let messages: Map<string> = null;
			if (fs.existsSync(i18nFile)) {
				let content = stripComments(fs.readFileSync(i18nFile, 'utf8'));
				messages = JSON.parse(content);
			} else {
J
reduce logging output during build  
Joao Moreno 已提交
465 466 467 
				if (process.env['VSCODE_BUILD_VERBOSE']) {
					log(`No localized messages found for module ${module}. Using default messages.`);
				}
D
Create nls files for vscode core  
Dirk Baeumer 已提交
468 469 470 471 472 473 474 475 476 477 478 479 480 
				messages = defaultMessages[module];
				statistics[language.iso639_2] = statistics[language.iso639_2] + Object.keys(messages).length;
			}
			let localizedMessages: string[] = [];
			order.forEach((keyInfo) => {
				let key: string = null;
				if (Is.string(keyInfo)) {
					key = keyInfo;
				} else {
					key = keyInfo.key;
				}
				let message: string = messages[key];
				if (!message) {
J
reduce logging output during build  
Joao Moreno 已提交
481 482 483 
					if (process.env['VSCODE_BUILD_VERBOSE']) {
						log(`No localized message found for key ${key} in module ${module}. Using default message.`);
					}
D
Create nls files for vscode core  
Dirk Baeumer 已提交
484 485 486 487 488 489 490 491 492 493 
					message = defaultMessages[module][key];
					statistics[language.iso639_2] = statistics[language.iso639_2] + 1;
				}
				localizedMessages.push(message);
			});
			localizedModules[module] = localizedMessages;
		});
		Object.keys(bundleSection).forEach((bundle) => {
			let modules = bundleSection[bundle];
			let contents: string[] = [
A
Improve editor-distro gulp task  
Alex Dima 已提交
494 
				fileHeader,
D
Create nls files for vscode core  
Dirk Baeumer 已提交
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 
				`define("${bundle}.nls.${language.iso639_2}", {`
			];
			modules.forEach((module, index) => {
				contents.push(`\t"${module}": [`);
				let messages = localizedModules[module];
				if (!messages) {
					emitter.emit('error', `Didn't find messages for module ${module}.`);
					return;
				}
				messages.forEach((message, index) => {
					contents.push(`\t\t"${escapeCharacters(message)}${index < messages.length ? '",': '"'}`);
				});
				contents.push(index < modules.length - 1 ? '\t],' : '\t]');
			});
			contents.push('});');
D
Create language specific nls files for extensions  
Dirk Baeumer 已提交
510 
			emitter.emit('data', new File( { path: bundle + '.nls.' + language.iso639_2 + '.js', contents: new Buffer(contents.join('\n'), 'utf-8') }));
D
Create nls files for vscode core  
Dirk Baeumer 已提交
511 512 513 514 
		});
	});
	Object.keys(statistics).forEach(key => {
		let value = statistics[key];
J
reduce logging output during build  
Joao Moreno 已提交
515 
		log(`${key} has ${value} untranslated strings.`);
D
Create nls files for vscode core  
Dirk Baeumer 已提交
516 517 518 519 520 521 522 523 
	});
	vscodeLanguages.forEach(language => {
		let iso639_2 = iso639_3_to_2[language];
		if (!iso639_2) {
			log(`\tCouldn't find iso639 2 mapping for language ${language}. Using default language instead.`);
		} else {
			let stats = statistics[iso639_2];
			if (Is.undef(stats)) {
J
reduce logging output during build  
Joao Moreno 已提交
524 
				log(`\tNo translations found for language ${language}. Using default language instead.`);
D
Create nls files for vscode core  
Dirk Baeumer 已提交
525 526 527 528 529 
			}
		}
	});
}
A
Improve editor-distro gulp task  
Alex Dima 已提交
530 
export function processNlsFiles(opts:{fileHeader:string;}): ThroughStream {
D
Create nls files for vscode core  
Dirk Baeumer 已提交
531 532 533 534 535 
	return through(function(file: File) {
		let fileName = path.basename(file.path);
		if (fileName === 'nls.metadata.json') {
			let json = null;
			if (file.isBuffer()) {
A
Convert build/lib/util.js to TypeScript  
Alex Dima 已提交
536 
				json = JSON.parse((<Buffer>file.contents).toString('utf8'));
D
Create nls files for vscode core  
Dirk Baeumer 已提交
537 
			} else {
J
reduce logging output during build  
Joao Moreno 已提交
538 
				this.emit('error', `Failed to read component file: ${file.relative}`);
D
Create nls files for vscode core  
Dirk Baeumer 已提交
539 540 
			}
			if (BundledFormat.is(json)) {
A
Improve editor-distro gulp task  
Alex Dima 已提交
541 
				processCoreBundleFormat(opts.fileHeader, json, this);
D
Create nls files for vscode core  
Dirk Baeumer 已提交
542 543 544 545 
			}
		}
		this.emit('data', file);
	});
M
Implemented transifex push and pull for translations together with json->xlf->json parsing.  
Michel Kaporin 已提交
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 
}

export function prepareXlfFiles(projectName?: string, extensionName?: string): ThroughStream {
	return through(
		function (file: File) {
			if (!file.isBuffer()) {
				log('Error', `Failed to read component file: ${file.relative}`);
			}

			const extension = path.extname(file.path);
			if (extension === '.json') {
				const json = JSON.parse((<Buffer>file.contents).toString('utf8'));

				if (BundledFormat.is(json)) {
					importBundleJson(file, json, this);
				} else if (PackageJsonFormat.is(json) || ModuleJsonFormat.is(json)) {
					importModuleOrPackageJson(file, json, projectName, this, extensionName);
				} else {
					log('Error', 'JSON format cannot be deduced.');
				}
			} else if (extension === '.isl') {
				importIsl(file, this);
			}
		}
	);
}

function getResource(sourceFile: string): Resource {
	const editorProject: string = 'vscode-editor',
		workbenchProject: string = 'vscode-workbench';
	let resource: string;

	if (sourceFile.startsWith('vs/platform')) {
		return { name: 'vs/platform', project: editorProject };
	} else if (sourceFile.startsWith('vs/editor/contrib')) {
		return { name: 'vs/editor/contrib', project: editorProject };
	} else if (sourceFile.startsWith('vs/editor')) {
		return { name: 'vs/editor', project: editorProject };
	} else if (sourceFile.startsWith('vs/base')) {
		return { name: 'vs/base', project: editorProject };
 	} else if (sourceFile.startsWith('vs/code')) {
		return { name: 'vs/code', project: workbenchProject };
	} else if (sourceFile.startsWith('vs/workbench/parts')) {
		resource = sourceFile.split('/', 4).join('/');
		return { name: resource, project: workbenchProject };
	} else if (sourceFile.startsWith('vs/workbench/services')) {
		resource = sourceFile.split('/', 4).join('/');
		return { name: resource, project: workbenchProject };
	} else if (sourceFile.startsWith('vs/workbench')) {
		return { name: 'vs/workbench', project: workbenchProject };
	}

	throw new Error (`Could not identify the XLF bundle for ${sourceFile}`);
}


function importBundleJson(file: File, json: BundledFormat, stream: ThroughStream): void {
	let transifexEditorXlfs: Map<XLF> = Object.create(null);

	for (let source in json.keys) {
		const projectResource = getResource(source);
		const resource = projectResource.name;
		const project = projectResource.project;

		const keys = json.keys[source];
		const messages = json.messages[source];
		if (keys.length !== messages.length) {
			log('Error:', `There is a mismatch between keys and messages in ${file.relative}`);
		}

		let xlf = transifexEditorXlfs[resource] ? transifexEditorXlfs[resource] : transifexEditorXlfs[resource] = new XLF(project);
		xlf.addFile(source, keys, messages);
	}

	for (let resource in transifexEditorXlfs) {
		const newFilePath = `${transifexEditorXlfs[resource].project}/${resource.replace(/\//g, '_')}.xlf`;
		const xlfFile = new File({ path: newFilePath, contents: new Buffer(transifexEditorXlfs[resource].toString(), 'utf-8')});
		stream.emit('data', xlfFile);
	}
}

// Keeps existing XLF instances and a state of how many files were already processed for faster file emission
var extensions: Map<{ xlf: XLF, processed: number }> = Object.create(null);
function importModuleOrPackageJson(file: File, json: ModuleJsonFormat | PackageJsonFormat, projectName: string, stream: ThroughStream, extensionName?: string): void {
	if (ModuleJsonFormat.is(json) && json['keys'].length !== json['messages'].length) {
		log('Error:', `There is a mismatch between keys and messages in ${file.relative}`);
	}

	// Prepare the source path for <original/> attribute in XLF & extract messages from JSON
	const formattedSourcePath = file.relative.replace(/\\/g, '/');
	const messages = Object.keys(json).map((key) => json[key].toString());

	// Stores the amount of localization files to be transformed to XLF before the emission
	let localizationFilesCount,
		originalFilePath;
	// If preparing XLF for external extension, then use different glob pattern and source path
	if (extensionName) {
		localizationFilesCount = glob.sync('**/*.nls.json').length;
		originalFilePath = `${formattedSourcePath.substr(0, formattedSourcePath.length - '.nls.json'.length)}`;
	} else {
		// Used for vscode/extensions folder
		extensionName = formattedSourcePath.split('/')[0];
		localizationFilesCount = glob.sync(`./extensions/${extensionName}/**/*.nls.json`).length;
		originalFilePath = `extensions/${formattedSourcePath.substr(0, formattedSourcePath.length - '.nls.json'.length)}`;
	}

	let extension = extensions[extensionName] ?
		extensions[extensionName] : extensions[extensionName] = { xlf: new XLF(projectName), processed: 0 };

	if (ModuleJsonFormat.is(json)) {
		extension.xlf.addFile(originalFilePath, json['keys'], json['messages']);
	} else {
		extension.xlf.addFile(originalFilePath, Object.keys(json), messages);
	}

	// Check if XLF is populated with file nodes to emit it
	if (++extensions[extensionName].processed === localizationFilesCount) {
		const newFilePath = path.join(projectName, extensionName + '.xlf');
		const xlfFile = new File({ path: newFilePath, contents: new Buffer(extension.xlf.toString(), 'utf-8')});
		stream.emit('data', xlfFile);
	}
}

var islXlf: XLF,
	islProcessed: number = 0;

function importIsl(file: File, stream: ThroughStream) {
	const islFiles = ['Default.isl', 'messages.en.isl'];
	const projectName = 'vscode-workbench';

	let xlf = islXlf ? islXlf : islXlf = new XLF(projectName),
		keys: string[] = [],
		messages: string[] = [];

	let model = new TextModel(file.contents.toString());
	let inMessageSection = false;
	model.lines.forEach(line => {
		if (line.length === 0) {
			return;
		}
		let firstChar = line.charAt(0);
		switch (firstChar) {
			case ';':
				// Comment line;
				return;
			case '[':
				inMessageSection = '[Messages]' === line || '[CustomMessages]' === line;
				return;
		}
		if (!inMessageSection) {
			return;
		}
		let sections: string[] = line.split('=');
		if (sections.length !== 2) {
			log('Error:', `Badly formatted message found: ${line}`);
		} else {
			let key = sections[0];
			let value = sections[1];
			if (key.length > 0 && value.length > 0) {
				keys.push(key);
				messages.push(value);
			}
		}
	});

	const originalPath = file.path.substring(file.cwd.length+1, file.path.split('.')[0].length).replace(/\\/g, '/');
	xlf.addFile(originalPath, keys, messages);

	// Emit only upon all ISL files combined into single XLF instance
	if (++islProcessed === islFiles.length) {
		const newFilePath = path.join(projectName, 'setup.xlf');
		const xlfFile = new File({ path: newFilePath, contents: new Buffer(xlf.toString(), 'utf-8')});
		stream.emit('data', xlfFile);
	}
}

export function pushXlfFiles(apiUrl: string, username: string, password: string): ThroughStream {
	return through(function(file: File) {
		const project = path.dirname(file.relative);
		const fileName = path.basename(file.path);
		const slug = fileName.substr(0, fileName.length - '.xlf'.length);
		const credentials = {
			'user': username,
			'password': password
		};

		// Check if resource already exists, if not, then create it.
		tryGetResource(project, slug, apiUrl, credentials).then(exists => {
			if (exists) {
				updateResource(project, slug, file, apiUrl, credentials);
			} else {
				createResource(project, slug, file, apiUrl, credentials);
			}
		});
	});
}

function tryGetResource(project: string, slug: string, apiUrl: string, credentials: any): Promise<boolean> {
	return new Promise((resolve, reject) => {
		const url = `${apiUrl}/project/${project}/resource/${slug}/?details`;
		request.get(url, { 'auth': credentials }).on('response', function (response) {
			if (response.statusCode === 404) {
				resolve(false);
			} else if (response.statusCode === 200) {
				resolve(true);
			} else {
				reject(`Failed to query resource ${slug}. Response: ${response.statusCode} ${response.statusMessage}`);
			}
		});
	});
}

function createResource(project: string, slug: string, xlfFile: File, apiUrl:string, credentials: any): void {
	const url = `${apiUrl}/project/${project}/resources`;
	const options = {
		'body': {
			'content': xlfFile.contents.toString(),
			'name': slug,
			'slug': slug,
			'i18n_type': 'XLIFF'
		},
		'json': true,
		'auth': credentials
	};

	request.post(url, options, function(err, res) {
		if (err) {
			log('Error:', `Failed to create Transifex ${project}/${slug}: ${err}`);
		}

		if (res.statusCode === 201) {
			log(`Resource ${project}/${slug} successfully created on Transifex.`);
		} else {
			log('Error:', `Something went wrong creating ${slug} in ${project}. ${res.statusCode}`);
		}
	});
}

/**
 * The following link provides information about how Transifex handles updates of a resource file:
 * https://dev.befoolish.co/tx-docs/public/projects/updating-content#what-happens-when-you-update-files
 */
function updateResource(project: string, slug: string, xlfFile: File, apiUrl: string, credentials: any) : void {
	const url = `${apiUrl}/project/${project}/resource/${slug}/content`;
	const options = {
		'body': { 'content': xlfFile.contents.toString() },
		'json': true,
		'auth': credentials
	};

	request.put(url, options, function(err, res, body) {
		if (err) {
			log('Error:', `Failed to update Transifex ${project}/${slug}: ${err}`);
		}

		if (res.statusCode === 200) {
			log(`Resource ${project}/${slug} successfully updated on Transifex. Strings added: ${body['strings_added']}, updated: ${body['strings_updated']}, deleted: ${body['strings_delete']}`);
		} else {
			log('Error:', `Something went wrong updating ${slug} in ${project}. ${res.statusCode}`);
		}
	});
}

function getMetadataResources(pathToMetadata: string) : Resource[] {
	const metadata = fs.readFileSync(pathToMetadata).toString('utf8');
	const json = JSON.parse(metadata);
	let slugs = [];

	for (let source in json['keys']) {
		let projectResource = getResource(source);
		if (!slugs.find(slug => slug.name === projectResource.name && slug.project === projectResource.project)) {
			slugs.push(projectResource);
		}
	}

	return slugs;
}

function obtainProjectResources(projectName: string): Resource[] {
	let resources: Resource[];

	if (projectName === 'vscode-editor-workbench') {
		resources = getMetadataResources('./out-vscode/nls.metadata.json');
		resources.push({ name: 'setup', project: 'vscode-workbench' });
	} else if (projectName === 'vscode-extensions') {
		let extensionsToLocalize: string[] = glob.sync('./extensions/**/*.nls.json').map(extension => extension.split('/')[2]);
		let resourcesToPull: string[] = [];
		resources = [];

		extensionsToLocalize.forEach(extension => {
			if (resourcesToPull.indexOf(extension) === -1) { // remove duplicate elements returned by glob
				resourcesToPull.push(extension);
				resources.push({ name: extension, project: projectName });
			}
		});
	}

	return resources;
}

export function pullXlfFiles(projectName: string, apiUrl: string, username: string, password: string, resources?: Resource[]): NodeJS.ReadableStream {
	if (!resources) {
		resources = obtainProjectResources(projectName);
	}
	if (!resources) {
		throw new Error('Transifex projects and resources must be defined to be able to pull translations from Transifex.');
	}

	const credentials = {
		'auth': {
			'user': username,
			'password': password
		}
	};
	let expectedTranslationsCount = vscodeLanguages.length * resources.length;
	let translationsRetrieved = 0, called = false;

	return es.readable(function(count, callback) {
		// Mark end of stream when all resources were retrieved
		if (translationsRetrieved === expectedTranslationsCount) {
			return this.emit('end');
		}

		if (!called) {
			called = true;
			const stream = this;

			vscodeLanguages.map(function(language) {
				resources.map(function (resource) {
					const slug = resource.name.replace(/\//g, '_');
					const project = resource.project;
					const iso639 = iso639_3_to_2[language];
					const url = `${apiUrl}/project/${project}/resource/${slug}/translation/${iso639}?file&mode=onlyreviewed`;

					let xlfBuffer: string = '', responseCode: number;
					request.get(url, credentials)
						.on('response', (response) => {
							responseCode = response.statusCode;
						})
						.on('data', (data) => xlfBuffer += data)
						.on('end', () => {
							if (responseCode === 200) {
								stream.emit('data', new File({ contents: new Buffer(xlfBuffer) }));
							} else {
								log('Error:', `${slug} in ${project} returned no data. Response code: ${responseCode}.`);
							}
							translationsRetrieved++;
						})
						.on('error', (error) => {
							log('Error:', `Failed to query resource ${slug} with the following error: ${error}`);
						});
				});
			});
		}

		callback();
	});
}

export function prepareJsonFiles(): ThroughStream {
	return through(function(xlf: File) {
		let stream = this;

		XLF.parse(xlf.contents.toString()).then(
			function(resolvedFiles) {
				resolvedFiles.forEach(file => {
					let messages = file.messages, translatedFile;

					// ISL file path always starts with 'build/'
					if (file.originalFilePath.startsWith('build/')) {
						const defaultLanguages = { 'zh-cn': true, 'zh-tw': true, 'ko': true };
						if (path.basename(file.originalFilePath) === 'Default' && !defaultLanguages[file.language]) {
							return;
						}

						translatedFile = createIslFile('..', file.originalFilePath, messages, iso639_2_to_3[file.language]);
					} else {
						translatedFile = createI18nFile(iso639_2_to_3[file.language], file.originalFilePath, messages);
					}

					stream.emit('data', translatedFile);
				});
			},
			function(rejectReason) {
				log('Error:', rejectReason);
			}
		);
	});
}

export function createI18nFile(base: string, originalFilePath: string, messages: Map<string>): File {
	let content = [
		'/*---------------------------------------------------------------------------------------------',
		' *  Copyright (c) Microsoft Corporation. All rights reserved.',
		' *  Licensed under the MIT License. See License.txt in the project root for license information.',
		' *--------------------------------------------------------------------------------------------*/',
		'// Do not edit this file. It is machine generated.'
	].join('\n') + '\n' + JSON.stringify(messages, null, '\t').replace(/\r\n/g, '\n');

	return new File({
		path: path.join(base, originalFilePath + '.i18n.json'),
		contents: new Buffer(content, 'utf8')
	});
}


const languageNames: Map<string> = {
	'chs': 'Simplified Chinese',
	'cht': 'Traditional Chinese',
	'kor': 'Korean'
};

const languageIds: Map<string> = {
	'chs': '$0804',
	'cht': '$0404',
	'kor': '$0412'
};

const encodings: Map<string> = {
	'chs': 'CP936',
	'cht': 'CP950',
	'jpn': 'CP932',
	'kor': 'CP949',
	'deu': 'CP1252',
	'fra': 'CP1252',
	'esn': 'CP1252',
	'rus': 'CP1251',
	'ita': 'CP1252'
};

export function createIslFile(base: string, originalFilePath: string, messages: Map<string>, language: string): File {
	let content: string[] = [];
	let originalContent: TextModel;
	if (path.basename(originalFilePath) === 'Default') {
		originalContent = new TextModel(fs.readFileSync(originalFilePath + '.isl', 'utf8'));
	} else {
		originalContent = new TextModel(fs.readFileSync(originalFilePath + '.en.isl', 'utf8'));
	}

	originalContent.lines.forEach(line => {
		if (line.length > 0) {
			let firstChar = line.charAt(0);
			if (firstChar === '[' || firstChar === ';') {
				if (line === '; *** Inno Setup version 5.5.3+ English messages ***') {
					content.push(`; *** Inno Setup version 5.5.3+ ${languageNames[language]} messages ***`);
				} else {
					content.push(line);
				}
			} else {
				let sections: string[] = line.split('=');
				let key = sections[0];
				let translated = line;
				if (key) {
					if (key === 'LanguageName') {
						translated = `${key}=${languageNames[language]}`;
					} else if (key === 'LanguageID') {
						translated = `${key}=${languageIds[language]}`;
					} else if (key === 'LanguageCodePage') {
						translated = `${key}=${encodings[language].substr(2)}`;
					} else {
						let translatedMessage = messages[key];
						if (translatedMessage) {
							translated = `${key}=${translatedMessage}`;
						}
					}
				}

				content.push(translated);
			}
		}
	});

	let tag = iso639_3_to_2[language];
	let basename = path.basename(originalFilePath);
	let filePath = `${path.join(base, path.dirname(originalFilePath), basename)}.${tag}.isl`;

	return new File({
		path: filePath,
		contents: iconv.encode(new Buffer(content.join('\r\n'), 'utf8'), encodings[language])
	});
}

function encodeEntities(value: string): string {
	var result: string[] = [];
	for (var i = 0; i < value.length; i++) {
		var ch = value[i];
		switch (ch) {
			case '<':
				result.push('&lt;');
				break;
			case '>':
				result.push('&gt;');
				break;
			case '&':
				result.push('&amp;');
				break;
			default:
				result.push(ch);
		}
	}
	return result.join('');
}

export function decodeEntities(value:string): string {
	return value.replace(/&lt;/g, '<').replace(/&gt;/g, '>').replace(/&amp;/g, '&');
D
Create nls files for vscode core  
Dirk Baeumer 已提交
1051 
}