Compare commits
7 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
7c06b66974 | ||
|
b2ae17697d | ||
|
5259da8fe3 | ||
|
2d73f056ff | ||
|
fde5245731 | ||
|
4ee7258a31 | ||
|
a6c7af0630 |
28
package.json
28
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@biesbjerg/ngx-translate-extract",
|
||||
"version": "2.3.0",
|
||||
"version": "2.3.2",
|
||||
"description": "Extract strings from projects using ngx-translate",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
@@ -47,28 +47,28 @@
|
||||
},
|
||||
"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",
|
||||
"mocha": "3.2.0",
|
||||
"ts-node": "3.0.2",
|
||||
"tslint": "5.0.0",
|
||||
"tslint-eslint-rules": "4.0.0",
|
||||
"typescript": "2.2.2"
|
||||
"chai": "4.0.2",
|
||||
"mocha": "3.4.2",
|
||||
"ts-node": "3.1.0",
|
||||
"tslint": "5.4.3",
|
||||
"tslint-eslint-rules": "4.1.1",
|
||||
"typescript": "2.4.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"chalk": "1.1.3",
|
||||
"yargs": "7.0.2",
|
||||
"cheerio": "0.22.0",
|
||||
"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.1",
|
||||
"glob": "7.1.2",
|
||||
"path": "0.12.7",
|
||||
"mkdirp": "0.5.1",
|
||||
"flat": "2.0.1"
|
||||
|
@@ -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[] {
|
||||
if (node.kind === kind && onlyOne) {
|
||||
return [node];
|
||||
}
|
||||
|
||||
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] : [];
|
||||
|
||||
|
@@ -18,7 +18,7 @@ export class PipeParser extends AbstractTemplateParser implements ParserInterfac
|
||||
const regExp: RegExp = /(['"`])((?:(?!\1).|\\\1)+)\1\s*\|\s*translate/g;
|
||||
let matches: RegExpExecArray;
|
||||
while (matches = regExp.exec(template)) {
|
||||
collection = collection.add(matches[2].replace('\\\'', '\''));
|
||||
collection = collection.add(matches[2].split('\\\'').join('\''));
|
||||
}
|
||||
|
||||
return collection;
|
||||
|
@@ -9,18 +9,22 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
|
||||
protected _sourceFile: ts.SourceFile;
|
||||
|
||||
public extract(contents: string, path?: string): TranslationCollection {
|
||||
this._sourceFile = this._createSourceFile(path, contents);
|
||||
|
||||
let collection: TranslationCollection = new TranslationCollection();
|
||||
|
||||
const constructorNodes: ts.ConstructorDeclaration[] = this._findConstructorNodes();
|
||||
constructorNodes.forEach(constructorNode => {
|
||||
const propertyName: string = this._getPropertyName(constructorNode);
|
||||
this._sourceFile = this._createSourceFile(path, contents);
|
||||
const classNodes = this._findClassNodes(this._sourceFile);
|
||||
classNodes.forEach(classNode => {
|
||||
const constructorNode = this._findConstructorNode(classNode);
|
||||
if (!constructorNode) {
|
||||
return;
|
||||
}
|
||||
|
||||
const propertyName: string = this._findTranslateServicePropertyName(constructorNode);
|
||||
if (!propertyName) {
|
||||
return;
|
||||
}
|
||||
|
||||
const callNodes = this._findCallNodes(this._sourceFile, propertyName);
|
||||
const callNodes = this._findCallNodes(classNode, propertyName);
|
||||
callNodes.forEach(callNode => {
|
||||
const keys: string[] = this._getCallArgStrings(callNode);
|
||||
if (keys && keys.length) {
|
||||
@@ -34,9 +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 _getPropertyName(constructorNode: ts.ConstructorDeclaration): string {
|
||||
protected _findTranslateServicePropertyName(constructorNode: ts.ConstructorDeclaration): string {
|
||||
if (!constructorNode) {
|
||||
return null;
|
||||
}
|
||||
@@ -71,12 +75,19 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Find constructor nodes
|
||||
* Find class nodes
|
||||
*/
|
||||
protected _findConstructorNodes(): ts.ConstructorDeclaration[] {
|
||||
const constructors = this._findNodes(this._sourceFile, ts.SyntaxKind.Constructor, true) as ts.ConstructorDeclaration[];
|
||||
if (constructors.length) {
|
||||
return constructors;
|
||||
protected _findClassNodes(node: ts.Node): ts.ClassDeclaration[] {
|
||||
return this._findNodes(node, ts.SyntaxKind.ClassDeclaration) as ts.ClassDeclaration[];
|
||||
}
|
||||
|
||||
/**
|
||||
* 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];
|
||||
}
|
||||
}
|
||||
|
||||
@@ -107,7 +118,7 @@ export class ServiceParser extends AbstractAstParser implements ParserInterface
|
||||
if (!methodAccess || methodAccess.kind !== ts.SyntaxKind.PropertyAccessExpression) {
|
||||
return false;
|
||||
}
|
||||
if (!methodAccess.name || (methodAccess.name.text !== 'get' && methodAccess.name.text !== 'instant')) {
|
||||
if (!methodAccess.name || (methodAccess.name.text !== 'get' && methodAccess.name.text !== 'instant' && methodAccess.name.text !== 'stream')) {
|
||||
return false;
|
||||
}
|
||||
|
||||
|
@@ -36,6 +36,12 @@ describe('PipeParser', () => {
|
||||
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();
|
||||
|
@@ -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();
|
||||
@@ -170,19 +197,32 @@ describe('ServiceParser', () => {
|
||||
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) {
|
||||
console.log(this.translate.instant("Hello!"));
|
||||
this.translate.instant("Hello!");
|
||||
}
|
||||
}
|
||||
`;
|
||||
const keys = parser.extract(contents, componentFilename).keys();
|
||||
expect(keys).to.deep.equal(['Hello!']);
|
||||
expect(keys).to.deep.equal(['Extract me!', 'Hello!']);
|
||||
});
|
||||
|
||||
});
|
||||
|
Reference in New Issue
Block a user