fix(ban): Include ban explanation in failure.

cartant · Apr 30, 2018 · 5e993fe · 5e993fe
1 parent a588a96
commit 5e993fe
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 8 deletions.
diff --git a/fixtures/v6/ban-observables/tslint.json b/fixtures/v6/ban-observables/tslint.json
@@ -4,7 +4,7 @@
   "rules": {
     "rxjs-ban-observables": {
       "options": [{
-        "concat": true,
+        "concat": "Explanation for concat",
         "merge": true
       }],
       "severity": "error"

diff --git a/fixtures/v6/ban-operators/tslint.json b/fixtures/v6/ban-operators/tslint.json
@@ -4,7 +4,7 @@
   "rules": {
     "rxjs-ban-operators": {
       "options": [{
-        "concat": true,
+        "concat": "Explanation for concat",
         "merge": true
       }],
       "severity": "error"

diff --git a/source/fixtures-spec.ts b/source/fixtures-spec.ts
@@ -736,7 +736,11 @@ describe(`${fixtureVersion} fixtures`, function (): void {
                     const result = lint("ban-observables", "tslint.json");
 
                     expect(result).to.have.property("errorCount", 2);
-                    result.failures.forEach(failure => expect(failure).to.have.property("ruleName", "rxjs-ban-observables"));
+                    result.failures.forEach(failure => {
+                        expect(failure).to.have.property("ruleName", "rxjs-ban-observables");
+                        const message = failure.getFailure();
+                        expect(/concat/.test(message)).to.equal(/Explanation for concat/.test(message));
+                    });
                 });
             });
 
@@ -747,7 +751,11 @@ describe(`${fixtureVersion} fixtures`, function (): void {
                     const result = lint("ban-operators", "tslint.json");
 
                     expect(result).to.have.property("errorCount", 2);
-                    result.failures.forEach(failure => expect(failure).to.have.property("ruleName", "rxjs-ban-operators"));
+                    result.failures.forEach(failure => {
+                        expect(failure).to.have.property("ruleName", "rxjs-ban-operators");
+                        const message = failure.getFailure();
+                        expect(/concat/.test(message)).to.equal(/Explanation for concat/.test(message));
+                    });
                 });
             });
 

diff --git a/source/rules/rxjsBanObservablesRule.ts b/source/rules/rxjsBanObservablesRule.ts
@@ -92,8 +92,10 @@ class Walker extends UsedWalker {
 
         const { _bans } = this;
         for (let b = 0, length = _bans.length; b < length; ++b) {
-            if (_bans[b].regExp.test(name)) {
-                return `${Rule.FAILURE_STRING}: ${name}`;
+            const ban = _bans[b];
+            if (ban.regExp.test(name)) {
+                const explanation = ban.explanation ? `: ${ban.explanation}` : "";
+                return `${Rule.FAILURE_STRING}: ${name}${explanation}`;
             }
         }
         return undefined;

diff --git a/source/rules/rxjsBanOperatorsRule.ts b/source/rules/rxjsBanOperatorsRule.ts
@@ -92,8 +92,10 @@ class Walker extends UsedWalker {
 
         const { _bans } = this;
         for (let b = 0, length = _bans.length; b < length; ++b) {
-            if (_bans[b].regExp.test(name)) {
-                return `${Rule.FAILURE_STRING}: ${name}`;
+            const ban = _bans[b];
+            if (ban.regExp.test(name)) {
+                const explanation = ban.explanation ? `: ${ban.explanation}` : "";
+                return `${Rule.FAILURE_STRING}: ${name}${explanation}`;
             }
         }
         return undefined;