Add ban-ts-ignore rule.

src/configs/all.ts

@@ -36,6 +36,7 @@ export const rules = {
             ["Symbol", "Avoid using the `Symbol` type. Did you mean `symbol`?"],
         ],
     },
+    "ban-ts-ignore": true,
     "member-access": [true, "check-accessor", "check-constructor", "check-parameter-property"],
     "member-ordering": [true, {
         "order": "statics-first",

src/rules/banTsIgnoreRule.ts

@@ -0,0 +1,52 @@
+/**
+ * @license
+ * Copyright 2018 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.
+ */
+
+import { forEachComment } from "tsutils";
+import * as ts from "typescript";
+import * as Lint from "../index";
+import { codeExamples } from "./code-examples/banTsIgnore.examples";
+
+export class Rule extends Lint.Rules.AbstractRule {
+    /* tslint:disable:object-literal-sort-keys */
+    public static metadata: Lint.IRuleMetadata = {
+        ruleName: "ban-ts-ignore",
+        description: 'Bans "// @ts-ignore" comments from being used.',
+        optionsDescription: "Not configurable.",
+        options: null,
+        optionExamples: [true],
+        type: "typescript",
+        typescriptOnly: true,
+        codeExamples,
+    };
+    /* tslint:disable:object-literal-sort-keys */
+
+    public static FAILURE_STRING = 'Do not use "// @ts-ignore" comments because they suppress compilation errors.';
+
+    public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        return this.applyWithFunction(sourceFile, walk);
+    }
+}
+
+function walk(ctx: Lint.WalkContext<void>) {
+    const ignoreDiagnosticCommentRegEx = /^\s*\/\/\/?\s*@ts-ignore/;
+    forEachComment(ctx.sourceFile, (fullText, comment) => {
+        const commentText = fullText.slice(comment.pos, comment.end);
+        if (Boolean(commentText.match(ignoreDiagnosticCommentRegEx))) {
+            ctx.addFailure(comment.pos, comment.end, Rule.FAILURE_STRING);
+        }
+    });
+}

src/rules/code-examples/banTsIgnore.examples.ts

@@ -0,0 +1,37 @@
+/**
+ * @license
+ * Copyright 2018 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.
+ */
+
+import * as Lint from "../../index";
+
+// tslint:disable: object-literal-sort-keys
+export const codeExamples = [
+    {
+        description: 'Disallows the use of "@ts-ignore"',
+        config: Lint.Utils.dedent`
+            "rules": { "ban-ts-ignore": true }
+        `,
+        pass: Lint.Utils.dedent`
+            console.log("hello");
+        `,
+        fail: Lint.Utils.dedent`
+            if (false) {
+                // @ts-ignore: Unreachable code error
+                console.log("hello");
+            }
+        `,
+    },
+];

src/rules/code-examples/curly.examples.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2013 Palantir Technologies, Inc.
+ * Copyright 2018 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.

test/rules/ban-ts-ignore/test.ts.lint

@@ -0,0 +1,33 @@
+if (false) {
+    // @ts-ignore: Unreachable code error
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [Do not use "// @ts-ignore" comments because they suppress compilation errors.]
+    console.log("hello"); // Random comments.
+}
+
+var x = 0;
+
+/// @ts-ignore Triple-slash
+~~~~~~~~~~~~~~~~~~~~~~~~~~~ [Do not use "// @ts-ignore" comments because they suppress compilation errors.]
+x();
+
+/// @ts-ignore
+~~~~~~~~~~~~~~ [Do not use "// @ts-ignore" comments because they suppress compilation errors.]
+x(
+    2,
+    3);
+
+// come comment
+
+// @ts-ignore Multiple comments
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [Do not use "// @ts-ignore" comments because they suppress compilation errors.]
+
+// some other comment
+
+// @anohter
+
+x();
+
+x( // @ts-ignore inline
+   ~~~~~~~~~~~~~~~~~~~~ [Do not use "// @ts-ignore" comments because they suppress compilation errors.]
+    2,
+    3);

test/rules/ban-ts-ignore/tslint.json

@@ -0,0 +1,6 @@
+{
+    "rules": {
+      "ban-ts-ignore": true
+    }
+  }
+