Bump version

* feat(cli): add verbose (vb) flag that can control output of all file paths to console

* docs(README): add -vb description

.gitignore

@@ -10,8 +10,8 @@ npm-debug.log*
 dist
 
 # Extracted strings
-template.json
+strings.json
-template.pot
+strings.pot
 
 # Dependency directory
 node_modules

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Kim Biesbjerg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -82,6 +82,8 @@ Options:
   --output, -o                Paths where you would like to save extracted
                               strings. You can use path expansion, glob patterns
                               and multiple paths              [array] [required]
+  --marker, -m                Extract strings passed to a marker function
+                                                       [string] [default: false]
   --format, -f                Output format
           [string] [choices: "json", "namespaced-json", "pot"] [default: "json"]
   --format-indentation, --fi  Output format indentation [string] [default: "\t"]
@@ -91,3 +93,5 @@ Options:
                                                       [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]

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@biesbjerg/ngx-translate-extract",
-  "version": "2.2.0",
+  "version": "2.3.4",
   "description": "Extract strings from projects using ngx-translate",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -47,30 +47,30 @@
   },
   "config": {},
   "devDependencies": {
-    "@types/chai": "3.4.35",
+    "@types/chai": "4.0.1",
     "@types/glob": "5.0.30",
-    "@types/mocha": "2.2.40",
+    "@types/mocha": "2.2.41",
     "@types/cheerio": "0.22.1",
     "@types/chalk": "0.4.31",
     "@types/flat": "0.0.28",
-    "@types/yargs": "6.6.0",
+    "@types/yargs": "8.0.0",
     "@types/mkdirp": "0.3.29",
-    "chai": "3.5.0",
+    "chai": "4.0.2",
-    "mocha": "3.2.0",
+    "mocha": "3.4.2",
-    "ts-node": "3.0.2",
+    "ts-node": "3.1.0",
-    "tslint": "4.5.1",
+    "tslint": "5.4.3",
-    "tslint-eslint-rules": "3.5.1",
+    "tslint-eslint-rules": "4.1.1"
-    "typescript": "2.2.2"
   },
   "dependencies": {
-    "chalk": "1.1.3",
+    "chalk": "2.0.1",
-    "yargs": "7.0.2",
+    "yargs": "8.0.2",
-    "cheerio": "0.22.0",
+    "cheerio": "1.0.0-rc.2",
     "fs": "0.0.1-security",
     "gettext-parser": "1.2.2",
-    "glob": "7.1.1",
+    "glob": "7.1.2",
     "path": "0.12.7",
     "mkdirp": "0.5.1",
-    "flat": "2.0.1"
+    "flat": "2.0.1",
+    "typescript": "2.4.1"
   }
 }

src/cli/cli.ts

@@ -82,6 +82,12 @@ export const cli = yargs
 		default: false,
 		type: 'boolean'
 	})
+	.option('verbose', {
+		alias: 'vb',
+		describe: 'Log all output to console',
+		default: true,
+		type: 'boolean'
+	})
 	.exitProcess(true)
 	.parse(process.argv);
 

src/cli/tasks/extract.task.ts

