4 * Copyright 2013 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 ts = require("typescript");
22 var Lint = require("../index");
23 var Rule = /** @class */ (function (_super) {
24 tslib_1.__extends(Rule, _super);
26 return _super !== null && _super.apply(this, arguments) || this;
28 /* tslint:enable:object-literal-sort-keys */
29 Rule.FAILURE_STRING_FACTORY = function (method) {
30 return "Calls to 'console." + method + "' are not allowed.";
32 Rule.prototype.apply = function (sourceFile) {
33 return this.applyWithFunction(sourceFile, walk, this.ruleArguments);
35 /* tslint:disable:object-literal-sort-keys */
37 ruleName: "no-console",
38 description: "Bans the use of specified `console` methods.",
39 rationale: "In general, `console` methods aren't appropriate for production code.",
40 optionsDescription: "A list of method names to ban. If no method names are provided, all console methods are banned.",
43 items: { type: "string" },
45 optionExamples: [[true, "log", "error"]],
46 type: "functionality",
47 typescriptOnly: false,
50 }(Lint.Rules.AbstractRule));
53 return ts.forEachChild(ctx.sourceFile, function cb(node) {
54 if (tsutils_1.isPropertyAccessExpression(node) &&
55 tsutils_1.isIdentifier(node.expression) &&
56 node.expression.text === "console" &&
57 (ctx.options.length === 0 || ctx.options.indexOf(node.name.text) !== -1)) {
58 ctx.addFailureAtNode(node, Rule.FAILURE_STRING_FACTORY(node.name.text));
60 return ts.forEachChild(node, cb);