(bugfix) extract strings encapsulated with backticks. Closes #139

- (feat) add 'key as default value' post processor (closes #109)
- (chore) move clean functionality to a post processor
- (chore) move sort functionality to a post processor
- (refactor) get rid of leading underscore on protected properties/methods

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: #biesbjerg
+custom: https://donate.biesbjerg.com

README.md

@@ -1,72 +1,84 @@
-If you like this project please show your support with a GitHub star. Much appreciated!
+If this tool saves you time, please consider making a donation towards the continued maintainence and development: https://donate.biesbjerg.com
 
-# ngx-translate-extract
+[![Donate](images/donate-badge.png)](https://donate.biesbjerg.com)
+
+# Usage
+
+## ngx-translate-extract
 Extract translatable (ngx-translate) strings and save as a JSON or Gettext pot file.
 Merges with existing strings if the output file already exists.
 
-## Usage
+### Usage
 Install the package in your project:
 
 `npm install @biesbjerg/ngx-translate-extract --save-dev`
 
-Add an `extract` script to your project's `package.json`:
-```
+Add a script to your project's `package.json`:
+```json
+...
 "scripts": {
-  "extract": "ngx-translate-extract --input ./src --output ./src/assets/i18n/*.json --clean --sort --format namespaced-json"
+  "extract-i18n": "ngx-translate-extract --input ./src --output ./src/assets/i18n/ --clean --sort --format namespaced-json"
 }
+...
 ```
-You can now run `npm run extract` to extract strings.
+You can now run `npm run extract-i18n` and it will extract strings from your project.
 
-## Extract examples
+### Examples
 
 **Extract from dir and save to file**
 
-`ngx-translate-extract -i ./src -o ./src/i18n/strings.json`
+`ngx-translate-extract --input ./src --output ./src/assets/i18n/template.json`
 
 **Extract from multiple dirs**
 
-`ngx-translate-extract -i ./src/folder-a ./src/folder-b -o ./src/i18n/strings.json`
+`ngx-translate-extract --input ./src-a ./src-b --output ./src/assets/i18n/template.json`
 
-**Extract and save to multiple files**
 
-`ngx-translate-extract -i ./src -o ./src/i18n/{da,en,fr}.json`
+**Extract and save to multiple files using path expansion**
 
-**or**
+_Note: This method does not work on Windows!_
 
-`ngx-translate-extract -i ./src -o ./src/i18n/da.json ./src/i18n/en.json ./src/i18n/fr.json`
+`ngx-translate-extract --input ./src --output ./src/i18n/{da,en}.json`
 
-**or (update only)**
+On Windows you must specify each output destination individually:
 
-`ngx-translate-extract -i ./src -o ./src/i18n/*.json`
+`ngx-translate-extract --input ./src --output ./src/i18n/da.json ./src/i18n/en.json`
 
-**or (update only)**
-
-## Custom indentation
-By default, tabs are used for indentation when writing extracted strings to json formats:
-
-`ngx-translate-extract -i ./src -o ./src/i18n/en.json --format-indentation $'\t'`
+### JSON indentation
+Tabs are used by default for indentation when saving extracted strings in json formats:
 
 If you want to use spaces instead, you can do the following:
 
-`ngx-translate-extract -i ./src -o ./src/i18n/en.json --format-indentation '  '`
+`ngx-translate-extract --input ./src --output ./src/i18n/en.json --format-indentation '  '`
 
 ## Mark strings for extraction using a marker function
-If, for some reason, you want to extract strings not passed directly to TranslateService, you can wrap them in a custom marker function.
+If, for some reason, you want to extract strings not passed directly to `TranslateService`'s `get()` or `instant()` methods, you can wrap them in a custom marker function to let `ngx-translate-extract` know you want to extract them.
+
+Install marker function:
+`npm install @biesbjerg/ngx-translate-extract-marker`
 
 ```ts
-import { _ } from '@biesbjerg/ngx-translate-extract';
+import { marker } from '@biesbjerg/ngx-translate-extract-marker';
 
-_('Extract me');
+marker('Extract me');
 ```
 
 Add the `marker` argument when running the extract script:
 
+`ngx-translate-extract ... -m extract`
+
+You can alias the marker function if needed:
+
+```ts
+import { marker as _ } from '@biesbjerg/ngx-translate-extract-marker';
+
+_('Extract me');
+```
+
 `ngx-translate-extract ... -m _`
 
-Modify the scripts arguments as required.
-
 ## Commandline arguments
-```
+```shell
 Usage:
 ngx-translate-extract [options]
 
@@ -76,7 +88,7 @@ Options:
   --input, -i                 Paths you would like to extract strings from. You
                               can use path expansion, glob patterns and multiple
                               paths
-                     [array] [default: current working path]
+                      [array] [default: current working path]
   --patterns, -p              Extract strings from the following file patterns
                                     [array] [default: ["/**/*.html","/**/*.ts"]]
   --output, -o                Paths where you would like to save extracted
@@ -86,12 +98,12 @@ Options:
                                                        [string] [default: false]
   --format, -f                Output format
           [string] [choices: "json", "namespaced-json", "pot"] [default: "json"]
-  --format-indentation, --fi  Output format indentation [string] [default: "\t"]
+  --format-indentation, --fi  Output format indentation   [string] [default: "	"]
   --replace, -r               Replace the contents of output file if it exists
                               (Merges by default)     [boolean] [default: false]
   --sort, -s                  Sort strings in alphabetical order when saving
                                                       [boolean] [default: false]
   --clean, -c                 Remove obsolete strings when merging
                                                       [boolean] [default: false]
-  --verbose, -vb              If true, prints all processed file paths to console
-                                                      [boolean] [default: true]
+  --key-as-default-value, -k  Use key as default value for translations
+                                                      [boolean] [default: false]

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@biesbjerg/ngx-translate-extract",
-  "version": "2.3.3",
+  "version": "3.0.4",
   "description": "Extract strings from projects using ngx-translate",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -24,10 +24,7 @@
   },
   "keywords": [
     "angular",
-    "angular2",
     "ionic",
-    "ionic2",
-    "ng2-translate",
     "ngx-translate",
     "extract",
     "extractor",
@@ -47,30 +44,29 @@
   },
   "config": {},
   "devDependencies": {
-    "@types/chai": "4.0.1",
-    "@types/glob": "5.0.30",
-    "@types/mocha": "2.2.41",
-    "@types/cheerio": "0.22.1",
-    "@types/chalk": "0.4.31",
-    "@types/flat": "0.0.28",
-    "@types/yargs": "8.0.0",
-    "@types/mkdirp": "0.3.29",
-    "chai": "4.0.2",
-    "mocha": "3.4.2",
-    "ts-node": "3.1.0",
-    "tslint": "5.4.3",
-    "tslint-eslint-rules": "4.1.1"
+    "@types/chai": "^4.2.0",
+    "@types/flat": "^0.0.28",
+    "@types/glob": "^7.1.1",
+    "@types/mkdirp": "^0.5.2",
+    "@types/mocha": "^5.2.7",
+    "@types/yargs": "^13.0.2",
+    "chai": "^4.2.0",
+    "mocha": "^6.2.0",
+    "ts-node": "^8.3.0",
+    "tslint": "^5.19.0",
+    "tslint-eslint-rules": "^5.4.0"
   },
   "dependencies": {
-    "chalk": "2.0.1",
-    "yargs": "8.0.2",
-    "cheerio": "1.0.0-rc.2",
-    "fs": "0.0.1-security",
-    "gettext-parser": "1.2.2",
-    "glob": "7.1.2",
-    "path": "0.12.7",
-    "mkdirp": "0.5.1",
-    "flat": "2.0.1",
-    "typescript": "2.4.1"
+    "@angular/compiler": "^8.2.2",
+    "boxen": "^4.1.0",
+    "colorette": "^1.1.0",
+    "flat": "github:lenchvolodymyr/flat#ffe77ef",
+    "gettext-parser": "^4.0.1",
+    "glob": "^7.1.4",
+    "mkdirp": "^0.5.1",
+    "path": "^0.12.7",
+    "terminal-link": "^1.3.0",
+    "typescript": "^3.5.3",
+    "yargs": "^14.0.0"
   }
 }

src/cli/cli.ts

@@ -1,14 +1,19 @@
+import * as fs from 'fs';
+import * as yargs from 'yargs';
+
 import { ExtractTask } from './tasks/extract.task';
 import { ParserInterface } from '../parsers/parser.interface';
 import { PipeParser } from '../parsers/pipe.parser';
 import { DirectiveParser } from '../parsers/directive.parser';
 import { ServiceParser } from '../parsers/service.parser';
 import { FunctionParser } from '../parsers/function.parser';
+import { PostProcessorInterface } from '../post-processors/post-processor.interface';
+import { SortByKeyPostProcessor } from '../post-processors/sort-by-key.post-processor';
+import { KeyAsDefaultValuePostProcessor } from '../post-processors/key-as-default-value.post-processor';
+import { PurgeObsoleteKeysPostProcessor } from '../post-processors/purge-obsolete-keys.post-processor';
 import { CompilerInterface } from '../compilers/compiler.interface';
 import { CompilerFactory } from '../compilers/compiler.factory';