@@ -14,6 +14,7 @@ export interface ExtractTaskOptionsInterface {
 	sort?: boolean;
 	clean?: boolean;
 	patterns?: string[];
+	verbose?: boolean;
 }
 
 export class ExtractTask implements TaskInterface {
@@ -22,7 +23,8 @@ export class ExtractTask implements TaskInterface {
 		replace: false,
 		sort: false,
 		clean: false,
-		patterns: []
+		patterns: [],
+		verbose: true
 	};
 
 	protected _parsers: ParserInterface[] = [];
@@ -64,7 +66,7 @@ export class ExtractTask implements TaskInterface {
 		let collection: TranslationCollection = new TranslationCollection();
 		this._input.forEach(dir => {
 			this._readDir(dir, this._options.patterns).forEach(path => {
-				this._out(chalk.gray('- %s'), path);
+				this._options.verbose && this._out(chalk.gray('- %s'), path);
 				const contents: string = fs.readFileSync(path, 'utf-8');
 				this._parsers.forEach((parser: ParserInterface) => {
 					collection = collection.union(parser.extract(contents, path));
@@ -104,7 +106,7 @@ export class ExtractTask implements TaskInterface {
 
 				if (this._options.clean) {
 					const collectionCount = processedCollection.count();
-					processedCollection = processedCollection.intersect(processedCollection);
+					processedCollection = processedCollection.intersect(collection);
 					const removeCount = collectionCount - processedCollection.count();
 					if (removeCount > 0) {
 						this._out(chalk.dim('- removed %d obsolete strings'), removeCount);

src/compilers/json.compiler.ts

@@ -1,6 +1,8 @@
 import { CompilerInterface } from './compiler.interface';
 import { TranslationCollection } from '../utils/translation.collection';
 
+import * as flat from 'flat';
+
 export class JsonCompiler implements CompilerInterface {
 
 	public indentation: string = '\t';
@@ -18,7 +20,15 @@ export class JsonCompiler implements CompilerInterface {
 	}
 
 	public parse(contents: string): TranslationCollection {
-		return new TranslationCollection(JSON.parse(contents));
+		let values: any = JSON.parse(contents);
+		if (this._isNamespacedJsonFormat(values)) {
+			values = flat.flatten(values);
+		}
+		return new TranslationCollection(values);
+	}
+
+	protected _isNamespacedJsonFormat(values: any): boolean {
+		return Object.keys(values).some(key => typeof values[key] === 'object');
 	}
 
 }

src/parsers/abstract-ast.parser.ts

@@ -35,11 +35,7 @@ export abstract class AbstractAstParser {
 	/**
 	 * Find all child nodes of a kind
 	 */
-	protected _findNodes(node: ts.Node, kind: ts.SyntaxKind, onlyOne: boolean = false): ts.Node[] {
+	protected _findNodes(node: ts.Node, kind: ts.SyntaxKind): ts.Node[] {
-		if (node.kind === kind && onlyOne) {
-			return [node];
-		}
-
 		const childrenNodes: ts.Node[] = node.getChildren(this._sourceFile);
 		const initialValue: ts.Node[] = node.kind === kind ? [node] : [];
 
@@ -48,7 +44,11 @@ export abstract class AbstractAstParser {
 		}, initialValue);
 	}
 
-	protected _printAllChildren(sourceFile: ts.SourceFile, node: ts.Node, depth = 0) {
+	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}]`,
@@ -62,8 +62,4 @@ export abstract class AbstractAstParser {
 		node.getChildren(sourceFile).forEach(childNode => this._printAllChildren(sourceFile, childNode, depth));
 	}
 
-	protected _syntaxKindToName(kind: ts.SyntaxKind) {
-		return ts.SyntaxKind[kind];
-	}
-
 }

src/parsers/directive.parser.ts

@@ -2,7 +2,9 @@ import { ParserInterface } from './parser.interface';
 import { AbstractTemplateParser } from './abstract-template.parser';
 import { TranslationCollection } from '../utils/translation.collection';
 
-import * as $ from 'cheerio';
+import * as cheerio from 'cheerio';
+
+const $ = cheerio.load('', {xmlMode: true});
 
 export class DirectiveParser extends AbstractTemplateParser implements ParserInterface {
 

src/parsers/pipe.parser.ts

@@ -15,10 +15,10 @@ export class PipeParser extends AbstractTemplateParser implements ParserInterfac
 	protected _parseTemplate(template: string): TranslationCollection {
 		let collection: TranslationCollection = new TranslationCollection();
 
-		const regExp: RegExp = /(['"`])([^>\1\r\n]*?)\1\s*\|\s*translate/g;
+		const regExp: RegExp = /(['"`])((?:(?!\1).|\\\1)+)\1\s*\|\s*translate/g;
 		let matches: RegExpExecArray;
 		while (matches = regExp.exec(template)) {
-			collection = collection.add(matches[2]);
+			collection = collection.add(matches[2].split('\\\'').join('\''));
 		}
 
 		return collection;

src/parsers/service.parser.ts

@@ -8,26 +8,29 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
 
 	protected _sourceFile: ts.SourceFile;
 
-	protected _instancePropertyName: any;
-	protected _serviceClassName: string = 'TranslateService';
-	protected _serviceMethodNames: string[] = ['get', 'instant'];
-
 	public extract(contents: string, path?: string): TranslationCollection {
 		let collection: TranslationCollection = new TranslationCollection();
 
 		this._sourceFile = this._createSourceFile(path, contents);
-
+		const classNodes = this._findClassNodes(this._sourceFile);
-		this._instancePropertyName = this._getInstancePropertyName();
+		classNodes.forEach(classNode => {
-		if (!this._instancePropertyName) {
+			const constructorNode = this._findConstructorNode(classNode);
-			return collection;
+			if (!constructorNode) {
-		}
+				return;
-
-		const callNodes = this._findCallNodes();
-		callNodes.forEach(callNode => {
-			const keys: string[] = this._getCallArgStrings(callNode);
-			if (keys && keys.length) {
-				collection = collection.addKeys(keys);
 			}
+
+			const propertyName: string = this._findTranslateServicePropertyName(constructorNode);
+			if (!propertyName) {
+				return;
+			}
+
+			const callNodes = this._findCallNodes(classNode, propertyName);
+			callNodes.forEach(callNode => {
+				const keys: string[] = this._getCallArgStrings(callNode);
+				if (keys && keys.length) {
+					collection = collection.addKeys(keys);
+				}
+			});
 		});
 
 		return collection;
@@ -35,10 +38,9 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
 
 	/**
 	 * Detect what the TranslateService instance property
-	 * is called by inspecting constructor params
+	 * is called by inspecting constructor arguments
 	 */
-	protected _getInstancePropertyName(): string {
+	protected _findTranslateServicePropertyName(constructorNode: ts.ConstructorDeclaration): string {
-		const constructorNode = this._findConstructorNode();
 		if (!constructorNode) {
 			return null;
 		}
@@ -49,13 +51,18 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
 				return false;
 			}
 
+			// Parameter has no type
+			if (!parameter.type) {
+				return false;
+			}
+
 			// Make sure className is of the correct type
 			const parameterType: ts.Identifier = (parameter.type as ts.TypeReferenceNode).typeName as ts.Identifier;
 			if (!parameterType) {
 				return false;
 			}
 			const className: string = parameterType.text;
-			if (className !== this._serviceClassName) {
+			if (className !== 'TranslateService') {
 				return false;
 			}
 
@@ -68,23 +75,26 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
 	}
 
 	/**
-	 * Find first constructor
+	 * Find class nodes
 	 */
-	protected _findConstructorNode(): ts.ConstructorDeclaration {
+	protected _findClassNodes(node: ts.Node): ts.ClassDeclaration[] {
-		const constructors = this._findNodes(this._sourceFile, ts.SyntaxKind.Constructor, true) as ts.ConstructorDeclaration[];
+		return this._findNodes(node, ts.SyntaxKind.ClassDeclaration) as ts.ClassDeclaration[];
-		if (constructors.length) {
+	}
-			return constructors[0];
+
+	/**
+	 * Find constructor
+	 */
+	protected _findConstructorNode(node: ts.ClassDeclaration): ts.ConstructorDeclaration {
+		const constructorNodes = this._findNodes(node, ts.SyntaxKind.Constructor) as ts.ConstructorDeclaration[];
+		if (constructorNodes) {
+			return constructorNodes[0];
 		}
 	}
 
 	/**
 	 * Find all calls to TranslateService methods
 	 */
-	protected _findCallNodes(node?: ts.Node): ts.CallExpression[] {
+	protected _findCallNodes(node: ts.Node, propertyIdentifier: string): ts.CallExpression[] {
-		if (!node) {
-			node = this._sourceFile;
-		}
-
 		let callNodes = this._findNodes(node, ts.SyntaxKind.CallExpression) as ts.CallExpression[];
 		callNodes = callNodes
 			.filter(callNode => {
@@ -100,7 +110,7 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
 				if (!propAccess.getFirstToken() || propAccess.getFirstToken().kind !== ts.SyntaxKind.ThisKeyword) {
 					return false;
 				}
-				if (propAccess.name.text !== this._instancePropertyName) {
+				if (propAccess.name.text !== propertyIdentifier) {
 					return false;
 				}
 
@@ -108,7 +118,7 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
 				if (!methodAccess || methodAccess.kind !== ts.SyntaxKind.PropertyAccessExpression) {
 					return false;
 				}
-				if (!methodAccess.name || this._serviceMethodNames.indexOf(methodAccess.name.text) === -1) {
+				if (!methodAccess.name || (methodAccess.name.text !== 'get' && methodAccess.name.text !== 'instant' && methodAccess.name.text !== 'stream')) {
 					return false;
 				}
 

src/utils/translation.collection.ts

@@ -1,6 +1,6 @@
 export interface TranslationType {
 	[key: string]: string
-};
+}
 
 export class TranslationCollection {
 

src/utils/utils.ts

@@ -1,5 +1,3 @@
-import * as ts from 'typescript';
-
 export function _(key: string | string[]): string | string[] {
 	return key;
 }

tests/parsers/directive.parser.spec.ts

@@ -118,4 +118,10 @@ describe('DirectiveParser', () => {
 		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']);
+	});
+
 });

tests/parsers/pipe.parser.spec.ts

@@ -18,6 +18,12 @@ describe('PipeParser', () => {
 		expect(keys).to.deep.equal(['SomeKey_NotWorking']);
 	});
 
+	it('should extract string using pipe, but between quotes only', () => {
+		const contents = `<input class="form-control" type="text" placeholder="{{'user.settings.form.phone.placeholder' | translate}}" [formControl]="settingsForm.controls['phone']">`;
+		const keys = parser.extract(contents, templateFilename).keys();
+		expect(keys).to.deep.equal(['user.settings.form.phone.placeholder']);
+	});
+
 	it('should extract interpolated strings using translate pipe', () => {
 		const contents = `Hello {{ 'World' | translate }}`;
 		const keys = parser.extract(contents, templateFilename).keys();
@@ -25,11 +31,17 @@ describe('PipeParser', () => {
 	});
 
 	it('should extract strings with escaped quotes', () => {
-		const contents = `Hello {{ 'World\'s largest potato' | translate }}`;
+		const contents = `Hello {{ 'World\\'s largest potato' | translate }}`;
 		const keys = parser.extract(contents, templateFilename).keys();
 		expect(keys).to.deep.equal([`World's largest potato`]);
 	});
 
+	it('should extract strings with multiple escaped quotes', () => {
+		const contents = `{{ 'C\\'est ok. C\\'est ok' | translate }}`;
+		const keys = parser.extract(contents, templateFilename).keys();
+		expect(keys).to.deep.equal([`C'est ok. C'est ok`]);
+	});
+
 	it('should extract interpolated strings using translate pipe in attributes', () => {
 		const contents = `<span attr="{{ 'Hello World' | translate }}"></span>`;
 		const keys = parser.extract(contents, templateFilename).keys();

tests/parsers/service.parser.spec.ts

@@ -60,6 +60,19 @@ describe('ServiceParser', () => {
 		expect(keys).to.deep.equal(['Hello World']);
 	});
 
+	it('should extract strings in TranslateService\'s stream() method', () => {
+		const contents = `
+			@Component({ })
+			export class AppComponent {
+				public constructor(protected _translateService: TranslateService) { }
+				public test() {
+					this._translateService.stream('Hello World');
+				}
+		`;
+		const keys = parser.extract(contents, componentFilename).keys();
+		expect(keys).to.deep.equal(['Hello World']);
+	});
+
 	it('should extract array of strings in TranslateService\'s get() method', () => {
 		const contents = `
 			@Component({ })
@@ -86,7 +99,20 @@ describe('ServiceParser', () => {
 		expect(key).to.deep.equal(['Hello', 'World']);
 	});
 
-	it('should not extract strings in get()/instant() methods of other services', () => {
+	it('should extract array of strings in TranslateService\'s stream() method', () => {
+		const contents = `
+			@Component({ })
+			export class AppComponent {
+				public constructor(protected _translateService: TranslateService) { }
+				public test() {
+					this._translateService.stream(['Hello', 'World']);
+				}
+		`;
+		const key = parser.extract(contents, componentFilename).keys();
+		expect(key).to.deep.equal(['Hello', 'World']);
+	});
+
+	it('should not extract strings in get()/instant()/stream() methods of other services', () => {
 		const contents = `
 			@Component({ })
 			export class AppComponent {
@@ -97,6 +123,7 @@ describe('ServiceParser', () => {
 				public test() {
 					this._otherService.get('Hello World');
 					this._otherService.instant('Hi there');
+					this._otherService.stream('Hi there');
 				}
 		`;
 		const keys = parser.extract(contents, componentFilename).keys();
@@ -151,4 +178,51 @@ describe('ServiceParser', () => {
 		expect(keys).to.deep.equal(['You are expected at {{time}}']);
 	});
 
+	it('should not crash when constructor parameter has no type', () => {
+		const contents = `
+			@Component({ })
+			export class AppComponent {
+				public constructor(protected _translateService) { }
+				public test() {
+					this._translateService.instant('Hello World');
+				}
+		`;
+		const keys = parser.extract(contents, componentFilename).keys();
+		expect(keys).to.deep.equal([]);
+	});
+
+	it('should extract strings from all classes in the file', () => {
+		const contents = `
+			import { Injectable } from '@angular/core';
+			import { TranslateService } from '@ngx-translate/core';
+			export class Stuff {
+				thing: string;
+				translate: any;
+				constructor(thing: string) {
+					this.translate.get('Not me');
+					this.thing = thing;
+				}
+			}
+			@Injectable()
+			export class MyComponent {
+				constructor(public translate: TranslateService) {
+					this.translate.instant("Extract me!");
+				}
+			}
+			export class OtherClass {
+				constructor(thing: string, _translate: TranslateService) {
+					this._translate.get("Do not extract me");
+				}
+			}
+			@Injectable()
+			export class AuthService {
+				constructor(public translate: TranslateService) {
+					this.translate.instant("Hello!");
+				}
+			}
+		`;
+		const keys = parser.extract(contents, componentFilename).keys();
+		expect(keys).to.deep.equal(['Extract me!', 'Hello!']);
+	});
+
 });