feat: PO - add source locations (bartholomej#9)

SamanthaAdrichem · web-flow · commit a97795f4a7a2 · 2023-06-13T11:06:18.000+02:00
Closes bartholomej#8
diff --git a/.editorconfig b/.editorconfig
@@ -3,7 +3,7 @@ root = true
 
 [*]
 charset = utf-8
-indent_style = space
+indent_style = tab
 indent_size = 4
 insert_final_newline = true
 trim_trailing_whitespace = true
diff --git a/src/compilers/json.compiler.ts b/src/compilers/json.compiler.ts
@@ -1,5 +1,5 @@
 import { CompilerInterface } from './compiler.interface.js';
-import { TranslationCollection } from '../utils/translation.collection.js';
+import {TranslationCollection, TranslationInterface} from '../utils/translation.collection.js';
 import { stripBOM } from '../utils/utils.js';
 
 import pkg from 'flat';
@@ -17,7 +17,7 @@ export class JsonCompiler implements CompilerInterface {
 	}
 
 	public compile(collection: TranslationCollection): string {
-		return JSON.stringify(collection.values, null, this.indentation);
+		return JSON.stringify(collection.toKeyValueObject(), null, this.indentation);
 	}
 
 	public parse(contents: string): TranslationCollection {
diff --git a/src/compilers/namespaced-json.compiler.ts b/src/compilers/namespaced-json.compiler.ts
@@ -17,9 +17,10 @@ export class NamespacedJsonCompiler implements CompilerInterface {
 	}
 
 	public compile(collection: TranslationCollection): string {
-		const values: {} = unflatten(collection.values, {
-			object: true
-		});
+		const values: {} = unflatten(
+			collection.toKeyValueObject(),
+			{object: true}
+		);
 		return JSON.stringify(values, null, this.indentation);
 	}
 
diff --git a/src/compilers/po.compiler.ts b/src/compilers/po.compiler.ts
@@ -1,5 +1,5 @@
 import { CompilerInterface } from './compiler.interface.js';
-import { TranslationCollection, TranslationType } from '../utils/translation.collection.js';
+import {TranslationCollection, TranslationInterface, TranslationType} from '../utils/translation.collection.js';
 
 import pkg from 'gettext-parser';
 const { po } = pkg;
@@ -23,13 +23,21 @@ export class PoCompiler implements CompilerInterface {
 				'content-transfer-encoding': '8bit'
 			},
 			translations: {
-				[this.domain]: Object.keys(collection.values).reduce((translations, key) => ({
-					...translations,
-					[key]: {
-						msgid: key,
-						msgstr: collection.get(key)
-					}
-				}), {} as any)
+				[this.domain]: Object.keys(collection.values)
+					.reduce(
+						(translations, key) => {
+							const entry: TranslationInterface = collection.get(key);
+							return {
+								...translations,
+								[key]: {
+									msgid: key,
+									msgstr: entry.value,
+									comments: {reference: entry.sourceFiles?.join('\n')}
+								}
+							};
+						},
+						{} as any
+					)
 			}
 		};
 
@@ -49,7 +57,7 @@ export class PoCompiler implements CompilerInterface {
 			.filter((key) => key.length > 0)
 			.reduce((result, key) => ({
 				...result,
-				[key]: parsedPo.translations[this.domain][key].msgstr.pop()
+				[key]: {value: parsedPo.translations[this.domain][key].msgstr.pop(), sourceFiles: parsedPo.translations[this.domain][key].comments.reference.split('\n')}
 			}), {} as TranslationType);
 
 		return new TranslationCollection(values);
diff --git a/src/parsers/directive.parser.ts b/src/parsers/directive.parser.ts
@@ -37,21 +37,21 @@ export class DirectiveParser implements ParserInterface {
 		elements.forEach((element) => {
 			const attribute = this.getAttribute(element, TRANSLATE_ATTR_NAMES);
 			if (attribute?.value) {
-				collection = collection.add(attribute.value);
+				collection = collection.add(attribute.value, '', filePath);
 				return;
 			}
 
 			const boundAttribute = this.getBoundAttribute(element, TRANSLATE_ATTR_NAMES);
 			if (boundAttribute?.value) {
 				this.getLiteralPrimitives(boundAttribute.value).forEach((literalPrimitive) => {
-					collection = collection.add(literalPrimitive.value);
+					collection = collection.add(literalPrimitive.value, '', filePath);
 				});
 				return;
 			}
 
 			const textNodes = this.getTextNodes(element);
 			textNodes.forEach((textNode) => {
-				collection = collection.add(textNode.value.trim());
+				collection = collection.add(textNode.value.trim(), '', filePath);
 			});
 		});
 		return collection;
diff --git a/src/parsers/function.parser.ts b/src/parsers/function.parser.ts
@@ -26,7 +26,7 @@ export class FunctionParser implements ParserInterface {
 				return;
 			}
 			const strings = getStringsFromExpression(firstArg);
-			collection = collection.addKeys(strings);
+			collection = collection.addKeys(strings, filePath);
 		});
 		return collection;
 	}
