feat(rules): add ion-tabs-refactored rule (#93)

Author: mhartington

README.md

@@ -58,8 +58,8 @@ We are looking for contributors to help build these rules out! See [`CONTRIBUTIN
         "ion-range-attributes-renamed": true,
         "ion-segment-button-ion-label-required": true,
         "ion-spinner-attribute-values-renamed": true,
+        "ion-tabs-refactored": { "options": [true], "severity": "warning" },
         "ion-text-is-now-an-element": true
-
       }
     }
     ```
@@ -530,6 +530,20 @@ We are looking for contributors to help build these rules out! See [`CONTRIBUTIN
       <a href="https://github.com/dwieeb">@dwieeb</a>
     </td>
   </tr>
+
+  <tr>
+    <th>
+      <a href="https://github.com/ionic-team/ionic/blob/master/angular/BREAKING.md#tabs">Tabs</a>
+    </th>
+    <td></td>
+    <td>:white_check_mark:</td>
+    <td>
+      <code>ion-tabs-refactored</code>
+    </td>
+    <td>
+      <a href="https://github.com/mhartington">@mhartington</a>,
+    </td>
+  </tr>
   <tr>
     <th>
       <a href="https://github.com/ionic-team/ionic/blob/master/angular/BREAKING.md#text--typography">Text / Typography</a>

src/ionTabsRefactoredRule.ts

@@ -0,0 +1,52 @@
+import { NgWalker } from 'codelyzer/angular/ngWalker';
+import * as Lint from 'tslint';
+import * as ts from 'typescript';
+
+import * as ast from '@angular/compiler';
+import { BasicTemplateAstVisitor } from 'codelyzer/angular/templates/basicTemplateAstVisitor';
+import { MetadataReader } from 'codelyzer/angular/metadataReader';
+
+export const ruleName = 'ion-tabs-refactored';
+
+const TABS = 'ion-tabs';
+
+const TemplateVisitor = createTabsRefactoredVisitorClass(TABS);
+
+export class Rule extends Lint.Rules.AbstractRule {
+  public static metadata: Lint.IRuleMetadata = {
+    ruleName: ruleName,
+    type: 'functionality',
+    description: 'Tabs have been refacotred, please see this blog post: ',
+    options: null,
+    optionsDescription: 'Not configurable.',
+    typescriptOnly: false,
+    hasFix: false
+  };
+  public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+    return this.applyWithWalker(
+      new NgWalker(sourceFile, this.getOptions(), {
+        templateVisitorCtrl: TemplateVisitor
+      })
+    );
+  }
+}
+
+function generateErrorMessage() {
+  return `Tabs have gone through a significant refactor.
+    Please see https://github.com/ionic-team/ionic/blob/master/CHANGELOG.md#angular-tabs`;
+}
+
+export function createTabsRefactoredVisitorClass(tabElement: string) {
+  return class extends BasicTemplateAstVisitor {
+    visitElement(element: ast.ElementAst, context: any): any {
+      if (element.name === tabElement) this.checkElement(element);
+      super.visitElement(element, context);
+    }
+
+    private checkElement(element: ast.ElementAst) {
+      const start = element.sourceSpan.start.offset + 1;
+      const length = element.name.length;
+      this.addFailureAt(start, length, generateErrorMessage());
+    }
+  };
+}

test/ionTabsRefactored.spec.ts

@@ -0,0 +1,25 @@
+import { ruleName } from '../src/ionTabsRefactoredRule';
+import { assertAnnotated } from './testHelper';
+describe(ruleName, () => {
+  describe('failure', () => {
+    it('should fail when ion-tabs are used', () => {
+      let source = `
+      @Component({
+        template: \`
+          <ion-tabs>
+           ~~~~~~~~
+
+          </ion-tabs>
+          \`
+      })
+      class Bar{}
+          `;
+      assertAnnotated({
+        ruleName,
+        message: `Tabs have gone through a significant refactor.
+    Please see https://github.com/ionic-team/ionic/blob/master/CHANGELOG.md#angular-tabs`,
+        source
+      });
+    });
+  });
+});