4 * Copyright 2018 Palantir Technologies, Inc.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 Object.defineProperty(exports, "__esModule", { value: true });
19 var tslib_1 = require("tslib");
20 var tsutils_1 = require("tsutils");
21 var Lint = require("../index");
22 var banTsIgnore_examples_1 = require("./code-examples/banTsIgnore.examples");
23 var Rule = /** @class */ (function (_super) {
24 tslib_1.__extends(Rule, _super);
26 return _super !== null && _super.apply(this, arguments) || this;
28 Rule.prototype.apply = function (sourceFile) {
29 return this.applyWithFunction(sourceFile, walk);
31 /* tslint:disable:object-literal-sort-keys */
33 ruleName: "ban-ts-ignore",
34 description: 'Bans "// @ts-ignore" comments from being used.',
35 optionsDescription: "Not configurable.",
37 optionExamples: [true],
40 codeExamples: banTsIgnore_examples_1.codeExamples,
42 /* tslint:disable:object-literal-sort-keys */
43 Rule.FAILURE_STRING = 'Do not use "// @ts-ignore" comments because they suppress compilation errors.';
45 }(Lint.Rules.AbstractRule));
48 var ignoreDiagnosticCommentRegEx = /^\s*\/\/\/?\s*@ts-ignore/;
49 tsutils_1.forEachComment(ctx.sourceFile, function (fullText, comment) {
50 var commentText = fullText.slice(comment.pos, comment.end);
51 if (Boolean(commentText.match(ignoreDiagnosticCommentRegEx))) {
52 ctx.addFailure(comment.pos, comment.end, Rule.FAILURE_STRING);