fix: clear corner cases in i18n rules

Author: mgechev

src/i18nRule.ts

@@ -45,9 +45,11 @@ class I18NAttrVisitor extends BasicTemplateAstVisitor
 
 class I18NTextVisitor extends BasicTemplateAstVisitor
  implements ConfigurableVisitor {
+ static Error = 'Each element containing text node should has an i18n attribute';
+
  private hasI18n = false;
  private nestedElements = [];
- private visited = new Set<ast.TextAst>();
+ private visited = new Set<ast.TextAst | ast.BoundTextAst>();
 
  visitText(text: ast.TextAst, context: BasicTemplateAstVisitor) {
  if (!this.visited.has(text)) {
@@ -62,14 +64,37 @@ class I18NTextVisitor extends BasicTemplateAstVisitor
  context.createFailure(
  span.start.offset,
  span.end.offset - span.start.offset,
- 'Each element containing text node should has an i18n attribute'
+ I18NTextVisitor.Error
  )
  );
  }
  }
  super.visitText(text, context);
  }
 
+ visitBoundText(text: ast.BoundTextAst, context: BasicTemplateAstVisitor) {
+ if (!this.visited.has(text)) {
+ this.visited.add(text);
+ const val = text.value;
+ if (
+ val instanceof ast.ASTWithSource &&
+ val.ast instanceof ast.Interpolation
+ ) {
+ const textNonEmpty = val.ast.strings.some(s => /\w+/.test(s));
+ if (textNonEmpty) {
+ const span = text.sourceSpan;
+ context.addFailure(
+ context.createFailure(
+ span.start.offset,
+ span.end.offset - span.start.offset,
+ I18NTextVisitor.Error
+ )
+ );
+ }
+ }
+ }
+ }
+
  visitElement(element: ast.ElementAst, context: BasicTemplateAstVisitor) {
  this.hasI18n = element.attrs.some(e => e.name === 'i18n');
  this.nestedElements.push(element.name);
@@ -132,6 +157,16 @@ class I18NTemplateVisitor extends BasicTemplateAstVisitor {
  .forEach(f => this.addFailure(f));
  super.visitText(text, context);
  }
+
+ visitBoundText(text: ast.BoundTextAst, context: any): any {
+ const options = this.getOptions();
+ this.visitors
+ .filter(v => options.indexOf(v.getOption()) >= 0)
+ .map(v => v.visitBoundText(text, this))
+ .filter(f => !!f)
+ .forEach(f => this.addFailure(f));
+ super.visitBoundText(text, context);
+ }
 }
 
 export class Rule extends Lint.Rules.AbstractRule {

test/i18nRule.spec.ts

@@ -152,5 +152,53 @@ describe('i18n', () => {
  ['check-text']
  );
  });
+
+ it('should fail with missing id string', () => {
+ let source = `
+ @Component({
+ template: \`
+ <div>Text {{ foo }}</div>
+ ~~~~~~~~~~~~~~
+ \`
+ })
+ class Bar {}
+ `;
+ assertAnnotated({
+ ruleName: 'i18n',
+ options: ['check-text'],
+ source,
+ message:
+ 'Each element containing text node should has an i18n attribute'
+ });
+ });
+
+ it('should fail with text outside element with i18n attribute', () => {
+ let source = `
+ @Component({
+ template: \`
+ <div i18n>Text</div>
+ {{foo}} text
+ \`
+ })
+ class Bar {}
+ `;
+ assertFailure(
+ 'i18n',
+ source,
+ {
+ message:
+ 'Each element containing text node should has an i18n attribute',
+ startPosition: {
+ line: 3,
+ character: 30
+ },
+ endPosition: {
+ line: 5,
+ character: 8
+ }
+ },
+ ['check-text']
+ );
+ });
  });
 });