Added ban rule for banning specified functions

justinuang · Dec 4, 2013 · 7bf5b52 · 7bf5b52
1 parent 4ff9296
commit 7bf5b52
Show file tree

Hide file tree

Showing 6 changed files with 112 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@ A linter for the TypeScript language.
 Supported Rules
 -----
 
+* `ban` bans the use of specific functions. Options are ["object", "function"] pairs that ban the use of object.function()
 * `class-name` enforces PascalCased class and interface names.
 * `curly` enforces braces for `if`/`for`/`do`/`while` statements.
 * `eofline` enforces the file to end with a newline.
@@ -16,7 +17,7 @@ Supported Rules
 * `max-line-length` sets the maximum length of a line.
 * `no-arg` disallows access to `arguments.callee`.
 * `no-bitwise` disallows bitwise operators.
-* `no-console` disallows access to the specified properties on `console`. Rule options are properties to ban on the console variable.
+* `no-console` disallows access to the specified functions on `console`. Rule options are functions to ban on the console variable.
 * `no-construct` disallows access to the constructors of `String`, `Number`, and `Boolean`.
 * `no-debugger` disallows `debugger` statements.
 * `no-duplicate-key` disallows duplicate keys in object literals.

diff --git a/src/rules/banRule.ts b/src/rules/banRule.ts
@@ -0,0 +1,64 @@
+/*
+ * Copyright 2013 Palantir Technologies, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+*/
+
+/// <reference path='../../lib/tslint.d.ts' />
+
+export class Rule extends Lint.Rules.AbstractRule {
+    public static FAILURE_STRING_PART = "use of the following function is disallowed: ";
+
+    public apply(syntaxTree: TypeScript.SyntaxTree): Lint.RuleFailure[] {
+        var options = this.getOptions();
+        var banFunctionWalker = new BanFunctionWalker(syntaxTree, options);
+        var functionsToBan = options;
+        functionsToBan.forEach((functionToBan) => {
+            banFunctionWalker.addBannedFunction(functionToBan);
+        });
+        return this.applyWithWalker(banFunctionWalker);
+    }
+  }
+
+export class BanFunctionWalker extends Lint.RuleWalker {
+
+    private bannedFunctions: string[][] = [];
+
+    public addBannedFunction(bannedFunction: string[]) {
+        this.bannedFunctions.push(bannedFunction);
+    }
+
+    public visitInvocationExpression(node: TypeScript.InvocationExpressionSyntax): void {
+        var expression = node.expression;
+
+        if (expression.kind() === TypeScript.SyntaxKind.MemberAccessExpression &&
+            expression.childCount() >= 3) {
+
+            var firstToken = expression.firstToken();
+            var secondToken = expression.childAt(1);
+            var thirdToken = expression.childAt(2);
+
+            if (secondToken.kind() === TypeScript.SyntaxKind.DotToken) {
+                this.bannedFunctions.forEach((bannedFunction) => {
+                    if (firstToken.text() === bannedFunction[0] && thirdToken.fullText() === bannedFunction[1]) {
+                        var position = this.position() + node.leadingTriviaWidth();
+                        this.addFailure(this.createFailure(position, expression.width(), Rule.FAILURE_STRING_PART +
+                            firstToken.text() + "." + thirdToken.fullText()));
+                    }
+                });
+            }
+        }
+
+        super.visitInvocationExpression(node);
+    }
+}
diff --git a/src/rules/noConsoleRule.ts b/src/rules/noConsoleRule.ts
@@ -16,35 +16,15 @@
 
 /// <reference path='../../lib/tslint.d.ts' />
 
