Compare commits

..

4 Commits

Author SHA1 Message Date
Kim Biesbjerg
0d74fb4f55 wip 2020-05-31 14:46:41 +02:00
Kim Biesbjerg
b928ca7555 wip 2020-05-31 14:31:55 +02:00
Kim Biesbjerg
c60705d5fa run prettier on code 2020-05-28 19:36:21 +02:00
Kim Biesbjerg
85cd1e4a46 fix(directive-parser) add support for bound attributes 2020-05-28 19:35:26 +02:00
4 changed files with 216 additions and 132 deletions

View File

@@ -74,7 +74,7 @@ export class ExtractTask implements TaskInterface {
try { try {
let event = 'CREATED'; let event = 'CREATED';
if (fs.existsSync(outputPath)) { if (fs.existsSync(outputPath)) {
this.options.replace ? event = 'REPLACED' : event = 'MERGED'; this.options.replace ? (event = 'REPLACED') : (event = 'MERGED');
} }
this.save(outputPath, final); this.save(outputPath, final);
this.out(`%s %s`, dim(`- ${outputPath}`), green(`[${event}]`)); this.out(`%s %s`, dim(`- ${outputPath}`), green(`[${event}]`));

View File

@@ -3,7 +3,18 @@ import {
TmplAstNode as Node, TmplAstNode as Node,
TmplAstElement as Element, TmplAstElement as Element,
TmplAstText as Text, TmplAstText as Text,
TmplAstTemplate as Template TmplAstTemplate as Template,
TmplAstTextAttribute as TextAttribute,
TmplAstBoundAttribute as BoundAttribute,
AST,
ASTWithSource,
LiteralPrimitive,
Conditional,
Binary,
BindingPipe,
Interpolation,
LiteralArray,
LiteralMap
} from '@angular/compiler'; } from '@angular/compiler';
import { ParserInterface } from './parser.interface'; import { ParserInterface } from './parser.interface';
@@ -24,13 +35,22 @@ export class DirectiveParser implements ParserInterface {
const elements: ElementLike[] = this.getElementsWithTranslateAttribute(nodes); const elements: ElementLike[] = this.getElementsWithTranslateAttribute(nodes);
elements.forEach((element) => { elements.forEach((element) => {
const attr = this.getAttribute(element, TRANSLATE_ATTR_NAME); const attribute = this.getAttribute(element, TRANSLATE_ATTR_NAME);
if (attr) { if (attribute?.value) {
collection = collection.add(attr); collection = collection.add(attribute.value);
return; return;
} }
const boundAttribute = this.getBoundAttribute(element, TRANSLATE_ATTR_NAME);
if (boundAttribute?.value) {
this.getLiteralPrimitives(boundAttribute.value).forEach((literalPrimitive) => {
collection = collection.add(literalPrimitive.value);
});
return;
}
const textNodes = this.getTextNodes(element); const textNodes = this.getTextNodes(element);
textNodes.forEach((textNode: Text) => { textNodes.forEach((textNode) => {
collection = collection.add(textNode.value.trim()); collection = collection.add(textNode.value.trim());
}); });
}); });
@@ -43,16 +63,18 @@ export class DirectiveParser implements ParserInterface {
*/ */
protected getElementsWithTranslateAttribute(nodes: Node[]): ElementLike[] { protected getElementsWithTranslateAttribute(nodes: Node[]): ElementLike[] {
let elements: ElementLike[] = []; let elements: ElementLike[] = [];
nodes.filter(this.isElementLike) nodes.filter(this.isElementLike).forEach((element) => {
.forEach((element) => { if (this.hasAttribute(element, TRANSLATE_ATTR_NAME)) {
if (this.hasAttribute(element, TRANSLATE_ATTR_NAME)) { elements = [...elements, element];
elements = [...elements, element]; }
} if (this.hasBoundAttribute(element, TRANSLATE_ATTR_NAME)) {
const childElements = this.getElementsWithTranslateAttribute(element.children); elements = [...elements, element];
if (childElements.length) { }
elements = [...elements, ...childElements]; const childElements = this.getElementsWithTranslateAttribute(element.children);
} if (childElements.length) {
}); elements = [...elements, ...childElements];
}
});
return elements; return elements;
} }
@@ -76,8 +98,59 @@ export class DirectiveParser implements ParserInterface {
* Get attribute value if present on element * Get attribute value if present on element
* @param element * @param element
*/ */
protected getAttribute(element: ElementLike, name: string): string | undefined { protected getAttribute(element: ElementLike, name: string): TextAttribute {
return element.attributes.find((attribute) => attribute.name === name)?.value; return element.attributes.find((attribute) => attribute.name === name);
}
/**
* Check if bound attribute is present on element
* @param element
* @param name
*/
protected hasBoundAttribute(element: ElementLike, name: string): boolean {
return this.getBoundAttribute(element, name) !== undefined;
}
/**
* Get bound attribute if present on element
* @param element
* @param name
*/
protected getBoundAttribute(element: ElementLike, name: string): BoundAttribute {
return element.inputs.find((input) => input.name === name);
}
/**
* Get literal primitives from expression
* @param exp
*/
protected getLiteralPrimitives(exp: AST): LiteralPrimitive[] {
if (exp instanceof LiteralPrimitive) {
return [exp];
}
let visit: AST[] = [];
if (exp instanceof Interpolation) {
visit = exp.expressions;
} else if (exp instanceof LiteralArray) {
visit = exp.expressions;
} else if (exp instanceof LiteralMap) {
visit = exp.values;
} else if (exp instanceof BindingPipe) {
visit = [exp.exp];
} else if (exp instanceof Conditional) {
visit = [exp.trueExp, exp.falseExp];
} else if (exp instanceof Binary) {
visit = [exp.left, exp.right];
} else if (exp instanceof ASTWithSource) {
visit = [exp.ast];
}
let results: LiteralPrimitive[] = [];
visit.forEach((child) => {
results = [...results, ...this.getLiteralPrimitives(child)];
});
return results;
} }
/** /**
@@ -104,5 +177,4 @@ export class DirectiveParser implements ParserInterface {
protected parseTemplate(template: string, path: string): Node[] { protected parseTemplate(template: string, path: string): Node[] {
return parseTemplate(template, path).nodes; return parseTemplate(template, path).nodes;
} }
} }

View File

@@ -1,11 +1,16 @@
import { import {
AST, AST,
TmplAstNode, ASTWithSource,
TmplAstNode as Node,
TmplAstBoundText as BoundText,
TmplAstElement as Element,
TmplAstTemplate as Template,
TmplAstBoundAttribute as BoundAttribute,
TmplAstBoundEvent as BoundEvent,
parseTemplate, parseTemplate,
BindingPipe, BindingPipe,
LiteralPrimitive, LiteralPrimitive,
Conditional, Conditional,
TmplAstTextAttribute,
Binary, Binary,
LiteralMap, LiteralMap,
LiteralArray, LiteralArray,
@@ -17,142 +22,99 @@ import { TranslationCollection } from '../utils/translation.collection';
import { isPathAngularComponent, extractComponentInlineTemplate } from '../utils/utils'; import { isPathAngularComponent, extractComponentInlineTemplate } from '../utils/utils';
const TRANSLATE_PIPE_NAME = 'translate'; const TRANSLATE_PIPE_NAME = 'translate';
type ElementLike = Element | Template;
export class PipeParser implements ParserInterface { export class PipeParser implements ParserInterface {
public extract(source: string, filePath: string): TranslationCollection | null { public extract(source: string, filePath: string): TranslationCollection | null {
let collection: TranslationCollection = new TranslationCollection();
if (filePath && isPathAngularComponent(filePath)) { if (filePath && isPathAngularComponent(filePath)) {
source = extractComponentInlineTemplate(source); source = extractComponentInlineTemplate(source);
} }
const nodes: Node[] = this.parseTemplate(source, filePath);
const pipes = this.getBindingPipes(nodes, TRANSLATE_PIPE_NAME).filter((pipe) => !this.pipeHasConcatenatedString(pipe));
let collection: TranslationCollection = new TranslationCollection();
const nodes: TmplAstNode[] = this.parseTemplate(source, filePath);
const pipes: BindingPipe[] = nodes.map((node) => this.findPipesInNode(node)).flat();
pipes.forEach((pipe) => { pipes.forEach((pipe) => {
this.parseTranslationKeysFromPipe(pipe).forEach((key: string) => { this.visitEachChild(pipe, (child) => {
collection = collection.add(key); if (child instanceof LiteralPrimitive) {
collection = collection.add(child.value);
}
}); });
}); });
return collection; return collection;
} }
protected findPipesInNode(node: any): BindingPipe[] { protected getBindingPipes(nodes: any[], name: string): BindingPipe[] {
let ret: BindingPipe[] = []; let pipes: BindingPipe[] = [];
nodes.forEach((node) => {
if (this.isElementLike(node)) {
pipes = [
...pipes,
...this.getBindingPipes([
...node.inputs,
...node.children
], name)
];
}
if (node?.children) { this.visitEachChild(node, (exp) => {
ret = node.children.reduce( if (exp instanceof BindingPipe && exp.name === name) {
(result: BindingPipe[], childNode: TmplAstNode) => { pipes = [...pipes, exp];
const children = this.findPipesInNode(childNode);
return result.concat(children);
},
[ret]
);
}
if (node?.value?.ast) {
ret.push(...this.getTranslatablesFromAst(node.value.ast));
}
if (node?.attributes) {
const translateableAttributes = node.attributes.filter((attr: TmplAstTextAttribute) => {
return attr.name === TRANSLATE_PIPE_NAME;
});
ret = [...ret, ...translateableAttributes];
}
if (node?.inputs) {
node.inputs.forEach((input: any) => {
// <element [attrib]="'identifier' | translate">
if (input?.value?.ast) {
ret.push(...this.getTranslatablesFromAst(input.value.ast));
} }
}); });
} });
return pipes;
return ret;
} }
protected parseTranslationKeysFromPipe(pipeContent: BindingPipe | LiteralPrimitive | Conditional): string[] { protected visitEachChild(exp: AST, visitor: (child: AST) => void): void {
const ret: string[] = []; visitor(exp);
if (pipeContent instanceof LiteralPrimitive) {
ret.push(pipeContent.value); let children: AST[] = [];
} else if (pipeContent instanceof Conditional) { if (exp instanceof BoundText) {
const trueExp: LiteralPrimitive | Conditional = pipeContent.trueExp as any; children = [exp.value];
ret.push(...this.parseTranslationKeysFromPipe(trueExp)); } else if (exp instanceof BoundAttribute) {
const falseExp: LiteralPrimitive | Conditional = pipeContent.falseExp as any; children = [exp.value];
ret.push(...this.parseTranslationKeysFromPipe(falseExp)); } else if (exp instanceof BoundEvent) {
} else if (pipeContent instanceof BindingPipe) { children = [exp.handler];
ret.push(...this.parseTranslationKeysFromPipe(pipeContent.exp as any)); } else if (exp instanceof Interpolation) {
children = exp.expressions;
} else if (exp instanceof LiteralArray) {
children = exp.expressions;
} else if (exp instanceof LiteralMap) {
children = exp.values;
} else if (exp instanceof BindingPipe) {
children = [exp.exp, ...exp.args];
} else if (exp instanceof Conditional) {
children = [exp.trueExp, exp.falseExp];
} else if (exp instanceof Binary) {
children = [exp.left, exp.right];
} else if (exp instanceof ASTWithSource) {
children = [exp.ast];
} }
return ret;
children.forEach((child) => {
this.visitEachChild(child, visitor);
});
} }
protected getTranslatablesFromAst(ast: AST): BindingPipe[] { /**
// the entire expression is the translate pipe, e.g.: * Check if node type is ElementLike
// - 'foo' | translate * @param node
// - (condition ? 'foo' : 'bar') | translate */
if (this.expressionIsOrHasBindingPipe(ast)) { protected isElementLike(node: Node): node is ElementLike {
return [ast]; return node instanceof Element || node instanceof Template;
}
// angular double curly bracket interpolation, e.g.:
// - {{ expressions }}
if (ast instanceof Interpolation) {
return this.getTranslatablesFromAsts(ast.expressions);
}
// ternary operator, e.g.:
// - condition ? null : ('foo' | translate)
// - condition ? ('foo' | translate) : null
if (ast instanceof Conditional) {
return this.getTranslatablesFromAsts([ast.trueExp, ast.falseExp]);
}
// string concatenation, e.g.:
// - 'foo' + 'bar' + ('baz' | translate)
if (ast instanceof Binary) {
return this.getTranslatablesFromAsts([ast.left, ast.right]);
}
// a pipe on the outer expression, but not the translate pipe - ignore the pipe, visit the expression, e.g.:
// - { foo: 'Hello' | translate } | json
if (ast instanceof BindingPipe) {
return this.getTranslatablesFromAst(ast.exp);
}
// object - ignore the keys, visit all values, e.g.:
// - { key1: 'value1' | translate, key2: 'value2' | translate }
if (ast instanceof LiteralMap) {
return this.getTranslatablesFromAsts(ast.values);
}
// array - visit all its values, e.g.:
// - [ 'value1' | translate, 'value2' | translate ]
if (ast instanceof LiteralArray) {
return this.getTranslatablesFromAsts(ast.expressions);
}
return [];
} }
protected getTranslatablesFromAsts(asts: AST[]): BindingPipe[] { /**
return this.flatten(asts.map(ast => this.getTranslatablesFromAst(ast))); * Check if pipe concatenates string (in that case we don't want to extract it)
* @param pipe
*/
protected pipeHasConcatenatedString(pipe: BindingPipe): boolean {
return pipe?.exp instanceof Binary && pipe.exp.operation === '+';
} }
protected flatten<T extends AST>(array: T[][]): T[] { protected parseTemplate(template: string, path: string): Node[] {
return [].concat(...array);
}
protected expressionIsOrHasBindingPipe(exp: any): exp is BindingPipe {
if (exp.name && exp.name === TRANSLATE_PIPE_NAME) {
return true;
}
if (exp.exp && exp.exp instanceof BindingPipe) {
return this.expressionIsOrHasBindingPipe(exp.exp);
}
return false;
}
protected parseTemplate(template: string, path: string): TmplAstNode[] {
return parseTemplate(template, path).nodes; return parseTemplate(template, path).nodes;
} }
} }

View File

@@ -12,6 +12,55 @@ describe('DirectiveParser', () => {
parser = new DirectiveParser(); parser = new DirectiveParser();
}); });
it('should extract keys when using literal map in bound attribute', () => {
const contents = `<div [translate]="{ key1: 'value1' | translate, key2: 'value2' | translate }"></div>`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['value1', 'value2']);
});
it('should extract keys when using literal arrays in bound attribute', () => {
const contents = `<div [translate]="[ 'value1' | translate, 'value2' | translate ]"></div>`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['value1', 'value2']);
});
it('should extract keys when using binding pipe in bound attribute', () => {
const contents = `<div [translate]="'KEY1' | withPipe"></div>`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['KEY1']);
});
it('should extract keys when using binary expression in bound attribute', () => {
const contents = `<div [translate]="keyVar || 'KEY1'"></div>`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['KEY1']);
});
it('should extract keys when using literal primitive in bound attribute', () => {
const contents = `<div [translate]="'KEY1'"></div>`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['KEY1']);
});
it('should extract keys when using conditional in bound attribute', () => {
const contents = `<div [translate]="condition ? 'KEY1' : 'KEY2'"></div>`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['KEY1', 'KEY2']);
});
it('should extract keys when using nested conditionals in bound attribute', () => {
const contents = `<div [translate]="isSunny ? (isWarm ? 'Sunny and warm' : 'Sunny but cold') : 'Not sunny'"></div>`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['Sunny and warm', 'Sunny but cold', 'Not sunny']);
});
it('should extract keys when using interpolation', () => {
const contents = `<div translate="{{ 'KEY1' + key2 + 'KEY3' }}"></div>`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['KEY1', 'KEY3']);
});
it('should extract keys keeping proper whitespace', () => { it('should extract keys keeping proper whitespace', () => {
const contents = ` const contents = `
<div translate> <div translate>
@@ -120,4 +169,5 @@ describe('DirectiveParser', () => {
const keys = parser.extract(contents, templateFilename).keys(); const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['this is an example']); expect(keys).to.deep.equal(['this is an example']);
}); });
}); });