diff --git a/src/parsers/marker.parser.ts b/src/parsers/marker.parser.ts
@@ -25,7 +25,7 @@ export class MarkerParser implements ParserInterface {
 				return;
 			}
 			const strings = getStringsFromExpression(firstArg);
-			collection = collection.addKeys(strings);
+			collection = collection.addKeys(strings, filePath);
 		});
 		return collection;
 	}
diff --git a/src/parsers/pipe.parser.ts b/src/parsers/pipe.parser.ts
@@ -30,7 +30,7 @@ export class PipeParser implements ParserInterface {
 		const pipes: BindingPipe[] = nodes.map((node) => this.findPipesInNode(node)).flat();
 		pipes.forEach((pipe) => {
 			this.parseTranslationKeysFromPipe(pipe).forEach((key: string) => {
-				collection = collection.add(key);
+				collection = collection.add(key, '', filePath);
 			});
 		});
 		return collection;
diff --git a/src/parsers/service.parser.ts b/src/parsers/service.parser.ts
@@ -39,7 +39,7 @@ export class ServiceParser implements ParserInterface {
 					return;
 				}
 				const strings = getStringsFromExpression(firstArg);
-				collection = collection.addKeys(strings);
+				collection = collection.addKeys(strings, filePath);
 			});
 		});
 		return collection;
diff --git a/src/post-processors/key-as-default-value.post-processor.ts b/src/post-processors/key-as-default-value.post-processor.ts
@@ -1,10 +1,10 @@
-import { TranslationCollection } from '../utils/translation.collection.js';
+import {TranslationCollection, TranslationInterface} from '../utils/translation.collection.js';
 import { PostProcessorInterface } from './post-processor.interface.js';
 
 export class KeyAsDefaultValuePostProcessor implements PostProcessorInterface {
 	public name: string = 'KeyAsDefaultValue';
 
 	public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
-		return draft.map((key, val) => (val === '' ? key : val));
+		return draft.map((key: string, val: TranslationInterface): TranslationInterface => val.value === '' ? {value: key, sourceFiles: (val?.sourceFiles || [])} : val);
 	}
 }
diff --git a/src/post-processors/string-as-default-value.post-processor.ts b/src/post-processors/string-as-default-value.post-processor.ts
@@ -11,6 +11,6 @@ export class StringAsDefaultValuePostProcessor implements PostProcessorInterface
 	public constructor(protected options: Options) {}
 
 	public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
-		return draft.map((key, val) => (existing.get(key) === undefined ? this.options.defaultValue : val));
+		return draft.map((key, val) => (existing.get(key) === undefined ? {value: this.options.defaultValue, sourceFiles: (val?.sourceFiles || [])} : val));
 	}
 }
