feat(rules): allow custom class suffix

Fix #132
mgechev · Dec 10, 2016 · a019e3f · a019e3f
1 parent d5f117e
commit a019e3f
Show file tree

Hide file tree

Showing 4 changed files with 110 additions and 10 deletions.
diff --git a/src/componentClassSuffixRule.ts b/src/componentClassSuffixRule.ts
@@ -5,10 +5,10 @@ import {Ng2Walker} from './angular/ng2Walker';
 import {ComponentMetadata} from './angular/metadata';
 
 export class Rule extends Lint.Rules.AbstractRule {
-  static FAILURE: string = 'The name of the class %s should end with the suffix Component ($$02-03$$)';
+  static FAILURE: string = 'The name of the class %s should end with the suffix %s ($$02-03$$)';
 
-  static validate(className:string):boolean {
-    return /.*Component$/.test(className);
+  static validate(className: string, suffix: string):boolean {
+    return className.endsWith(suffix);
   }
 
   public apply(sourceFile:ts.SourceFile):Lint.RuleFailure[] {
@@ -22,12 +22,13 @@ export class ClassMetadataWalker extends Ng2Walker {
   visitNg2Component(meta: ComponentMetadata) {
     let name = meta.controller.name;
     let className: string = name.text;
-    if (!Rule.validate(className)) {
+    const suffix = this.getOptions()[0] || 'Component';
+    if (!Rule.validate(className, suffix)) {
       this.addFailure(
         this.createFailure(
           name.getStart(),
           name.getWidth(),
-          sprintf.apply(this, [Rule.FAILURE, className])));
+          sprintf.apply(this, [Rule.FAILURE, className, suffix])));
     }
     super.visitNg2Component(meta);
   }

diff --git a/src/directiveClassSuffixRule.ts b/src/directiveClassSuffixRule.ts
@@ -6,10 +6,10 @@ import {Ng2Walker} from './angular/ng2Walker';
 import {DirectiveMetadata} from './angular/metadata';
 
 export class Rule extends Lint.Rules.AbstractRule {
-  static FAILURE:string = 'The name of the class %s should end with the suffix Directive ($$02-03$$)';
+  static FAILURE:string = 'The name of the class %s should end with the suffix %s ($$02-03$$)';
 
-  static validate(className: string):boolean {
-    return /.*Directive/.test(className);
+  static validate(className: string, suffix: string):boolean {
+    return className.endsWith(suffix);
   }
 
   public apply(sourceFile:ts.SourceFile):Lint.RuleFailure[] {
@@ -23,12 +23,13 @@ export class ClassMetadataWalker extends Ng2Walker {
   visitNg2Directive(meta: DirectiveMetadata) {
     let name = meta.controller.name;
     let className:string = name.text;
-    if (!Rule.validate(className)) {
+    const suffix = this.getOptions()[0] || 'Directive';
+    if (!Rule.validate(className, suffix)) {
       this.addFailure(
         this.createFailure(
           name.getStart(),
           name.getWidth(),
-          sprintf.apply(this, [Rule.FAILURE, className])));
+          sprintf.apply(this, [Rule.FAILURE, className, suffix])));
     }
   }
 }
diff --git a/test/componentClassSuffixRule.spec.ts b/test/componentClassSuffixRule.spec.ts
@@ -72,4 +72,53 @@ describe('component-class-suffix', () => {
             assertSuccess('component-class-suffix', source);
         });
     });
+
+    describe('changed suffix', () => {
+        it('should suceed when different sufix is set', () => {
+            let source = `
+            @Component({
+                selector: 'sgBarFoo'
+            })
+            class TestPage {}`;
+            assertSuccess('component-class-suffix', source, ['Page']);
+        });
+
+        it('should fail when different sufix is set and doesnt match', () => {
+            let source = `
+            @Component({
+                selector: 'sgBarFoo'
+            })
+            class TestPage {}`;
+            assertFailure('component-class-suffix', source, {
+                message: 'The name of the class TestPage should end with the suffix Component ($$02-03$$)',
+                startPosition: {
+                    line: 4,
+                    character: 18
+                },
+                endPosition: {
+                    line: 4,
+                    character: 26
+                }
+            }, ['Component']);
+        });
+
+        it('should fail when different sufix is set and doesnt match', () => {
+            let source = `
+            @Component({
+                selector: 'sgBarFoo'
+            })
+            class TestDirective {}`;
+            assertFailure('component-class-suffix', source, {
+                message: 'The name of the class TestDirective should end with the suffix Page ($$02-03$$)',
+                startPosition: {
+                    line: 4,
+                    character: 18
+                },
+                endPosition: {
+                    line: 4,
+                    character: 31
+                }
+            }, ['Page']);
+        });
+    });
 });
diff --git a/test/directiveClassSuffix.spec.ts b/test/directiveClassSuffix.spec.ts
@@ -80,4 +80,53 @@ describe('directive-class-suffix', () => {
             assertSuccess('directive-class-suffix', source);
         });
     });
+
+    describe('changed suffix', () => {
+        it('should suceed when different sufix is set', () => {
+            let source = `
+            @Directive({
+                selector: 'sgBarFoo'
+            })
+            class TestPage {}`;
+            assertSuccess('directive-class-suffix', source, ['Page']);
+        });
+
+        it('should fail when different sufix is set and doesnt match', () => {
+            let source = `
+            @Directive({
+                selector: 'sgBarFoo'
+            })
+            class TestPage {}`;
+            assertFailure('directive-class-suffix', source, {
+                message: 'The name of the class TestPage should end with the suffix Directive ($$02-03$$)',
+                startPosition: {
+                    line: 4,
+                    character: 18
+                },
+                endPosition: {
+                    line: 4,
+                    character: 26
+                }
+            }, ['Directive']);
+        });
+
+        it('should fail when different sufix is set and doesnt match', () => {
+            let source = `
+            @Directive({
+                selector: 'sgBarFoo'
+            })
+            class TestDirective {}`;
+            assertFailure('directive-class-suffix', source, {
+                message: 'The name of the class TestDirective should end with the suffix Page ($$02-03$$)',
+                startPosition: {
+                    line: 4,
+                    character: 18
+                },
+                endPosition: {
+                    line: 4,
+                    character: 31
+                }
+            }, ['Page']);
+        });
+    });
 });