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 ts = require("typescript");
22 var Lint = require("../index");
23 var preferWhile_examples_1 = require("./code-examples/preferWhile.examples");
24 var Rule = /** @class */ (function (_super) {
25 tslib_1.__extends(Rule, _super);
27 return _super !== null && _super.apply(this, arguments) || this;
29 Rule.prototype.apply = function (sourceFile) {
32 var cb = function (node) {
33 if (tsutils_1.isForStatement(node) && _this.doesNodeViolateRule(node)) {
34 failures.push(_this.createFailure(sourceFile, node));
36 return ts.forEachChild(node, cb);
38 ts.forEachChild(sourceFile, cb);
41 Rule.prototype.doesNodeViolateRule = function (node) {
42 return node.initializer === undefined && node.incrementor === undefined;
44 Rule.prototype.createFailure = function (sourceFile, node) {
45 var start = node.getStart(sourceFile);
46 var end = node.statement.pos;
48 if (node.condition === undefined) {
49 fix = Lint.Replacement.replaceFromTo(start, end, "while (true)");
53 Lint.Replacement.replaceFromTo(start, node.condition.getStart(sourceFile), "while ("),
54 Lint.Replacement.deleteFromTo(node.condition.end, end - 1),
57 return new Lint.RuleFailure(sourceFile, start, end, Rule.FAILURE_STRING, this.ruleName, fix);
59 /* tslint:disable:object-literal-sort-keys */
61 ruleName: "prefer-while",
62 description: "Prefer `while` loops instead of `for` loops without an initializer and incrementor.",
63 rationale: "Simplifies the readability of the loop statement, while maintaining the same functionality.",
64 optionsDescription: "Not configurable.",
66 optionExamples: [true],
69 typescriptOnly: false,
70 codeExamples: preferWhile_examples_1.codeExamples,
72 /* tslint:enable:object-literal-sort-keys */
73 Rule.FAILURE_STRING = "Prefer `while` loops instead of `for` loops without an initializer and incrementor.";
75 }(Lint.Rules.AbstractRule));