feat: implement check-text i18n rule

Author: mgechev

src/i18nRule.ts

@@ -14,7 +14,7 @@ const getSemicolonReplacements = (
  return [new Lint.Replacement(absolutePosition, 1, '; ')];
 };
 
-type Option = 'check-id' | 'check-i18n';
+type Option = 'check-id' | 'check-text';
 
 interface ConfigurableVisitor {
  getOption(): Option;
@@ -47,24 +47,41 @@ class I18NAttrVisitor extends BasicTemplateAstVisitor
 
 class I18NTextVisitor extends BasicTemplateAstVisitor
  implements ConfigurableVisitor {
- visitAttr(attr: ast.AttrAst, context: BasicTemplateAstVisitor) {
- if (attr.name === 'i18n' && attr.value) {
- const parts = attr.value.split('@@');
- if (parts.length <= 1 || parts[1].length === 0) {
-const span = attr.sourceSpan;
+ private hasI18n = false;
+ private nestedElements = [];
+ private visited = new Set<ast.TextAst>();
+
+ visitText(text: ast.TextAst, context: BasicTemplateAstVisitor) {
+ if (!this.visited.has(text)) {
+ this.visited.add(text);
+ const textNonEmpty = text.value.trim().length > 0;
+ if (
+(!this.hasI18n && textNonEmpty && this.nestedElements.length) ||
+(textNonEmpty && !this.nestedElements.length)
+ ) {
+const span = text.sourceSpan;
 context.addFailure(
  context.createFailure(
  span.start.offset,
  span.end.offset - span.start.offset,
- 'Missing custom message identifier. For more information visit https://angular.io/guide/i18n'
+ 'Each element containing text node should has an i18n attribute'
  )
 );
  }
  }
- super.visitAttr(attr, context);
+ super.visitText(text, context);
+ }
+
+ visitElement(element: ast.ElementAst, context: BasicTemplateAstVisitor) {
+ this.hasI18n = element.attrs.some(e => e.name === 'i18n');
+ this.nestedElements.push(element.name);
+ super.visitElement(element, context);
+ this.nestedElements.pop();
+ this.hasI18n = false;
  }
+
  getOption(): Option {
- return 'check-id';
+ return 'check-text';
  }
 }
 
@@ -97,6 +114,26 @@ class I18NTemplateVisitor extends BasicTemplateAstVisitor {
  .forEach(f => this.addFailure(f));
  super.visitAttr(attr, context);
  }
+
+ visitElement(element: ast.ElementAst, context: any): any {
+ const options = this.getOptions();
+ this.visitors
+ .filter(v => options.indexOf(v.getOption()) >= 0)
+ .map(v => v.visitElement(element, this))
+ .filter(f => !!f)
+ .forEach(f => this.addFailure(f));
+ super.visitElement(element, context);
+ }
+
+ visitText(text: ast.TextAst, context: any): any {
+ const options = this.getOptions();
+ this.visitors
+ .filter(v => options.indexOf(v.getOption()) >= 0)
+ .map(v => v.visitText(text, this))
+ .filter(f => !!f)
+ .forEach(f => this.addFailure(f));
+ super.visitText(text, context);
+ }
 }
 
 export class Rule extends Lint.Rules.AbstractRule {

test/i18nRule.spec.ts

@@ -8,13 +8,14 @@ import { expect } from 'chai';
 import { FsFileResolver } from '../src/angular/fileResolver/fsFileResolver';
 import { MetadataReader } from '../src/angular/metadataReader';
 import * as ts from 'typescript';
+import { assertFailure } from './testHelper';
 import chai = require('chai');
 
 const getAst = (code: string, file = 'file.ts') => {
  return ts.createSourceFile(file, code, ts.ScriptTarget.ES5, true);
 };
 
-describe.only('i18n', () => {
+describe('i18n', () => {
  describe('check-id', () => {
  it('should work with proper id', () => {
  let source = `
@@ -78,4 +79,78 @@ describe.only('i18n', () => {
  });
  });
  });
+
+ describe('check-id', () => {
+ it('should work with i18n attribute', () => {
+ let source = `
+ @Component({
+template: \`
+ <div i18n>Text</div>
+\`
+ })
+ class Bar {}
+ `;
+ assertSuccess('i18n', source, ['check-text']);
+ });
+
+ it('should work without i18n attribute & interpolation', () => {
+ let source = `
+ @Component({
+template: \`
+ <div>{{text}}</div>
+\`
+ })
+ class Bar {}
+ `;
+ assertSuccess('i18n', source, ['check-text']);
+ });
+
+ it('should fail with missing id string', () => {
+ let source = `
+ @Component({
+template: \`
+ <div>Text</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
+\`
+ })
+ 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']
+ );
+ });
+ });
 });