feat: Add po-source-locations CLI option

The `--po-source-locations` option controls whether to include file location
comments in `.po` files. Defaults to `true`.

`--po-source-locations=false` or `--no-po-source-locations`: Excludes location comments.

Closes #63

.gitignore

@@ -9,6 +9,7 @@ npm-debug.log*
 # Compiled files
 src/**/*.js
 tests/**/*.js
+tests/cli/tmp
 dist
 
 # Extracted strings

README.md

@@ -120,10 +120,11 @@ Output
   --format, -f                Format        [string] [choices: "json", "namespaced-json", "pot"] [default: "json"]
   --format-indentation, --fi  Format indentation (JSON/Namedspaced JSON)                  [string] [default: "\t"]
   --sort, -s                  Sort strings in alphabetical order                                         [boolean]
-  --sort-sensitivity, -ss     Sensitivity when sorting strings (only when sort is enabled)				 [string]
+  --sort-sensitivity, -ss     Sensitivity when sorting strings (only when sort is enabled)               [string]
   --clean, -c                 Remove obsolete strings after merge                                        [boolean]
   --replace, -r               Replace the contents of output file if it exists (Merges by default)       [boolean]
   --strip-prefix, -sp         Strip prefix from key                                                       [string]
+  --po-source-locations       Include file location comments in .po files                [boolean] [default: true]
 
 Extracted key value (defaults to empty string)
   --key-as-default-value, -k           Use key as default value                                          [boolean]

src/cli/cli.ts

@@ -88,6 +88,11 @@ const cli = await y
 		choices: ['base', 'accent', 'case', 'variant'],
 		default: undefined
 	})
+	.option('po-source-locations', {
+		describe: 'Include file location comments in .po files',
+		type: 'boolean',
+		default: true,
+	})
 	.option('clean', {
 		alias: 'c',
 		describe: 'Remove obsolete strings after merge',
@@ -132,7 +137,7 @@ const cli = await y
 		describe: 'Strip a prefix from the extracted key',
 		type: 'string'
 	})
-	.group(['format', 'format-indentation', 'sort', 'sort-sensitivity', 'clean', 'replace', 'strip-prefix'], 'Output')
+	.group(['format', 'format-indentation', 'sort', 'sort-sensitivity', 'clean', 'replace', 'strip-prefix', 'no-po-source-locations'], 'Output')
 	.group(['key-as-default-value', 'key-as-initial-default-value', 'null-as-default-value', 'string-as-default-value'], 'Extracted key value (defaults to empty string)')
 	.conflicts('key-as-default-value', 'null-as-default-value')
 	.conflicts('key-as-initial-default-value', 'null-as-default-value')
@@ -190,7 +195,8 @@ extractTask.setPostProcessors(postProcessors);
 
 // Compiler
 const compiler: CompilerInterface = CompilerFactory.create(cli.format, {
-	indentation: cli.formatIndentation
+	indentation: cli.formatIndentation,
+	poSourceLocation: cli.poSourceLocations,
 });
 extractTask.setCompiler(compiler);
 

src/compilers/compiler.factory.ts