-export class Rule extends Lint.Rules.AbstractRule {
-    public static FAILURE_STRING = "access forbidden to console property";
+import BanRule = require("banRule");
 
+export class Rule extends BanRule.Rule {
     public apply(syntaxTree: TypeScript.SyntaxTree): Lint.RuleFailure[] {
-        return this.applyWithWalker(new NoConsoleWalker(syntaxTree, this.getOptions()));
-    }
-  }
-
-class NoConsoleWalker extends Lint.RuleWalker {
-    public visitInvocationExpression(node: TypeScript.InvocationExpressionSyntax): void {
         var options = this.getOptions();
-        var expression = node.expression;
-
-        if (expression.kind() === TypeScript.SyntaxKind.MemberAccessExpression &&
-            expression.childCount() >= 3) {
-
-            var firstToken = expression.firstToken();
-            var secondToken = expression.childAt(1);
-            var thirdToken = expression.childAt(2);
-
-            if (firstToken.text() === "console" &&
-                secondToken.kind() === TypeScript.SyntaxKind.DotToken &&
-                options.indexOf(thirdToken.fullText()) !== -1) {
-
-                var position = this.position() + node.leadingTriviaWidth();
-                this.addFailure(this.createFailure(position, expression.width(), Rule.FAILURE_STRING));
-            }
-        }
-
-        super.visitInvocationExpression(node);
+        var consoleBanWalker = new BanRule.BanFunctionWalker(syntaxTree, this.getOptions());
+        options.forEach((option) => {
+            consoleBanWalker.addBannedFunction(["console", option]);
+        });
+        return this.applyWithWalker(consoleBanWalker);
     }
-}
+  }
diff --git a/test/files/rules/ban.test.ts b/test/files/rules/ban.test.ts
@@ -0,0 +1,3 @@
+console.time();
+window.toString();
+console.log();
diff --git a/test/rules/banRuleTests.ts b/test/rules/banRuleTests.ts
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2013 Palantir Technologies, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+*/
+
+/// <reference path='../references.ts' />
+
+describe("<ban>", () => {
+    it("bans access to specified functions", () => {
+        var fileName = "rules/ban.test.ts";
+        var BanRule = Lint.Test.getRule("ban");
+        var dirFailure = Lint.Test.createFailuresOnFile(fileName, BanRule.FAILURE_STRING_PART + "window.toString")([2, 1], [2, 16]);
+
+        var actualFailures = Lint.Test.applyRuleOnFile(fileName, BanRule, [true, ["window", "toString"]]);
+        Lint.Test.assertContainsFailure(actualFailures, dirFailure);
+    });
+});
diff --git a/test/rules/noConsoleRuleTests.ts b/test/rules/noConsoleRuleTests.ts
@@ -20,13 +20,15 @@ describe("<no-console>", () => {
     it("forbids access to specified console properties", () => {
         var fileName = "rules/noconsole.test.ts";
         var NoConsoleRule = Lint.Test.getRule("no-console");
-        var createFailure = Lint.Test.createFailuresOnFile(fileName, NoConsoleRule.FAILURE_STRING);
-        var dirFailure = createFailure([3, 1], [3, 12]);
-        var errorFailure = createFailure([7, 1], [7, 14]);
-        var logFailure = createFailure([2, 1], [2, 12]);
-        var warnFailure = createFailure([6, 1], [6, 13]);
+        var dirFailure = Lint.Test.createFailuresOnFile(fileName, NoConsoleRule.FAILURE_STRING_PART + "console.dir")([3, 1], [3, 12]);
+        var errorFailure = Lint.Test.createFailuresOnFile(fileName, NoConsoleRule.FAILURE_STRING_PART + "console.error")([7, 1], [7, 14]);
+        var logFailure = Lint.Test.createFailuresOnFile(fileName, NoConsoleRule.FAILURE_STRING_PART + "console.log")([2, 1], [2, 12]);
+        var warnFailure = Lint.Test.createFailuresOnFile(fileName, NoConsoleRule.FAILURE_STRING_PART + "console.warn")([6, 1], [6, 13]);
 
         var actualFailures = Lint.Test.applyRuleOnFile(fileName, NoConsoleRule, [true, "dir", "error", "log", "warn"]);
         Lint.Test.assertContainsFailure(actualFailures, dirFailure);
+        Lint.Test.assertContainsFailure(actualFailures, errorFailure);
+        Lint.Test.assertContainsFailure(actualFailures, logFailure);
+        Lint.Test.assertContainsFailure(actualFailures, warnFailure);
     });
 });