-
-import * as fs from 'fs';
-import * as yargs from 'yargs';
+import { donateMessage } from '../utils/donate';
 
 export const cli = yargs
 	.usage('Extract strings from files for translation.\nUsage: $0 [options]')
@@ -82,27 +87,21 @@ export const cli = yargs
 		default: false,
 		type: 'boolean'
 	})
-	.option('verbose', {
-		alias: 'vb',
-		describe: 'Log all output to console',
-		default: true,
+	.option('key-as-default-value', {
+		alias: 'k',
+		describe: 'Use key as default value for translations',
+		default: false,
 		type: 'boolean'
 	})
 	.exitProcess(true)
 	.parse(process.argv);
 
-const extract = new ExtractTask(cli.input, cli.output, {
+const extractTask = new ExtractTask(cli.input, cli.output, {
 	replace: cli.replace,
-	sort: cli.sort,
-	clean: cli.clean,
 	patterns: cli.patterns
 });
 
-const compiler: CompilerInterface = CompilerFactory.create(cli.format, {
-	indentation: cli.formatIndentation
-});
-extract.setCompiler(compiler);
-
+// Parsers
 const parsers: ParserInterface[] = [
 	new PipeParser(),
 	new DirectiveParser(),
@@ -113,6 +112,27 @@ if (cli.marker) {
 		identifier: cli.marker
 	}));
 }
-extract.setParsers(parsers);
+extractTask.setParsers(parsers);
 
-extract.execute();
+// Post processors
+const postProcessors: PostProcessorInterface[] = [];
+if (cli.clean) {
+	postProcessors.push(new PurgeObsoleteKeysPostProcessor());
+}
+if (cli.keyAsDefaultValue) {
+	postProcessors.push(new KeyAsDefaultValuePostProcessor());
+}
+if (cli.sort) {
+	postProcessors.push(new SortByKeyPostProcessor());
+}
+extractTask.setPostProcessors(postProcessors);
+
+// Compiler
+const compiler: CompilerInterface = CompilerFactory.create(cli.format, {
+	indentation: cli.formatIndentation
+});
+extractTask.setCompiler(compiler);
+
+extractTask.execute();
+
+console.log(donateMessage);

src/cli/tasks/extract.task.ts

@@ -1,9 +1,10 @@
 import { TranslationCollection } from '../../utils/translation.collection';
 import { TaskInterface } from './task.interface';
 import { ParserInterface } from '../../parsers/parser.interface';
+import { PostProcessorInterface } from '../../post-processors/post-processor.interface';
 import { CompilerInterface } from '../../compilers/compiler.interface';
 
-import * as chalk from 'chalk';
+import { cyan, green, bold, dim } from 'colorette';
 import * as glob from 'glob';
 import * as fs from 'fs';
 import * as path from 'path';
@@ -11,128 +12,133 @@ import * as mkdirp from 'mkdirp';
 
 export interface ExtractTaskOptionsInterface {
 	replace?: boolean;
-	sort?: boolean;
-	clean?: boolean;
 	patterns?: string[];
-	verbose?: boolean;
 }
 
 export class ExtractTask implements TaskInterface {
 
-	protected _options: ExtractTaskOptionsInterface = {
+	protected options: ExtractTaskOptionsInterface = {
 		replace: false,
-		sort: false,
-		clean: false,
-		patterns: [],
-		verbose: true
+		patterns: []
 	};
 
-	protected _parsers: ParserInterface[] = [];
-	protected _compiler: CompilerInterface;
+	protected parsers: ParserInterface[] = [];
+	protected postProcessors: PostProcessorInterface[] = [];
+	protected compiler: CompilerInterface;
 
-	public constructor(protected _input: string[], protected _output: string[], options?: ExtractTaskOptionsInterface) {
-		this._options = Object.assign({}, this._options, options);
+	public constructor(protected inputs: string[], protected outputs: string[], options?: ExtractTaskOptionsInterface) {
+		this.inputs = inputs.map(input => path.resolve(input));
+		this.outputs = outputs.map(output => path.resolve(output));
+		this.options = { ...this.options, ...options };
 	}
 
 	public execute(): void {
-		if (!this._parsers) {
-			throw new Error('No parsers configured');
-		}
-		if (!this._compiler) {
+		if (!this.compiler) {
 			throw new Error('No compiler configured');
 		}
 
-		const collection = this._extract();
-		this._out(chalk.green('Extracted %d strings\n'), collection.count());
-		this._save(collection);
+		this.printEnabledParsers();
+		this.printEnabledPostProcessors();
+		this.printEnabledCompiler();
+
+		this.out(bold('Extracting:'));
+		const extracted = this.extract();
+		this.out(green(`\nFound %d strings.\n`), extracted.count());
+
+		this.out(bold('Saving:'));
+
+		this.outputs.forEach(output => {
+			let dir: string = output;
+			let filename: string = `strings.${this.compiler.extension}`;
+			if (!fs.existsSync(output) || !fs.statSync(output).isDirectory()) {
+				dir = path.dirname(output);
+				filename = path.basename(output);
+			}
+
+			const outputPath: string = path.join(dir, filename);
+
+			let existing: TranslationCollection = new TranslationCollection();
+			if (!this.options.replace && fs.existsSync(outputPath)) {
+				existing = this.compiler.parse(fs.readFileSync(outputPath, 'utf-8'));
+			}
+
+			// merge extracted strings with existing
+			const draft = extracted.union(existing);
+
+			if (existing.isEmpty()) {
+				this.out(dim(`- ${outputPath}`));
+			} else {
+				this.out(dim(`- ${outputPath} (merged)`));
+			}
+
+			// Run collection through post processors
+			const final = this.process(draft, extracted, existing);
+
+			// Save to file
+			this.save(outputPath, final);
+		});
+
+		this.out(green('\nDone.\n'));
 	}
 
 	public setParsers(parsers: ParserInterface[]): this {
-		this._parsers = parsers;
+		this.parsers = parsers;
+		return this;
+	}
+
+	public setPostProcessors(postProcessors: PostProcessorInterface[]): this {
+		this.postProcessors = postProcessors;
 		return this;
 	}
 
 	public setCompiler(compiler: CompilerInterface): this {
-		this._compiler = compiler;
+		this.compiler = compiler;
 		return this;
 	}
 
 	/**
-	 * Extract strings from input dirs using configured parsers
+	 * Extract strings from specified input dirs using configured parsers
 	 */
-	protected _extract(): TranslationCollection {
-		this._out(chalk.bold('Extracting strings...'));
-
-		let collection: TranslationCollection = new TranslationCollection();
-		this._input.forEach(dir => {
-			this._readDir(dir, this._options.patterns).forEach(path => {
-				this._options.verbose && this._out(chalk.gray('- %s'), path);
+	protected extract(): TranslationCollection {
+		let extracted: TranslationCollection = new TranslationCollection();
+		this.inputs.forEach(dir => {
+			this.readDir(dir, this.options.patterns).forEach(path => {
+				this.out(dim('- %s'), path);
 				const contents: string = fs.readFileSync(path, 'utf-8');
-				this._parsers.forEach((parser: ParserInterface) => {
-					collection = collection.union(parser.extract(contents, path));
+				this.parsers.forEach(parser => {
+					extracted = extracted.union(parser.extract(contents, path));
 				});
 			});
 		});
-
-		return collection;
+		return extracted;
 	}
 
 	/**
-	 * Process collection according to options (merge, clean, sort), compile and save
+	 * Run strings through configured post processors
+	 */
+	protected process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
+		this.postProcessors.forEach(postProcessor => {
+			draft = postProcessor.process(draft, extracted, existing);
+		});
+		return draft;
+	}
+
+	/**
+	 * Compile and save translations
 	 * @param collection
 	 */
-	protected _save(collection: TranslationCollection): void {
-		this._output.forEach(output => {
-			const normalizedOutput: string = path.resolve(output);
-
-			let dir: string = normalizedOutput;
-			let filename: string = `strings.${this._compiler.extension}`;
-			if (!fs.existsSync(normalizedOutput) || !fs.statSync(normalizedOutput).isDirectory()) {
-				dir = path.dirname(normalizedOutput);
-				filename = path.basename(normalizedOutput);
-			}
-
-			const outputPath: string = path.join(dir, filename);
-			let processedCollection: TranslationCollection = collection;
-
-			this._out(chalk.bold('\nSaving: %s'), outputPath);
-
-			if (fs.existsSync(outputPath) && !this._options.replace) {
-				const existingCollection: TranslationCollection = this._compiler.parse(fs.readFileSync(outputPath, 'utf-8'));
-				if (!existingCollection.isEmpty()) {
-					processedCollection = processedCollection.union(existingCollection);
-					this._out(chalk.dim('- merged with %d existing strings'), existingCollection.count());
-				}
-
-				if (this._options.clean) {
-					const collectionCount = processedCollection.count();
-					processedCollection = processedCollection.intersect(collection);
-					const removeCount = collectionCount - processedCollection.count();
-					if (removeCount > 0) {
-						this._out(chalk.dim('- removed %d obsolete strings'), removeCount);
-					}
-				}
-			}
-
-			if (this._options.sort) {
-				processedCollection = processedCollection.sort();
-				this._out(chalk.dim('- sorted strings'));
-			}
-
-			if (!fs.existsSync(dir)) {
-				mkdirp.sync(dir);
-				this._out(chalk.dim('- created dir: %s'), dir);
-			}
-			fs.writeFileSync(outputPath, this._compiler.compile(processedCollection));
-
-			this._out(chalk.green('Done!'));
-		});
+	protected save(output: string, collection: TranslationCollection): void {
+		const dir = path.dirname(output);
+		if (!fs.existsSync(dir)) {
+			mkdirp.sync(dir);
+		}
+		fs.writeFileSync(output, this.compiler.compile(collection));
 	}
 
 	/**
 	 * Get all files in dir matching patterns
 	 */
-	protected _readDir(dir: string, patterns: string[]): string[] {
+	protected readDir(dir: string, patterns: string[]): string[] {
 		return patterns.reduce((results, pattern) => {
 			return glob.sync(dir + pattern)
 				.filter(path => fs.statSync(path).isFile())
@@ -140,8 +146,34 @@ export class ExtractTask implements TaskInterface {
 		}, []);
 	}
 
-	protected _out(...args: any[]): void {
+	protected out(...args: any[]): void {
 		console.log.apply(this, arguments);
 	}
 
+	protected printEnabledParsers(): void {
+		this.out(cyan('Enabled parsers:'));
+		if (this.parsers.length) {
+			this.out(cyan(dim(this.parsers.map(parser => `- ${parser.constructor.name}`).join('\n'))));
+		} else {
+			this.out(cyan(dim('(none)')));
+		}
+		this.out();
+	}
+
+	protected printEnabledPostProcessors(): void {
+		this.out(cyan('Enabled post processors:'));
+		if (this.postProcessors.length) {
+			this.out(cyan(dim(this.postProcessors.map(postProcessor => `- ${postProcessor.constructor.name}`).join('\n'))));
+		} else {
+			this.out(cyan(dim('(none)')));
+		}
+		this.out();
+	}
+
+	protected printEnabledCompiler(): void {
+		this.out(cyan('Compiler:'));
+		this.out(cyan(dim(`- ${this.compiler.constructor.name}`)));
+		this.out();
+	}
+
 }

src/compilers/json.compiler.ts

@@ -1,13 +1,14 @@
 import { CompilerInterface } from './compiler.interface';
 import { TranslationCollection } from '../utils/translation.collection';
+import { stripBOM } from '../utils/utils';
 
-import * as flat from 'flat';
+import { flatten } from 'flat';
 
 export class JsonCompiler implements CompilerInterface {
 
 	public indentation: string = '\t';
 
-	public extension = 'json';
+	public extension: string = 'json';
 
 	public constructor(options?: any) {
 		if (options && typeof options.indentation !== 'undefined') {
@@ -20,14 +21,14 @@ export class JsonCompiler implements CompilerInterface {
 	}
 
 	public parse(contents: string): TranslationCollection {
-		let values: any = JSON.parse(contents);
-		if (this._isNamespacedJsonFormat(values)) {
-			values = flat.flatten(values);
+		let values: any = JSON.parse(stripBOM(contents));
+		if (this.isNamespacedJsonFormat(values)) {
+			values = flatten(values);
 		}
 		return new TranslationCollection(values);
 	}
 
-	protected _isNamespacedJsonFormat(values: any): boolean {
+	protected isNamespacedJsonFormat(values: any): boolean {
 		return Object.keys(values).some(key => typeof values[key] === 'object');
 	}
 

src/compilers/namespaced-json.compiler.ts

@@ -1,7 +1,8 @@
 import { CompilerInterface } from './compiler.interface';
 import { TranslationCollection } from '../utils/translation.collection';
+import { stripBOM } from '../utils/utils';
 
-import * as flat from 'flat';
+import { flatten, unflatten } from 'flat';
 
 export class NamespacedJsonCompiler implements CompilerInterface {
 
@@ -16,14 +17,14 @@ export class NamespacedJsonCompiler implements CompilerInterface {
 	}
 
 	public compile(collection: TranslationCollection): string {
-		const values: {} = flat.unflatten(collection.values, {
+		const values: {} = unflatten(collection.values, {
 			object: true
 		});
 		return JSON.stringify(values, null, this.indentation);
 	}
 
 	public parse(contents: string): TranslationCollection {
-		const values: {} = flat.flatten(JSON.parse(contents));
+		const values: {} = flatten(JSON.parse(stripBOM(contents)));
 		return new TranslationCollection(values);
 	}
 

src/compilers/po.compiler.ts

@@ -5,14 +5,14 @@ import * as gettext from 'gettext-parser';
 
 export class PoCompiler implements CompilerInterface {
 
-	public extension = 'po';
+	public extension: string = 'po';
 
 	/**
 	 * Translation domain
 	 */
-	public domain = '';
+	public domain: string = '';
 
-	public constructor(options?: any) { }
+	public constructor(options?: any) {}
 
 	public compile(collection: TranslationCollection): string {
 		const data = {
@@ -29,17 +29,17 @@ export class PoCompiler implements CompilerInterface {
 						msgstr: collection.get(key)
 					};
 					return translations;
-				}, <any> {})
+				}, {} as any)
 			}
 		};
 
-		return gettext.po.compile(data, 'utf-8');
+		return gettext.po.compile(data);
 	}
 
 	public parse(contents: string): TranslationCollection {
 		const collection = new TranslationCollection();
 
-		const po = gettext.po.parse(contents, 'utf-8');
+		const po = gettext.po.parse(contents, 'utf8');
 		if (!po.translations.hasOwnProperty(this.domain)) {
 			return collection;
 		}
@@ -49,7 +49,7 @@ export class PoCompiler implements CompilerInterface {
 			.reduce((values, key) => {
 				values[key] = po.translations[this.domain][key].msgstr.pop();
 				return values;
-			}, <TranslationType> {});
+			}, {} as TranslationType);
 
 		return new TranslationCollection(values);
 	}

src/index.ts

@@ -6,7 +6,6 @@ export * from './cli/tasks/task.interface';
 export * from './cli/tasks/extract.task';
 
 export * from './parsers/parser.interface';
-export * from './parsers/abstract-template.parser';
 export * from './parsers/abstract-ast.parser';
 export * from './parsers/directive.parser';
 export * from './parsers/pipe.parser';
@@ -18,3 +17,8 @@ export * from './compilers/compiler.factory';
 export * from './compilers/json.compiler';
 export * from './compilers/namespaced-json.compiler';
 export * from './compilers/po.compiler';
+
+export * from './post-processors/post-processor.interface';
+export * from './post-processors/key-as-default-value.post-processor';
+export * from './post-processors/purge-obsolete-keys.post-processor';
+export * from './post-processors/sort-by-key.post-processor';

src/parsers/abstract-ast.parser.ts

@@ -1,65 +1,48 @@
-import * as ts from 'typescript';
+import {
+	createSourceFile,
+	SourceFile,
+	CallExpression,
+	Node,
+	SyntaxKind,
+	StringLiteral,
+	NoSubstitutionTemplateLiteral
+} from 'typescript';
 
 export abstract class AbstractAstParser {
 
-	protected _sourceFile: ts.SourceFile;
+	protected sourceFile: SourceFile;
 
-	protected _createSourceFile(path: string, contents: string): ts.SourceFile {
-		return ts.createSourceFile(path, contents, null, /*setParentNodes */ false);
+	protected createSourceFile(path: string, contents: string): SourceFile {
+		return createSourceFile(path, contents, null, /*setParentNodes */ false);
 	}
 
 	/**
 	 * Get strings from function call's first argument
 	 */
-	protected _getCallArgStrings(callNode: ts.CallExpression): string[] {
+	protected getStringLiterals(callNode: CallExpression): string[] {
 		if (!callNode.arguments.length) {
-			return;
+			return[];
 		}
 
 		const firstArg = callNode.arguments[0];
-		switch (firstArg.kind) {
-			case ts.SyntaxKind.StringLiteral:
-			case ts.SyntaxKind.FirstTemplateToken:
-				return [(firstArg as ts.StringLiteral).text];
-			case ts.SyntaxKind.ArrayLiteralExpression:
-				return (firstArg as ts.ArrayLiteralExpression).elements
-					.map((element: ts.StringLiteral) => element.text);
-			case ts.SyntaxKind.Identifier:
-				console.log('WARNING: We cannot extract variable values passed to TranslateService (yet)');
-				break;
-			default:
-				console.log(`SKIP: Unknown argument type: '${this._syntaxKindToName(firstArg.kind)}'`, firstArg);
-		}
+
+		return this.findNodes(firstArg, [
+			SyntaxKind.StringLiteral,
+			SyntaxKind.NoSubstitutionTemplateLiteral
+		])
+		.map((node: StringLiteral | NoSubstitutionTemplateLiteral) => node.text);
 	}
 
 	/**
 	 * Find all child nodes of a kind
 	 */
-	protected _findNodes(node: ts.Node, kind: ts.SyntaxKind): ts.Node[] {
-		const childrenNodes: ts.Node[] = node.getChildren(this._sourceFile);
-		const initialValue: ts.Node[] = node.kind === kind ? [node] : [];
+	protected findNodes(node: Node, kinds: SyntaxKind[]): Node[] {
+		const childrenNodes: Node[] = node.getChildren(this.sourceFile);
+		const initialValue: Node[] = kinds.includes(node.kind) ? [node] : [];
 
-		return childrenNodes.reduce((result: ts.Node[], childNode: ts.Node) => {
-			return result.concat(this._findNodes(childNode, kind));
+		return childrenNodes.reduce((result: Node[], childNode: Node) => {
+			return result.concat(this.findNodes(childNode, kinds));
 		}, initialValue);
 	}
 
-	protected _syntaxKindToName(kind: ts.SyntaxKind): string {
-		return ts.SyntaxKind[kind];
-	}
-
-	protected _printAllChildren(sourceFile: ts.SourceFile, node: ts.Node, depth = 0): void {
-		console.log(
-			new Array(depth + 1).join('----'),
-			`[${node.kind}]`,
-			this._syntaxKindToName(node.kind),
-			`[pos: ${node.pos}-${node.end}]`,
-			':\t\t\t',
-			node.getFullText(sourceFile).trim()
-		);
-
-		depth++;
-		node.getChildren(sourceFile).forEach(childNode => this._printAllChildren(sourceFile, childNode, depth));
-	}
-
 }

src/parsers/abstract-template.parser.ts

@@ -1,24 +0,0 @@
-export abstract class AbstractTemplateParser {
-
-	/**
-	 * Checks if file is of type javascript or typescript and
-	 * makes the assumption that it is an Angular Component
-	 */
-	protected _isAngularComponent(path: string): boolean {
-		return (/\.ts|js$/i).test(path);
-	}
-
-	/**
-	 * Extracts inline template from components
-	 */
-	protected _extractInlineTemplate(contents: string): string {
-		const regExp: RegExp = /template\s*:\s*(["'`])([^\1]*?)\1/;
-		const match = regExp.exec(contents);
-		if (match !== null) {
-			return match[2];
-		}
-
-		return '';
-	}
-
-}

src/parsers/directive.parser.ts

@@ -1,57 +1,83 @@
 import { ParserInterface } from './parser.interface';
-import { AbstractTemplateParser } from './abstract-template.parser';
 import { TranslationCollection } from '../utils/translation.collection';
+import { isPathAngularComponent, extractComponentInlineTemplate } from '../utils/utils';
 
-import * as cheerio from 'cheerio';
+import { parseTemplate, TmplAstNode, TmplAstElement, TmplAstTextAttribute } from '@angular/compiler';
 
-const $ = cheerio.load('', {xmlMode: true});
+export class DirectiveParser implements ParserInterface {
 
-export class DirectiveParser extends AbstractTemplateParser implements ParserInterface {
-
-	public extract(contents: string, path?: string): TranslationCollection {
-		if (path && this._isAngularComponent(path)) {
-			contents = this._extractInlineTemplate(contents);
+	public extract(template: string, path: string): TranslationCollection {
+		if (path && isPathAngularComponent(path)) {
+			template = extractComponentInlineTemplate(template);
 		}
 
-		return this._parseTemplate(contents);
-	}
-
-	protected _parseTemplate(template: string): TranslationCollection {
 		let collection: TranslationCollection = new TranslationCollection();
 
-		template = this._normalizeTemplateAttributes(template);
-
-		const selector = '[translate], [ng2-translate]';
-		$(template)
-			.find(selector)
-			.addBack(selector)
-			.each((i: number, element: CheerioElement) => {
-				const $element = $(element);
-				const attr = $element.attr('translate') || $element.attr('ng2-translate');
-
-				if (attr) {
-					collection = collection.add(attr);
-				} else {
-					$element
-						.contents()
-						.toArray()
-						.filter(node => node.type === 'text')
-						.map(node => node.nodeValue.trim())
-						.filter(text => text.length > 0)
-						.forEach(text => collection = collection.add(text));
-				}
-			});
+		const nodes: TmplAstNode[] = this.parseTemplate(template, path);
+		this.getTranslatableElements(nodes).forEach(element => {
+			const key = this.getElementTranslateAttrValue(element) || this.getElementContents(element);
+			collection = collection.add(key);
+		});
 
 		return collection;
 	}
 
-	/**
-	 * Angular's `[attr]="'val'"` syntax is not valid HTML,
-	 * so it can't be parsed by standard HTML parsers.
-	 * This method replaces `[attr]="'val'""` with `attr="val"`
-	 */
-	protected _normalizeTemplateAttributes(template: string): string {
-		return template.replace(/\[([^\]]+)\]="'([^']*)'"/g, '$1="$2"');
+	protected getTranslatableElements(nodes: TmplAstNode[]): TmplAstElement[] {
+		return nodes
+			.filter(element => this.isElement(element))
+			.reduce((result: TmplAstElement[], element: TmplAstElement) => {
+				return result.concat(this.findChildrenElements(element));
+			}, [])
+			.filter(element => this.isTranslatable(element));
+	}
+
+	protected findChildrenElements(node: TmplAstNode): TmplAstElement[] {
+		if (!this.isElement(node)) {
+			return [];
+		}
+
+		// If element has translate attribute all its contents is translatable
+		// so we don't need to traverse any deeper
+		if (this.isTranslatable(node)) {
+			return [node];
+		}
+
+		return node.children.reduce((result: TmplAstElement[], childNode: TmplAstNode) => {
+			if (this.isElement(childNode)) {
+				const children = this.findChildrenElements(childNode);
+				return result.concat(children);
+			}
+			return result;
+		}, [node]);
+	}
+
+	protected parseTemplate(template: string, path: string): TmplAstNode[] {
+		return parseTemplate(template, path).nodes;
+	}
+
+	protected isElement(node: any): node is TmplAstElement {
+		return node
+			&& node.attributes !== undefined
+			&& node.children !== undefined;
+	}
+
+	protected isTranslatable(node: TmplAstNode): boolean {
+		if (this.isElement(node) && node.attributes.some(attribute => attribute.name === 'translate')) {
+			return true;
+		}
+		return false;
+	}
+
+	protected getElementTranslateAttrValue(element: TmplAstElement): string {
+		const attr: TmplAstTextAttribute = element.attributes.find(attribute => attribute.name === 'translate');
+		return attr && attr.value || '';
+	}
+
+	protected getElementContents(element: TmplAstElement): string {
+		const contents = element.sourceSpan.start.file.content;
+		const start = element.startSourceSpan.end.offset;
+		const end = element.endSourceSpan.start.offset;
+		return contents.substring(start, end).trim();
 	}
 
 }

src/parsers/function.parser.ts

@@ -1,45 +1,44 @@
+import { Node, CallExpression, SyntaxKind, Identifier } from 'typescript';
+
 import { ParserInterface } from './parser.interface';
 import { AbstractAstParser } from './abstract-ast.parser';
 import { TranslationCollection } from '../utils/translation.collection';
 
-import * as ts from 'typescript';
-
 export class FunctionParser extends AbstractAstParser implements ParserInterface {
 
-	protected _functionIdentifier: string = '_';
+	protected functionIdentifier: string = 'marker';
 
 	public constructor(options?: any) {
 		super();
 		if (options && typeof options.identifier !== 'undefined') {
-			this._functionIdentifier = options.identifier;
+			this.functionIdentifier = options.identifier;
 		}
 	}
 
-	public extract(contents: string, path?: string): TranslationCollection {
+	public extract(template: string, path: string): TranslationCollection {
 		let collection: TranslationCollection = new TranslationCollection();
 
-		this._sourceFile = this._createSourceFile(path, contents);
+		this.sourceFile = this.createSourceFile(path, template);
 
-		const callNodes = this._findCallNodes();
+		const callNodes = this.findCallNodes();
 		callNodes.forEach(callNode => {
-			const keys: string[] = this._getCallArgStrings(callNode);
+			const keys: string[] = this.getStringLiterals(callNode);
 			if (keys && keys.length) {
 				collection = collection.addKeys(keys);
 			}
 		});
-
 		return collection;
 	}
 
 	/**
 	 * Find all calls to marker function
 	 */
-	protected _findCallNodes(node?: ts.Node): ts.CallExpression[] {
+	protected findCallNodes(node?: Node): CallExpression[] {
 		if (!node) {
-			node = this._sourceFile;
+			node = this.sourceFile;
 		}
 
-		let callNodes = this._findNodes(node, ts.SyntaxKind.CallExpression) as ts.CallExpression[];
+		let callNodes = this.findNodes(node, [SyntaxKind.CallExpression]) as CallExpression[];
 		callNodes = callNodes
 			.filter(callNode => {
 				// Only call expressions with arguments
@@ -47,8 +46,8 @@ export class FunctionParser extends AbstractAstParser implements ParserInterface
 					return false;
 				}
 
-				const identifier = (callNode.getChildAt(0) as ts.Identifier).text;
-				if (identifier !== this._functionIdentifier) {
+				const identifier = (callNode.getChildAt(0) as Identifier).text;
+				if (identifier !== this.functionIdentifier) {
 					return false;
 				}
 

src/parsers/parser.interface.ts

@@ -2,6 +2,6 @@ import { TranslationCollection } from '../utils/translation.collection';
 
 export interface ParserInterface {
 
-	extract(contents: string, path?: string): TranslationCollection;
+	extract(template: string, path: string): TranslationCollection;
 
 }

src/parsers/pipe.parser.ts

@@ -1,18 +1,18 @@
 import { ParserInterface } from './parser.interface';
-import { AbstractTemplateParser } from './abstract-template.parser';
 import { TranslationCollection } from '../utils/translation.collection';
+import { isPathAngularComponent, extractComponentInlineTemplate } from '../utils/utils';
 
-export class PipeParser extends AbstractTemplateParser implements ParserInterface {
+export class PipeParser implements ParserInterface {
 
-	public extract(contents: string, path?: string): TranslationCollection {
-		if (path && this._isAngularComponent(path)) {
-			contents = this._extractInlineTemplate(contents);
+	public extract(template: string, path: string): TranslationCollection {
+		if (path && isPathAngularComponent(path)) {
+			template = extractComponentInlineTemplate(template);
 		}
 
-		return this._parseTemplate(contents);
+		return this.parseTemplate(template);
 	}
 
-	protected _parseTemplate(template: string): TranslationCollection {
+	protected parseTemplate(template: string): TranslationCollection {
 		let collection: TranslationCollection = new TranslationCollection();
 
 		const regExp: RegExp = /(['"`])((?:(?!\1).|\\\1)+)\1\s*\|\s*translate/g;

src/parsers/service.parser.ts

@@ -1,32 +1,43 @@
+import {
+	SourceFile,
+	Node,
+	ConstructorDeclaration,
+	Identifier,
+	TypeReferenceNode,
+	ClassDeclaration,
+	SyntaxKind,
+	CallExpression,
+	PropertyAccessExpression,
+	isPropertyAccessExpression
+} from 'typescript';
+
 import { ParserInterface } from './parser.interface';
 import { AbstractAstParser } from './abstract-ast.parser';
 import { TranslationCollection } from '../utils/translation.collection';
 
-import * as ts from 'typescript';
-
 export class ServiceParser extends AbstractAstParser implements ParserInterface {
 
-	protected _sourceFile: ts.SourceFile;
+	protected sourceFile: SourceFile;
 
-	public extract(contents: string, path?: string): TranslationCollection {
+	public extract(template: string, path: string): TranslationCollection {
 		let collection: TranslationCollection = new TranslationCollection();
 
-		this._sourceFile = this._createSourceFile(path, contents);
-		const classNodes = this._findClassNodes(this._sourceFile);
+		this.sourceFile = this.createSourceFile(path, template);
+		const classNodes = this.findClassNodes(this.sourceFile);
 		classNodes.forEach(classNode => {
-			const constructorNode = this._findConstructorNode(classNode);
+			const constructorNode = this.findConstructorNode(classNode);
 			if (!constructorNode) {
 				return;
 			}
 
-			const propertyName: string = this._findTranslateServicePropertyName(constructorNode);
+			const propertyName: string = this.findTranslateServicePropertyName(constructorNode);
 			if (!propertyName) {
 				return;
 			}
 
-			const callNodes = this._findCallNodes(classNode, propertyName);
+			const callNodes = this.findCallNodes(classNode, propertyName);
 			callNodes.forEach(callNode => {
-				const keys: string[] = this._getCallArgStrings(callNode);
+				const keys: string[] = this.getStringLiterals(callNode);
 				if (keys && keys.length) {
 					collection = collection.addKeys(keys);
 				}
@@ -40,7 +51,7 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
 	 * Detect what the TranslateService instance property
 	 * is called by inspecting constructor arguments
 	 */
-	protected _findTranslateServicePropertyName(constructorNode: ts.ConstructorDeclaration): string {
+	protected findTranslateServicePropertyName(constructorNode: ConstructorDeclaration): string {
 		if (!constructorNode) {
 			return null;
 		}
@@ -57,7 +68,7 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
 			}
 
 			// Make sure className is of the correct type
-			const parameterType: ts.Identifier = (parameter.type as ts.TypeReferenceNode).typeName as ts.Identifier;
+			const parameterType: Identifier = (parameter.type as TypeReferenceNode).typeName as Identifier;
 			if (!parameterType) {
 				return false;
 			}
@@ -70,22 +81,22 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
 		});
 
 		if (result) {
-			return (result.name as ts.Identifier).text;
+			return (result.name as Identifier).text;
 		}
 	}
 
 	/**
 	 * Find class nodes
 	 */
-	protected _findClassNodes(node: ts.Node): ts.ClassDeclaration[] {
-		return this._findNodes(node, ts.SyntaxKind.ClassDeclaration) as ts.ClassDeclaration[];
+	protected findClassNodes(node: Node): ClassDeclaration[] {
+		return this.findNodes(node, [SyntaxKind.ClassDeclaration]) as ClassDeclaration[];
 	}
 
 	/**
 	 * Find constructor
 	 */
-	protected _findConstructorNode(node: ts.ClassDeclaration): ts.ConstructorDeclaration {
-		const constructorNodes = this._findNodes(node, ts.SyntaxKind.Constructor) as ts.ConstructorDeclaration[];
+	protected findConstructorNode(node: ClassDeclaration): ConstructorDeclaration {
+		const constructorNodes = this.findNodes(node, [SyntaxKind.Constructor]) as ConstructorDeclaration[];
 		if (constructorNodes) {
 			return constructorNodes[0];
 		}
@@ -94,8 +105,8 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
 	/**
 	 * Find all calls to TranslateService methods
 	 */
-	protected _findCallNodes(node: ts.Node, propertyIdentifier: string): ts.CallExpression[] {
-		let callNodes = this._findNodes(node, ts.SyntaxKind.CallExpression) as ts.CallExpression[];
+	protected findCallNodes(node: Node, propertyIdentifier: string): CallExpression[] {
+		let callNodes = this.findNodes(node, [SyntaxKind.CallExpression]) as CallExpression[];
 		callNodes = callNodes
 			.filter(callNode => {
 				// Only call expressions with arguments
@@ -103,19 +114,19 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
 					return false;
 				}
 
-				const propAccess = callNode.getChildAt(0).getChildAt(0) as ts.PropertyAccessExpression;
-				if (!propAccess || propAccess.kind !== ts.SyntaxKind.PropertyAccessExpression) {
+				const propAccess = callNode.getChildAt(0).getChildAt(0) as PropertyAccessExpression;
+				if (!propAccess || !isPropertyAccessExpression(propAccess)) {
 					return false;
 				}
-				if (!propAccess.getFirstToken() || propAccess.getFirstToken().kind !== ts.SyntaxKind.ThisKeyword) {
+				if (!propAccess.getFirstToken() || propAccess.getFirstToken().kind !== SyntaxKind.ThisKeyword) {
 					return false;
 				}
 				if (propAccess.name.text !== propertyIdentifier) {
 					return false;
 				}
 
-				const methodAccess = callNode.getChildAt(0) as ts.PropertyAccessExpression;
-				if (!methodAccess || methodAccess.kind !== ts.SyntaxKind.PropertyAccessExpression) {
+				const methodAccess = callNode.getChildAt(0) as PropertyAccessExpression;
+				if (!methodAccess || methodAccess.kind !== SyntaxKind.PropertyAccessExpression) {
 					return false;
 				}
 				if (!methodAccess.name || (methodAccess.name.text !== 'get' && methodAccess.name.text !== 'instant' && methodAccess.name.text !== 'stream')) {

src/post-processors/key-as-default-value.post-processor.ts

@@ -0,0 +1,12 @@
+import { TranslationCollection } from '../utils/translation.collection';
+import { PostProcessorInterface } from './post-processor.interface';
+
+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);
+	}
+
+}

src/post-processors/post-processor.interface.ts

@@ -0,0 +1,9 @@
+import { TranslationCollection } from '../utils/translation.collection';
+
+export interface PostProcessorInterface {
+
+	name: string;
+
+	process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection;
+
+}

src/post-processors/purge-obsolete-keys.post-processor.ts

@@ -0,0 +1,12 @@
+import { TranslationCollection } from '../utils/translation.collection';
+import { PostProcessorInterface } from './post-processor.interface';
+
+export class PurgeObsoleteKeysPostProcessor implements PostProcessorInterface {
+
+	public name: string = 'PurgeObsoleteKeys';
+
+	public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
+		return draft.intersect(extracted);
+	}
+
+}

src/post-processors/sort-by-key.post-processor.ts

@@ -0,0 +1,12 @@
+import { TranslationCollection } from '../utils/translation.collection';
+import { PostProcessorInterface } from './post-processor.interface';
+
+export class SortByKeyPostProcessor implements PostProcessorInterface {
+
+	public name: string = 'SortByKey';
+
+	public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
+		return draft.sort();
+	}
+
+}

src/utils/donate.ts

@@ -0,0 +1,17 @@
+import { yellow } from 'colorette';
+import * as boxen from 'boxen';
+import * as terminalLink from 'terminal-link';
+
+const url = 'https://donate.biesbjerg.com';
+const link = terminalLink(url, url);
+const message = `
+If this tool saves you or your company time, please consider making a
+donation to support my work and the continued maintainence and development:
+
+${yellow(link)}`;
+
+export const donateMessage = boxen(message.trim(), {
+	padding: 1,
+	margin: 0,
+	dimBorder: true
+});

src/utils/translation.collection.ts

@@ -1,5 +1,5 @@
 export interface TranslationType {
-	[key: string]: string
+	[key: string]: string;
 }
 
 export class TranslationCollection {
@@ -11,15 +11,15 @@ export class TranslationCollection {
 	}
 
 	public add(key: string, val: string = ''): TranslationCollection {
-		return new TranslationCollection(Object.assign({}, this.values, { [key]: val }));
+		return new TranslationCollection({ ...this.values, [key]: val });
 	}
 
 	public addKeys(keys: string[]): TranslationCollection {
 		const values = keys.reduce((results, key) => {
 			results[key] = '';
 			return results;
-		}, <TranslationType> {});
-		return new TranslationCollection(Object.assign({}, this.values, values));
+		}, {} as TranslationType);
+		return new TranslationCollection({ ...this.values, ...values });
 	}
 
 	public remove(key: string): TranslationCollection {
@@ -41,8 +41,16 @@ export class TranslationCollection {
 		return new TranslationCollection(values);
 	}
 
+	public map(callback: (key?: string, val?: string) => string): TranslationCollection {
+		let values: TranslationType = {};
+		this.forEach((key: string, val: string) => {
+			values[key] = callback.call(this, key, val);
+		});
+		return new TranslationCollection(values);
+	}
+
 	public union(collection: TranslationCollection): TranslationCollection {
-		return new TranslationCollection(Object.assign({}, this.values, collection.values));
+		return new TranslationCollection({ ...this.values, ...collection.values });
 	}
 
 	public intersect(collection: TranslationCollection): TranslationCollection {

src/utils/utils.ts

@@ -1,3 +1,22 @@
-export function _(key: string | string[]): string | string[] {
-	return key;
+/**
+ * Assumes file is an Angular component if type is javascript/typescript
+ */
+export function isPathAngularComponent(path: string): boolean {
+	return (/\.ts|js$/i).test(path);
+}
+
+/**
+ * Extract inline template from a component
+ */
+export function extractComponentInlineTemplate(contents: string): string {
+	const regExp: RegExp = /template\s*:\s*(["'`])([^\1]*?)\1/;
+	const match = regExp.exec(contents);
+	if (match !== null) {
+		return match[2];
+	}
+	return '';
+}
+
+export function stripBOM(contents: string): string {
+	return contents.trim();
 }

tests/compilers/namespaced-json.compiler.spec.ts

@@ -37,9 +37,9 @@ describe('NamespacedJsonCompiler', () => {
 
 	it('should preserve numeric values on compile', () => {
 		const collection = new TranslationCollection({
-			"option.0": '',
-			"option.1": '',
-			"option.2": ''
+			'option.0': '',
+			'option.1': '',
+			'option.2': ''
 		});
 		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}');
@@ -57,4 +57,13 @@ describe('NamespacedJsonCompiler', () => {
 		expect(result).to.equal('{\n  "NAMESPACE": {\n    "KEY": {\n      "FIRST_KEY": "",\n      "SECOND_KEY": "VALUE"\n    }\n  }\n}');
 	});
 
+	it('should not reorder keys when compiled', () => {
+		const collection = new TranslationCollection({
+			'BROWSE': '',
+			'LOGIN': ''
+		});
+		const result: string = compiler.compile(collection);
+		expect(result).to.equal('{\n\t"BROWSE": "",\n\t"LOGIN": ""\n}');
+	});
+
 });

tests/parsers/directive.parser.spec.ts

@@ -2,78 +2,39 @@ import { expect } from 'chai';
 
 import { DirectiveParser } from '../../src/parsers/directive.parser';
 
-class TestDirectiveParser extends DirectiveParser {
-
-	public normalizeTemplateAttributes(template: string): string {
-		return this._normalizeTemplateAttributes(template);
-	}
-
-}
-
 describe('DirectiveParser', () => {
 
 	const templateFilename: string = 'test.template.html';
 	const componentFilename: string = 'test.component.ts';
 
-	let parser: TestDirectiveParser;
+	let parser: DirectiveParser;
 
 	beforeEach(() => {
-		parser = new TestDirectiveParser();
+		parser = new DirectiveParser();
 	});
 
-	it('should extract contents when no translate attribute value is provided', () => {
+	it('should not choke when no html is present in template', () => {
+		const contents = 'Hello World';
+		const keys = parser.extract(contents, templateFilename).keys();
+		expect(keys).to.deep.equal([]);
+	});
+
+	it('should use contents as key when there is no translate attribute value provided', () => {
 		const contents = '<div translate>Hello World</div>';
 		const keys = parser.extract(contents, templateFilename).keys();
 		expect(keys).to.deep.equal(['Hello World']);
 	});
 
-	it('should extract translate attribute if provided', () => {
-		const contents = '<div translate="KEY">Hello World<div>';
+	it('should use translate attribute value as key when provided', () => {
+		const contents = '<div translate="MY_KEY">Hello World<div>';
 		const keys = parser.extract(contents, templateFilename).keys();
-		expect(keys).to.deep.equal(['KEY']);
+		expect(keys).to.deep.equal(['MY_KEY']);
 	});
 
-	it('should extract bound translate attribute as key if provided', () => {
-		const contents = `<div [translate]="'KEY'">Hello World<div>`;
+	it('should not process children when translate attribute is present', () => {
+		const contents = `<div translate>Hello <strong translate>World</strong></div>`;
 		const keys = parser.extract(contents, templateFilename).keys();
-		expect(keys).to.deep.equal(['KEY']);
-	});
-
-	it('should extract direct text nodes when no translate attribute value is provided', () => {
-		const contents = `
-			<div translate>
-				<span>&#10003;</span>
-				Hello <strong>World</strong>
-				Hi <em>there</em>
-			</div>
-		`;
-		const keys = parser.extract(contents, templateFilename).keys();
-		expect(keys).to.deep.equal(['Hello', 'Hi']);
-	});
-
-	it('should extract direct text nodes of tags with a translate attribute', () => {
-		const contents = `
-			<div translate>
-				<span>&#10003;</span>
-				Hello World
-				<div translate>Hi there</div>
-			</div>
-		`;
-		const keys = parser.extract(contents, templateFilename).keys();
-		expect(keys).to.deep.equal(['Hello World', 'Hi there']);
-	});
-
-	it('should extract translate attribute if provided or direct text nodes if not', () => {
-		const contents = `
-			<div translate="KEY">
-				<span>&#10003;</span>
-				Hello World
-				<p translate>Hi there</p>
-				<p [translate]="'OTHER_KEY'">Lorem Ipsum</p>
-			</div>
-		`;
-		const keys = parser.extract(contents, templateFilename).keys();
-		expect(keys).to.deep.equal(['KEY', 'Hi there', 'OTHER_KEY']);
+		expect(keys).to.deep.equal(['Hello <strong translate>World</strong>']);
 	});
 
 	it('should extract and parse inline template', () => {
@@ -88,40 +49,42 @@ describe('DirectiveParser', () => {
 		expect(keys).to.deep.equal(['Hello World']);
 	});
 
-	it('should extract contents when no ng2-translate attribute value is provided', () => {
-		const contents = '<div ng2-translate>Hello World</div>';
+	it('should extract contents when no translate attribute value is provided', () => {
+		const contents = '<div translate>Hello World</div>';
 		const keys = parser.extract(contents, templateFilename).keys();
 		expect(keys).to.deep.equal(['Hello World']);
 	});
 
-	it('should extract ng2-translate attribute if provided', () => {
-		const contents = '<div ng2-translate="KEY">Hello World<div>';
-		const keys = parser.extract(contents, templateFilename).keys();
-		expect(keys).to.deep.equal(['KEY']);
-	});
-
-	it('should extract bound ng2-translate attribute as key if provided', () => {
-		const contents = `<div [ng2-translate]="'KEY'">Hello World<div>`;
+	it('should extract translate attribute value if provided', () => {
+		const contents = '<div translate="KEY">Hello World<div>';
 		const keys = parser.extract(contents, templateFilename).keys();
 		expect(keys).to.deep.equal(['KEY']);
 	});
 
 	it('should not extract translate pipe in html tag', () => {
-		const contents = `<p>{{ 'Audiobooks for personal development' | translate }}</p>`;
+		const contents = `<p>{{ 'Audiobooks for personal development' | translate }}</p>`;
 		const collection = parser.extract(contents, templateFilename);
 		expect(collection.values).to.deep.equal({});
 	});
 
-	it('should normalize bound attributes', () => {
-		const contents = `<p [translate]="'KEY'">Hello World</p>`;
-		const template = parser.normalizeTemplateAttributes(contents);
-		expect(template).to.equal('<p translate="KEY">Hello World</p>');
-	});
-
 	it('should extract contents from within custom tags', () => {
 		const contents = `<custom-table><tbody><tr><td translate>Hello World</td></tr></tbody></custom-table>`;
 		const keys = parser.extract(contents, templateFilename).keys();
 		expect(keys).to.deep.equal(['Hello World']);
 	});
 
+	it('should not cause error when no html is present in template', () => {
+		const contents = `
+			import { Component } from '@angular/core';
+			@Component({
+				template: '{{ variable }}'
+			})
+			export class MyComponent {
+				variable: string
+			}
+		`;
+		const keys = parser.extract(contents, componentFilename).keys();
+		expect(keys).to.deep.equal([]);
+	});
+
 });

tests/parsers/function.parser.spec.ts

@@ -15,13 +15,16 @@ describe('FunctionParser', () => {
 
 	it('should extract strings using marker function', () => {
 		const contents = `
-			import { _ } from '@biesbjerg/ngx-translate-extract';
-			_('Hello world');
-			_(['I', 'am', 'extracted']);
+			import { marker } from '@biesbjerg/ngx-translate-extract-marker';
+			marker('Hello world');
+			marker(['I', 'am', 'extracted']);
 			otherFunction('But I am not');
+			marker(message || 'binary expression');
+			marker(message ? message : 'conditional operator');
+			marker('FOO.bar');
 		`;
 		const keys = parser.extract(contents, componentFilename).keys();
-		expect(keys).to.deep.equal(['Hello world', 'I', 'am', 'extracted']);
+		expect(keys).to.deep.equal(['Hello world', 'I', 'am', 'extracted', 'binary expression', 'conditional operator', 'FOO.bar']);
 	});
 
 });

tests/parsers/pipe.parser.spec.ts

@@ -30,6 +30,12 @@ describe('PipeParser', () => {
 		expect(keys).to.deep.equal(['World']);
 	});
 
+	it('should extract interpolated strings when translate pipe is used in conjunction with other pipes', () => {
+		const contents = `Hello {{ 'World' | translate | upper }}`;
+		const keys = parser.extract(contents, templateFilename).keys();
+		expect(keys).to.deep.equal(['World']);
+	});
+
 	it('should extract strings with escaped quotes', () => {
 		const contents = `Hello {{ 'World\\'s largest potato' | translate }}`;
 		const keys = parser.extract(contents, templateFilename).keys();
@@ -43,13 +49,13 @@ describe('PipeParser', () => {
 	});
 
 	it('should extract interpolated strings using translate pipe in attributes', () => {
-		const contents = `<span attr="{{ 'Hello World' | translate }}"></span>`;
+		const contents = `<span attr="{{ 'Hello World' | translate }}"></span>`;
 		const keys = parser.extract(contents, templateFilename).keys();
 		expect(keys).to.deep.equal(['Hello World']);
 	});
 
 	it('should extract bound strings using translate pipe in attributes', () => {
-		const contents = `<span [attr]="'Hello World' | translate"></span>`;
+		const contents = `<span [attr]="'Hello World' | translate"></span>`;
 		const keys = parser.extract(contents, templateFilename).keys();
 		expect(keys).to.deep.equal(['Hello World']);
 	});
@@ -58,14 +64,14 @@ describe('PipeParser', () => {
 		const contents = `
 			<ion-header>
 				<ion-navbar color="brand">
-					<ion-title>{{ 'Info' | translate }}</ion-title>
+					<ion-title>{{ 'Info' | translate }}</ion-title>
 				</ion-navbar>
 			</ion-header>
 
 			<ion-content>
 
 				<content-loading *ngIf="isLoading">
-					{{ 'Loading...' | translate }}
+					{{ 'Loading...' | translate }}
 				</content-loading>
 
 			</ion-content>
@@ -75,7 +81,7 @@ describe('PipeParser', () => {
 	});
 
 	it('should extract strings on same line', () => {
-		const contents = `<span [attr]="'Hello' | translate"></span><span [attr]="'World' | translate"></span>`;
+		const contents = `<span [attr]="'Hello' | translate"></span><span [attr]="'World' | translate"></span>`;
 		const keys = parser.extract(contents, templateFilename).keys();
 		expect(keys).to.deep.equal(['Hello', 'World']);
 	});
@@ -85,7 +91,7 @@ describe('PipeParser', () => {
 			<ion-list inset>
 				<ion-item>
 					<ion-icon item-left name="person" color="dark"></ion-icon>
-					<ion-input formControlName="name" type="text" [placeholder]="'Name' | translate"></ion-input>
+					<ion-input formControlName="name" type="text" [placeholder]="'Name' | translate"></ion-input>
 				</ion-item>
 				<ion-item>
 					<p color="danger" danger *ngFor="let error of form.get('name').getError('remote')">
@@ -94,11 +100,23 @@ describe('PipeParser', () => {
 				</ion-item>
 			</ion-list>
 			<div class="form-actions">
-				<button ion-button (click)="onSubmit()" color="secondary" block>{{ 'Create account' | translate }}</button>
+				<button ion-button (click)="onSubmit()" color="secondary" block>{{ 'Create account' | translate }}</button>
 			</div>
 		`;
 		const keys = parser.extract(contents, templateFilename).keys();
 		expect(keys).to.deep.equal(['Name', 'Create account']);
 	});
 
+	it('should not extract variables', () => {
+		const contents = '<p>{{ message | translate }}</p>';
+		const keys = parser.extract(contents, templateFilename).keys();
+		expect(keys).to.deep.equal([]);
+	});
+
+	it('should be able to extract without html', () => {
+		const contents = `{{ 'message' | translate }}`;
+		const keys = parser.extract(contents, templateFilename).keys();
+		expect(keys).to.deep.equal(['message']);
+	});
+
 });

tests/parsers/service.parser.spec.ts

@@ -4,10 +4,6 @@ import { ServiceParser } from '../../src/parsers/service.parser';
 
 class TestServiceParser extends ServiceParser {
 
-	/*public getInstancePropertyName(): string {
-		return this._getInstancePropertyName();
-	}*/
-
 }
 
 describe('ServiceParser', () => {
@@ -20,19 +16,33 @@ describe('ServiceParser', () => {
 		parser = new TestServiceParser();
 	});
 
-	/*it('should extract variable used for TranslateService', () => {
+	it('should support extracting binary expressions', () => {
 		const contents = `
 			@Component({ })
 			export class AppComponent {
-				public constructor(
-					_serviceA: ServiceA,
-					public _serviceB: ServiceB,
-					protected _translateService: TranslateService
-			) { }
+				public constructor(protected _translateService: TranslateService) { }
+				public test() {
+					const message = 'The Message';
+					this._translateService.get(message || 'Fallback message');
+				}
 		`;
-		const name = parser.getInstancePropertyName();
-		expect(name).to.equal('_translateService');
-	});*/
+		const keys = parser.extract(contents, componentFilename).keys();
+		expect(keys).to.deep.equal(['Fallback message']);
+	});
+
+	it('should support conditional operator', () => {
+		const contents = `
+			@Component({ })
+			export class AppComponent {
+				public constructor(protected _translateService: TranslateService) { }
+				public test() {
+					const message = 'The Message';
+					this._translateService.get(message ? message : 'Fallback message');
+				}
+		`;
+		const keys = parser.extract(contents, componentFilename).keys();
+		expect(keys).to.deep.equal(['Fallback message']);
+	});
 
 	it('should extract strings in TranslateService\'s get() method', () => {
 		const contents = `
@@ -112,6 +122,19 @@ describe('ServiceParser', () => {
 		expect(key).to.deep.equal(['Hello', 'World']);
 	});
 
+	it('should extract string arrays encapsulated in backticks', () => {
+		const contents = `
+			@Component({ })
+			export class AppComponent {
+				public constructor(protected _translateService: TranslateService) { }
+				public test() {
+					this._translateService.get([\`Hello\`, \`World\`]);
+				}
+		`;
+		const keys = parser.extract(contents, componentFilename).keys();
+		expect(keys).to.deep.equal(['Hello', 'World']);
+	});
+
 	it('should not extract strings in get()/instant()/stream() methods of other services', () => {
 		const contents = `
 			@Component({ })
@@ -191,6 +214,21 @@ describe('ServiceParser', () => {
 		expect(keys).to.deep.equal([]);
 	});
 
+	it('should not extract variables', () => {
+		const contents = `
+			@Component({ })
+			export class AppComponent {
+				public constructor(protected translateService: TranslateService) { }
+				public test() {
+					this.translateService.get(["yes", variable]).then(translations => {
+						console.log(translations[variable]);
+					});
+				}
+		`;
+		const keys = parser.extract(contents, componentFilename).keys();
+		expect(keys).to.deep.equal(['yes']);
+	});
+
 	it('should extract strings from all classes in the file', () => {
 		const contents = `
 			import { Injectable } from '@angular/core';

tests/parsers/utils.spec.ts

@@ -1,39 +1,21 @@
 import { expect } from 'chai';
 
-import { AbstractTemplateParser } from '../../src/parsers/abstract-template.parser';
+import { isPathAngularComponent, extractComponentInlineTemplate } from '../../src/utils/utils';
 
-class TestTemplateParser extends AbstractTemplateParser {
-
-	public isAngularComponent(filePath: string): boolean {
-		return this._isAngularComponent(filePath);
-	}
-
-	public extractInlineTemplate(contents: string): string {
-		return this._extractInlineTemplate(contents);
-	}
-
-}
-
-describe('AbstractTemplateParser', () => {
-
-	let parser: TestTemplateParser;
-
-	beforeEach(() => {
-		parser = new TestTemplateParser();
-	});
+describe('Utils', () => {
 
 	it('should recognize js extension as angular component', () => {
-		const result = parser.isAngularComponent('test.js');
+		const result = isPathAngularComponent('test.js');
 		expect(result).to.equal(true);
 	});
 
 	it('should recognize ts extension as angular component', () => {
-		const result = parser.isAngularComponent('test.ts');
+		const result = isPathAngularComponent('test.ts');
 		expect(result).to.equal(true);
 	});
 
 	it('should not recognize html extension as angular component', () => {
-		const result = parser.isAngularComponent('test.html');
+		const result = isPathAngularComponent('test.html');
 		expect(result).to.equal(false);
 	});
 
@@ -45,10 +27,22 @@ describe('AbstractTemplateParser', () => {
 			})
 			export class TestComponent { }
 		`;
-		const template = parser.extractInlineTemplate(contents);
+		const template = extractComponentInlineTemplate(contents);
 		expect(template).to.equal('<p translate>Hello World</p>');
 	});
 
+	it('should extract inline template without html', () => {
+		const contents = `
+			@Component({
+				selector: 'test',
+				template: '{{ "Hello World" | translate }}'
+			})
+			export class TestComponent { }
+		`;
+		const template = extractComponentInlineTemplate(contents);
+		expect(template).to.equal('{{ "Hello World" | translate }}');
+	});
+
 	it('should extract inline template spanning multiple lines', () => {
 		const contents = `
 			@Component({
@@ -66,7 +60,7 @@ describe('AbstractTemplateParser', () => {
 			})
 			export class TestComponent { }
 		`;
-		const template = parser.extractInlineTemplate(contents);
+		const template = extractComponentInlineTemplate(contents);
 		expect(template).to.equal('\n\t\t\t\t\t<p>\n\t\t\t\t\t\tHello World\n\t\t\t\t\t</p>\n\t\t\t\t');
 	});
 

tests/post-processors/key-as-default-value.post-processor.spec.ts

@@ -0,0 +1,31 @@
+import { expect } from 'chai';
+
+import { PostProcessorInterface } from '../../src/post-processors/post-processor.interface';
+import { KeyAsDefaultValuePostProcessor } from '../../src/post-processors/key-as-default-value.post-processor';
+import { TranslationCollection } from '../../src/utils/translation.collection';
+
+describe('KeyAsDefaultValuePostProcessor', () => {
+
+	let processor: PostProcessorInterface;
+
+	beforeEach(() => {
+		processor = new KeyAsDefaultValuePostProcessor();
+	});
+
+	it('should use key as default value', () => {
+		const collection = new TranslationCollection({
+			'I have no value': '',
+			'I am already translated': 'Jeg er allerede oversat',
+			'Use this key as value as well': ''
+		});
+		const extracted = new TranslationCollection();
+		const existing = new TranslationCollection();
+
+		expect(processor.process(collection, extracted, existing).values).to.deep.equal({
+			'I have no value': 'I have no value',
+			'I am already translated': 'Jeg er allerede oversat',
+			'Use this key as value as well': 'Use this key as value as well'
+		});
+	});
+
+});

tests/post-processors/purge-obsolete-keys.post-processor.spec.ts

@@ -0,0 +1,36 @@
+import { expect } from 'chai';
+
+import { PostProcessorInterface } from '../../src/post-processors/post-processor.interface';
+import { PurgeObsoleteKeysPostProcessor } from '../../src/post-processors/purge-obsolete-keys.post-processor';
+import { TranslationCollection } from '../../src/utils/translation.collection';
+
+describe('PurgeObsoleteKeysPostProcessor', () => {
+
+	let processor: PostProcessorInterface;
+
+	beforeEach(() => {
+		processor = new PurgeObsoleteKeysPostProcessor();
+	});
+
+	it('should purge obsolete keys', () => {
+		const collection = new TranslationCollection({
+			'I am completely new': '',
+			'I already exist': '',
+			'I already exist but was not present in extract': ''
+		});
+		const extracted = new TranslationCollection({
+			'I am completely new': '',
+			'I already exist': ''
+		});
+		const existing = new TranslationCollection({
+			'I already exist': '',
+			'I already exist but was not present in extract': ''
+		});
+
+		expect(processor.process(collection, extracted, existing).values).to.deep.equal({
+			'I am completely new': '',
+			'I already exist': ''
+		});
+	});
+
+});

tests/post-processors/sort-by-key.post-processor.spec.ts

@@ -0,0 +1,33 @@
+import { expect } from 'chai';
+
+import { PostProcessorInterface } from '../../src/post-processors/post-processor.interface';
+import { SortByKeyPostProcessor } from '../../src/post-processors/sort-by-key.post-processor';
+import { TranslationCollection } from '../../src/utils/translation.collection';
+
+describe('SortByKeyPostProcessor', () => {
+
+	let processor: PostProcessorInterface;
+
+	beforeEach(() => {
+		processor = new SortByKeyPostProcessor();
+	});
+
+	it('should sort keys alphanumerically', () => {
+		const collection = new TranslationCollection({
+			'z': 'last value',
+			'a': 'a value',
+			'9': 'a numeric key',
+			'b': 'another value'
+		});
+		const extracted = new TranslationCollection();
+		const existing = new TranslationCollection();
+
+		expect(processor.process(collection, extracted, existing).values).to.deep.equal({
+			'9': 'a numeric key',
+			'a': 'a value',
+			'b': 'another value',
+			'z': 'last value'
+		});
+	});
+
+});

tests/utils/translation.collection.spec.ts

@@ -69,7 +69,7 @@ describe('StringCollection', () => {
 
 	it('should intersect with passed collection', () => {
 		collection = collection.addKeys(['red', 'green', 'blue']);
-		const newCollection = new TranslationCollection( { red: '', blue: '' });
+		const newCollection = new TranslationCollection( { red: '', blue: '' });
 		expect(collection.intersect(newCollection).values).to.deep.equal({ red: '', blue: '' });
 	});
 
@@ -79,10 +79,16 @@ describe('StringCollection', () => {
 		expect(collection.intersect(newCollection).values).to.deep.equal({ red: 'rød', blue: 'blå' });
 	});
 
-	it('should sort translations in alphabetical order', () => {
+	it('should sort keys alphabetically', () => {
 		collection = new TranslationCollection({ red: 'rød', green: 'grøn', blue: 'blå' });
 		collection = collection.sort();
 		expect(collection.keys()).deep.equal(['blue', 'green', 'red']);
 	});
 
+	it('should map values', () => {
+		collection = new TranslationCollection({ red: 'rød', green: 'grøn', blue: 'blå' });
+		collection = collection.map((key, val) => 'mapped value');
+		expect(collection.values).to.deep.equal({ red: 'mapped value', green: 'mapped value', blue: 'mapped value' });
+	});
+
 });

tsconfig.json

@@ -5,10 +5,10 @@
         "noImplicitAny": true,
         "removeComments": true,
         "declaration": true,
-        "target": "es5",
+        "target": "es2015",
         "lib": [
             "dom",
-            "es2015"
+            "es2018"
         ],
         "module": "commonjs",
         "outDir": "./dist/",