@@ -1,10 +1,10 @@
-import { CompilerInterface } from './compiler.interface.js';
+import { CompilerInterface, CompilerOptions } from './compiler.interface.js';
 import { JsonCompiler } from './json.compiler.js';
 import { NamespacedJsonCompiler } from './namespaced-json.compiler.js';
 import { PoCompiler } from './po.compiler.js';
 
 export class CompilerFactory {
-	public static create(format: string, options?: {}): CompilerInterface {
+	public static create(format: string, options?: CompilerOptions): CompilerInterface {
 		switch (format) {
 			case 'pot':
 				return new PoCompiler(options);

src/compilers/compiler.interface.ts

@@ -1,5 +1,10 @@
 import { TranslationCollection } from '../utils/translation.collection.js';
 
+export interface CompilerOptions {
+	indentation?: string;
+	poSourceLocation?: boolean;
+}
+
 export interface CompilerInterface {
 	extension: string;
 

src/compilers/json.compiler.ts

@@ -1,4 +1,4 @@
-import { CompilerInterface } from './compiler.interface.js';
+import { CompilerInterface, CompilerOptions } from './compiler.interface.js';
 import {TranslationCollection, TranslationInterface, TranslationType} from '../utils/translation.collection.js';
 import { stripBOM } from '../utils/utils.js';
 
@@ -9,7 +9,7 @@ export class JsonCompiler implements CompilerInterface {
 
 	public extension: string = 'json';
 
-	public constructor(options?: any) {
+	constructor(options?: CompilerOptions) {
 		if (options && typeof options.indentation !== 'undefined') {
 			this.indentation = options.indentation;
 		}

src/compilers/namespaced-json.compiler.ts

@@ -1,4 +1,4 @@
-import { CompilerInterface } from './compiler.interface.js';
+import { CompilerInterface, CompilerOptions } from './compiler.interface.js';
 import {TranslationCollection, TranslationInterface, TranslationType} from '../utils/translation.collection.js';
 import { stripBOM } from '../utils/utils.js';
 
@@ -9,7 +9,7 @@ export class NamespacedJsonCompiler implements CompilerInterface {
 
 	public extension = 'json';
 
-	public constructor(options?: any) {
+	constructor(options?: CompilerOptions) {
 		if (options && typeof options.indentation !== 'undefined') {
 			this.indentation = options.indentation;
 		}

src/compilers/po.compiler.ts

@@ -1,4 +1,4 @@
-import { CompilerInterface } from './compiler.interface.js';
+import { CompilerInterface, CompilerOptions } from './compiler.interface.js';
 import {TranslationCollection, TranslationInterface, TranslationType} from '../utils/translation.collection.js';
 
 import pkg from 'gettext-parser';
@@ -12,7 +12,12 @@ export class PoCompiler implements CompilerInterface {
 	 */
 	public domain: string = '';
 
-	public constructor(options?: any) {}
+	/** Whether to include file location comments. **/
+	private readonly includeSources: boolean = true;
+
+	constructor(options?: CompilerOptions) {
+		this.includeSources = options?.poSourceLocation ?? true;
+	}
 
 	public compile(collection: TranslationCollection): string {
 		const data = {
@@ -27,16 +32,17 @@ export class PoCompiler implements CompilerInterface {
 					.reduce(
 						(translations, key) => {
 							const entry: TranslationInterface = collection.get(key);
+							const comments = this.includeSources ? {reference: entry.sourceFiles?.join('\n')} : undefined;
 							return {
 								...translations,
 								[key]: {
 									msgid: key,
 									msgstr: entry.value,
-									comments: {reference: entry.sourceFiles?.join('\n')}
+									comments: comments
 								}
 							};
 						},
-						{} as any
+						{}
 					)
 			}
 		};

tests/cli/__snapshots__/cli.spec.ts.snap

@@ -87,3 +87,56 @@ msgstr ""
 msgid "marker.dashboard.description"
 msgstr """
 `;
+
+exports[`CLI Integration Tests > extracts translation keys to a .po file without file location comments 1`] = `
+"msgid ""
+msgstr ""
+"mime-version: 1.0\\n"
+"Content-Type: text/plain; charset=utf-8\\n"
+"Content-Transfer-Encoding: 8bit\\n"
+
+msgid "translate-service.comp.welcome"
+msgstr ""
+
+msgid "translate-service.comp.description"
+msgstr ""
+
+msgid "translate-service.comp.details"
+msgstr ""
+
+msgid "translate-service.comp.show-more-label"
+msgstr ""
+
+msgid "translate-service.comp.show-less-label"
+msgstr ""
+
+msgid "pipe.comp.welcome"
+msgstr ""
+
+msgid "pipe.comp.description"
+msgstr ""
+
+msgid "directive.comp.welcome"
+msgstr ""
+
+msgid "directive.comp.description"
+msgstr ""
+
+msgid "private-translate-service.comp.welcome"
+msgstr ""
+
+msgid "private-translate-service.comp.description"
+msgstr ""
+
+msgid "ngx-translate.marker.dashboard.title"
+msgstr ""
+
+msgid "ngx-translate.marker.dashboard.description"
+msgstr ""
+
+msgid "marker.dashboard.title"
+msgstr ""
+
+msgid "marker.dashboard.description"
+msgstr """
+`;

tests/cli/cli.spec.ts

@@ -63,4 +63,13 @@ describe.concurrent('CLI Integration Tests', () => {
 
 		expect(extracted).toMatchSnapshot();
 	});
+
+	test('extracts translation keys to a .po file without file location comments', async ({ expect }) => {
+		const OUTPUT_FILE = createUniqueFileName('strings.po');
+		await execAsync(`node ${CLI_PATH} --input ${FIXTURES_PATH} --output ${OUTPUT_FILE} --format=pot --no-po-source-locations`);
+
+		const extracted = await readFile(OUTPUT_FILE, { encoding: 'utf8' });
+
+		expect(extracted).toMatchSnapshot();
+	});
 });