diff --git a/src/utils/translation.collection.ts b/src/utils/translation.collection.ts
@@ -1,5 +1,10 @@
 export interface TranslationType {
-	[key: string]: string;
+	[key: string]: TranslationInterface;
+}
+
+export interface TranslationInterface {
+	value: string;
+	sourceFiles: string[];
 }
 
 export class TranslationCollection {
@@ -9,25 +14,36 @@ export class TranslationCollection {
 		this.values = values;
 	}
 
-	public add(key: string, val: string = ''): TranslationCollection {
-		return new TranslationCollection({ ...this.values, [key]: val });
+	public add(key: string, val: string, sourceFile: string): TranslationCollection {
+		const translation = this.values[key]
+			? {...this.values[key]}
+			: {value: val, sourceFiles: []};
+		translation.sourceFiles.push(sourceFile);
+
+		return new TranslationCollection({...this.values, [key]: translation});
 	}
 
-	public addKeys(keys: string[]): TranslationCollection {
-		const values = keys.reduce((results, key) => ({ ...results, [key]: '' }), {} as TranslationType);
-		return new TranslationCollection({ ...this.values, ...values });
+	public addKeys(keys: string[], sourceFile: string): TranslationCollection {
+		const values = keys.reduce(
+			(results, key) => ({
+				...results,
+				[key]: <TranslationInterface>{value: '', sourceFiles: [sourceFile]}
+			}),
+			{} as TranslationType
+		);
+		return new TranslationCollection({...this.values, ...values});
 	}
 
 	public remove(key: string): TranslationCollection {
 		return this.filter((k) => key !== k);
 	}
 
-	public forEach(callback: (key?: string, val?: string) => void): TranslationCollection {
+	public forEach(callback: (key?: string, val?: TranslationInterface) => void): TranslationCollection {
 		Object.keys(this.values).forEach((key) => callback.call(this, key, this.values[key]));
 		return this;
 	}
 
-	public filter(callback: (key?: string, val?: string) => boolean): TranslationCollection {
+	public filter(callback: (key?: string, val?: TranslationInterface) => boolean): TranslationCollection {
 		const values: TranslationType = {};
 		this.forEach((key, val) => {
 			if (callback.call(this, key, val)) {
@@ -37,7 +53,7 @@ export class TranslationCollection {
 		return new TranslationCollection(values);
 	}
 
-	public map(callback: (key?: string, val?: string) => string): TranslationCollection {
+	public map(callback: (key?: string, val?: TranslationInterface) => TranslationInterface): TranslationCollection {
 		const values: TranslationType = {};
 		this.forEach((key, val) => {
 			values[key] = callback.call(this, key, val);
@@ -62,7 +78,7 @@ export class TranslationCollection {
 		return this.values.hasOwnProperty(key);
 	}
 
-	public get(key: string): string {
+	public get(key: string): TranslationInterface {
 		return this.values[key];
 	}
 
@@ -88,4 +104,10 @@ export class TranslationCollection {
 
 		return new TranslationCollection(values);
 	}
+
+	public toKeyValueObject(): {[key: string]: string} {
+		const jsonTranslations: {[key: string]: string} = {};
+		Object.entries(this.values).map(([key, value]: [string, TranslationInterface]) => jsonTranslations[key] = value.value);
+		return jsonTranslations;
+	}
 }
diff --git a/tests/compilers/namespaced-json.compiler.spec.ts b/tests/compilers/namespaced-json.compiler.spec.ts
@@ -30,27 +30,27 @@ describe('NamespacedJsonCompiler', () => {
 
 	it('should unflatten keys on compile', () => {
 		const collection = new TranslationCollection({
-			'NAMESPACE.KEY.FIRST_KEY': '',
-			'NAMESPACE.KEY.SECOND_KEY': 'VALUE'
+			'NAMESPACE.KEY.FIRST_KEY': {value: '', sourceFiles: []},
+			'NAMESPACE.KEY.SECOND_KEY': {value: 'VALUE', sourceFiles: ['path/to/file.ts']}
 		});
 		const result: string = compiler.compile(collection);
 		expect(result).to.equal('{\n\t"NAMESPACE": {\n\t\t"KEY": {\n\t\t\t"FIRST_KEY": "",\n\t\t\t"SECOND_KEY": "VALUE"\n\t\t}\n\t}\n}');
 	});
 
 	it('should preserve numeric values on compile', () => {
 		const collection = new TranslationCollection({
-			'option.0': '',
-			'option.1': '',
-			'option.2': ''
+			'option.0': {value: '', sourceFiles: []},
+			'option.1': {value: '', sourceFiles: []},
+			'option.2': {value: '', sourceFiles: []}
 		});
 		const result: string = compiler.compile(collection);
 		expect(result).to.equal('{\n\t"option": {\n\t\t"0": "",\n\t\t"1": "",\n\t\t"2": ""\n\t}\n}');
 	});
 
 	it('should use custom indentation chars', () => {
 		const collection = new TranslationCollection({
-			'NAMESPACE.KEY.FIRST_KEY': '',
-			'NAMESPACE.KEY.SECOND_KEY': 'VALUE'
+			'NAMESPACE.KEY.FIRST_KEY': {value: '', sourceFiles: []},
+			'NAMESPACE.KEY.SECOND_KEY': {value: 'VALUE', sourceFiles: ['path/to/file.ts']}
 		});
 		const customCompiler = new NamespacedJsonCompiler({
 			indentation: '  '
@@ -61,8 +61,8 @@ describe('NamespacedJsonCompiler', () => {
 
 	it('should not reorder keys when compiled', () => {
 		const collection = new TranslationCollection({
-			BROWSE: '',
-			LOGIN: ''
+			BROWSE: {value: '', sourceFiles: []},
+			LOGIN: {value: '', sourceFiles: []}
 		});
 		const result: string = compiler.compile(collection);
 		expect(result).to.equal('{\n\t"BROWSE": "",\n\t"LOGIN": ""\n}');
diff --git a/tests/compilers/po.compiler.spec.ts b/tests/compilers/po.compiler.spec.ts
@@ -12,13 +12,23 @@ describe('PoCompiler', () => {
 
 	it('should still include html ', () => {
 		const collection = new TranslationCollection({
-			'A <strong>test</strong>': 'Un <strong>test</strong>',
-			'With a lot of <em>html</em> included': 'Avec beaucoup d\'<em>html</em> inclus'
+			'A <strong>test</strong>': {value: 'Un <strong>test</strong>', sourceFiles: ['path/to/file.ts', 'path/to/other/file.ts']},
+			'With a lot of <em>html</em> included': {value: 'Avec beaucoup d\'<em>html</em> inclus', sourceFiles: ['path/to/file.ts']}
 		});
 		const result: Buffer = Buffer.from(compiler.compile(collection));
-		expect(result.toString('utf8')).to.equal('msgid ""\nmsgstr ""\n"mime-version: 1.0\\n"\n"Content-Type: text/plain; charset=utf-8\\n"\n"Content-Transfer-Encoding: 8bit\\n"\n\nmsgid "A <strong>test</strong>"\nmsgstr "Un <strong>test</strong>"\n\nmsgid "With a lot of <em>html</em> included"\nmsgstr "Avec beaucoup d\'<em>html</em> inclus"');
+		expect(result.toString('utf8')).to.equal(
+			'msgid ""\n'
+			+ 'msgstr ""\n"'
+			+ 'mime-version: 1.0\\n"\n"'
+			+ 'Content-Type: text/plain; charset=utf-8\\n"\n"'
+			+ 'Content-Transfer-Encoding: 8bit\\n"\n\n'
+			+ '#: path/to/file.ts\n'
+			+ '#: path/to/other/file.ts\n'
+			+ 'msgid "A <strong>test</strong>"\n'
+			+ 'msgstr "Un <strong>test</strong>"\n\n'
+			+ '#: path/to/file.ts\n'
+			+ 'msgid "With a lot of <em>html</em> included"\n'
+			+ 'msgstr "Avec beaucoup d\'<em>html</em> inclus"'
+		);
 	});
 });
-
-
-
diff --git a/tests/parsers/service.parser.spec.ts b/tests/parsers/service.parser.spec.ts
@@ -51,7 +51,7 @@ describe('ServiceParser', () => {
 		expect(keys).to.deep.equal(['Fallback message']);
 	});
 
-	it("should extract strings in TranslateService's get() method", () => {
+	it('should extract strings in TranslateService\'s get() method', () => {
 		const contents = `
 			@Component({ })
 			export class AppComponent {
@@ -64,7 +64,7 @@ describe('ServiceParser', () => {
 		expect(keys).to.deep.equal(['Hello World']);
 	});
 
-	it("should extract strings in TranslateService's instant() method", () => {
+	it('should extract strings in TranslateService\'s instant() method', () => {
 		const contents = `
 			@Component({ })
 			export class AppComponent {
@@ -77,7 +77,7 @@ describe('ServiceParser', () => {
 		expect(keys).to.deep.equal(['Hello World']);
 	});
 
-	it("should extract strings in TranslateService's stream() method", () => {
+	it('should extract strings in TranslateService\'s stream() method', () => {
 		const contents = `
 			@Component({ })
 			export class AppComponent {
@@ -90,7 +90,7 @@ describe('ServiceParser', () => {
 		expect(keys).to.deep.equal(['Hello World']);
 	});
 
-	it("should extract array of strings in TranslateService's get() method", () => {
+	it('should extract array of strings in TranslateService\'s get() method', () => {
 		const contents = `
 			@Component({ })
 			export class AppComponent {
@@ -103,7 +103,7 @@ describe('ServiceParser', () => {
 		expect(keys).to.deep.equal(['Hello', 'World']);
 	});
 
-	it("should extract array of strings in TranslateService's instant() method", () => {
+	it('should extract array of strings in TranslateService\'s instant() method', () => {
 		const contents = `
 			@Component({ })
 			export class AppComponent {
@@ -116,7 +116,7 @@ describe('ServiceParser', () => {
 		expect(key).to.deep.equal(['Hello', 'World']);
 	});
 
-	it("should extract array of strings in TranslateService's stream() method", () => {
+	it('should extract array of strings in TranslateService\'s stream() method', () => {
 		const contents = `
 			@Component({ })
 			export class AppComponent {
diff --git a/tests/post-processors/key-as-default-value.post-processor.spec.ts b/tests/post-processors/key-as-default-value.post-processor.spec.ts
diff --git a/tests/post-processors/null-as-default-value.post-processor.spec.ts b/tests/post-processors/null-as-default-value.post-processor.spec.ts
diff --git a/tests/post-processors/purge-obsolete-keys.post-processor.spec.ts b/tests/post-processors/purge-obsolete-keys.post-processor.spec.ts
diff --git a/tests/post-processors/sort-by-key.post-processor.spec.ts b/tests/post-processors/sort-by-key.post-processor.spec.ts
diff --git a/tests/post-processors/string-as-default-value.post-processor.spec.ts b/tests/post-processors/string-as-default-value.post-processor.spec.ts
diff --git a/tests/utils/translation.collection.spec.ts b/tests/utils/translation.collection.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`import { CompilerInterface } from './compiler.interface.js';`
`2`		`-import { TranslationCollection } from '../utils/translation.collection.js';`
	`2`	`+import {TranslationCollection, TranslationInterface} from '../utils/translation.collection.js';`
`3`	`3`	`import { stripBOM } from '../utils/utils.js';`
`4`	`4`
`5`	`5`	`import pkg from 'flat';`
`@@ -17,7 +17,7 @@ export class JsonCompiler implements CompilerInterface {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`public compile(collection: TranslationCollection): string {`
`20`		`- return JSON.stringify(collection.values, null, this.indentation);`
	`20`	`+ return JSON.stringify(collection.toKeyValueObject(), null, this.indentation);`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`public parse(contents: string): TranslationCollection {`
Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,10 @@ export class NamespacedJsonCompiler implements CompilerInterface {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`public compile(collection: TranslationCollection): string {`
`20`		`- const values: {} = unflatten(collection.values, {`
`21`		`- object: true`
`22`		`- });`
	`20`	`+ const values: {} = unflatten(`
	`21`	`+ collection.toKeyValueObject(),`
	`22`	`+ {object: true}`
	`23`	`+ );`
`23`	`24`	`return JSON.stringify(values, null, this.indentation);`
`24`	`25`	`}`
`25`	`26`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ export class FunctionParser implements ParserInterface {`
`26`	`26`	`return;`
`27`	`27`	`}`
`28`	`28`	`const strings = getStringsFromExpression(firstArg);`
`29`		`- collection = collection.addKeys(strings);`
	`29`	`+ collection = collection.addKeys(strings, filePath);`
`30`	`30`	`});`
`31`	`31`	`return collection;`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ export class MarkerParser implements ParserInterface {`
`25`	`25`	`return;`
`26`	`26`	`}`
`27`	`27`	`const strings = getStringsFromExpression(firstArg);`
`28`		`- collection = collection.addKeys(strings);`
	`28`	`+ collection = collection.addKeys(strings, filePath);`
`29`	`29`	`});`
`30`	`30`	`return collection;`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ export class ServiceParser implements ParserInterface {`
`39`	`39`	`return;`
`40`	`40`	`}`
`41`	`41`	`const strings = getStringsFromExpression(firstArg);`
`42`		`- collection = collection.addKeys(strings);`
	`42`	`+ collection = collection.addKeys(strings, filePath);`
`43`	`43`	`});`
`44`	`44`	`});`
`45`	`45`	`return collection;`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`		`-import { TranslationCollection } from '../utils/translation.collection.js';`
	`1`	`+import {TranslationCollection, TranslationInterface} from '../utils/translation.collection.js';`
`2`	`2`	`import { PostProcessorInterface } from './post-processor.interface.js';`
`3`	`3`
`4`	`4`	`export class KeyAsDefaultValuePostProcessor implements PostProcessorInterface {`
`5`	`5`	`public name: string = 'KeyAsDefaultValue';`
`6`	`6`
`7`	`7`	`public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {`
`8`		`- return draft.map((key, val) => (val === '' ? key : val));`
	`8`	`+ return draft.map((key: string, val: TranslationInterface): TranslationInterface => val.value === '' ? {value: key, sourceFiles: (val?.sourceFiles \|\| [])} : val);`
`9`	`9`	`}`
`10`	`10`	`}`