feat: add ng2 walker

Fix #6

Author: mgechev

manual_typings/chai-spies.d.ts

@@ -0,0 +1,5 @@
+declare var spy: any;
+
+declare module "chai-spies" {
+  export = spy;
+}

package.json

@@ -29,6 +29,7 @@
   "homepage": "https://github.com/mgechev/ng2lint#readme",
   "devDependencies": {
     "chai": "^3.5.0",
+    "chai-spies": "^0.7.1",
     "mocha": "^2.4.5",
     "ts-node": "^0.5.5",
     "typings": "^0.6.8"

src/util/ng2Walker.ts

@@ -0,0 +1,64 @@
+import * as Lint from 'tslint/lib/lint';
+import * as ts from 'typescript';
+
+const getDecoratorName = (decorator: ts.Decorator) => {
+  let baseExpr = <any>decorator.expression || {};
+  let expr = baseExpr.expression || {};
+  return expr.text;
+};
+
+const getDecoratorStringArgs = (decorator: ts.Decorator) => {
+  let baseExpr = <any>decorator.expression || {};
+  let expr = baseExpr.expression || {};
+  let args = baseExpr.arguments || [];
+  return args.map(a => (a.kind === ts.SyntaxKind.StringLiteral) ? a.text : null);
+};
+
+export class Ng2Walker extends Lint.RuleWalker {
+  visitClassDeclaration(declaration: ts.ClassDeclaration) {
+    (declaration.decorators || []).forEach(this.visitClassDecorator.bind(this));
+    super.visitClassDeclaration(declaration);
+  }
+  visitMethodDeclaration(method: ts.MethodDeclaration) {
+    (method.decorators || []).forEach(this.visitMethodDecorator.bind(this));
+    super.visitMethodDeclaration(method);
+  }
+  protected visitMethodDecorator(decorator: ts.Decorator) {
+    let name = getDecoratorName(decorator);
+    if (name === 'HostListener') {
+      this.visitNg2HostListener(<ts.MethodDeclaration>decorator.parent, decorator, getDecoratorStringArgs(decorator));
+    }
+  }
+  visitPropertyDeclaration(prop: ts.PropertyDeclaration) {
+    (prop.decorators || []).forEach(this.visitPropertyDecorator.bind(this));
+    super.visitPropertyDeclaration(prop);
+  }
+  protected visitPropertyDecorator(decorator: ts.Decorator) {
+    let name = getDecoratorName(decorator);
+    switch (name) {
+      case 'Input':
+      this.visitNg2Input(<ts.PropertyDeclaration>decorator.parent, decorator, getDecoratorStringArgs(decorator));
+      break;
+      case 'Output':
+      this.visitNg2Output(<ts.PropertyDeclaration>decorator.parent, decorator, getDecoratorStringArgs(decorator));
+      break;
+      case 'HostBinding':
+      this.visitNg2HostBinding(<ts.PropertyDeclaration>decorator.parent, decorator, getDecoratorStringArgs(decorator));
+      break;
+    }
+  }
+  protected visitClassDecorator(decorator: ts.Decorator) {
+    let name = getDecoratorName(decorator);
+    if (name === 'Component') {
+      this.visitNg2Component(<ts.ClassDeclaration>decorator.parent, decorator);
+    } else if (name === 'Directive') {
+      this.visitNg2Directive(<ts.ClassDeclaration>decorator.parent, decorator);
+    }
+  }
+  protected visitNg2Component(controller: ts.ClassDeclaration, decorator: ts.Decorator) {}
+  protected visitNg2Directive(controller: ts.ClassDeclaration, decorator: ts.Decorator) {}
+  protected visitNg2Input(property: ts.PropertyDeclaration, input: ts.Decorator, args: string[]) {}
+  protected visitNg2Output(property: ts.PropertyDeclaration, output: ts.Decorator, args: string[]) {}
+  protected visitNg2HostBinding(property: ts.PropertyDeclaration, decorator: ts.Decorator, args: string[]) {}
+  protected visitNg2HostListener(method: ts.MethodDeclaration, decorator: ts.Decorator, args: string[]) {}
+}

test/util/ng2Walker.spec.ts

@@ -0,0 +1,62 @@
+import * as ts from 'typescript';
+import * as tslint from 'tslint/lib/lint';
+
+import {Ng2Walker} from '../../src/util/ng2Walker';
+import chai = require('chai');
+import * as spies from 'chai-spies';
+
+chai.use(spies);
+
+const chaiSpy = (<any>chai).spy;
+describe('ng2Walker', () => {
+  it('should visit components and directives', () => {
+    let source = `
+      @Component({
+        selector: 'foo',
+        template: 'bar'
+      })
+      class Baz {}
+      @Directive({
+        selector: '[baz]'
+      })
+      class Foobar {}
+    `;
+    let ruleArgs: tslint.IOptions = {
+      ruleName: 'foo',
+      ruleArguments: ['foo'],
+      disabledIntervals: null
+    };
+    let sf = ts.createSourceFile('foo', source, null);
+    let walker = new Ng2Walker(sf, ruleArgs);
+    let cmpSpy = chaiSpy.on(walker, 'visitNg2Component');
+    let dirSpy = chaiSpy.on(walker, 'visitNg2Directive');
+    walker.walk(sf);
+    (<any>chai.expect(cmpSpy).to.have.been).called();
+    (<any>chai.expect(dirSpy).to.have.been).called();
+  });
+  it('should visit inputs and outputs with args', () => {
+    let source = `
+      @Component({
+        selector: 'foo',
+      })
+      class Baz {
+        @Input('bar')
+        foo;
+        @Output('baz')
+        foobar;
+      }
+    `;
+    let ruleArgs: tslint.IOptions = {
+      ruleName: 'foo',
+      ruleArguments: ['foo'],
+      disabledIntervals: null
+    };
+    let sf = ts.createSourceFile('foo', source, null);
+    let walker = new Ng2Walker(sf, ruleArgs);
+    let outputsSpy = chaiSpy.on(walker, 'visitNg2Output');
+    let inputsSpy = chaiSpy.on(walker, 'visitNg2Input');
+    walker.walk(sf);
+    (<any>chai.expect(outputsSpy).to.have.been).called();
+    (<any>chai.expect(inputsSpy).to.have.been).called();
+  });
+});