.config/coc/extensions/node_modules/coc-prettier/node_modules/tslint/lib/rules/forinRule.js

   1 "use strict";
   2 /**
   3  * @license
   4  * Copyright 2013 Palantir Technologies, Inc.
   5  *
   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
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  */
  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);
  25     function Rule() {
  26         return _super !== null && _super.apply(this, arguments) || this;
  27     }
  28     Rule.prototype.apply = function (sourceFile) {
  29         return this.applyWithFunction(sourceFile, walk);
  30     };
  31     /* tslint:disable:object-literal-sort-keys */
  32     Rule.metadata = {
  33         ruleName: "forin",
  34         description: "Requires a `for ... in` statement to be filtered with an `if` statement.",
  35         rationale: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n            ```ts\n            for (let key in someObject) {\n                if (someObject.hasOwnProperty(key)) {\n                    // code here\n                }\n            }\n            ```\n            Prevents accidental iteration over properties inherited from an object's prototype.\n            See [MDN's `for...in`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for...in)\n            documentation for more information about `for...in` loops.\n\n            Also consider using a [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)\n            or [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set)\n            if you're storing collections of objects.\n            Using `Object`s can cause occasional edge case bugs, such as if a key is named \"hasOwnProperty\".\n        "], ["\n            \\`\\`\\`ts\n            for (let key in someObject) {\n                if (someObject.hasOwnProperty(key)) {\n                    // code here\n                }\n            }\n            \\`\\`\\`\n            Prevents accidental iteration over properties inherited from an object's prototype.\n            See [MDN's \\`for...in\\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for...in)\n            documentation for more information about \\`for...in\\` loops.\n\n            Also consider using a [\\`Map\\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)\n            or [\\`Set\\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set)\n            if you're storing collections of objects.\n            Using \\`Object\\`s can cause occasional edge case bugs, such as if a key is named \"hasOwnProperty\".\n        "]))),
  36         optionsDescription: "Not configurable.",
  37         options: null,
  38         optionExamples: [true],
  39         type: "functionality",
  40         typescriptOnly: false,
  41     };
  42     /* tslint:enable:object-literal-sort-keys */
  43     Rule.FAILURE_STRING = "for (... in ...) statements must be filtered with an if statement";
  44     return Rule;
  45 }(Lint.Rules.AbstractRule));
  46 exports.Rule = Rule;
  47 function walk(ctx) {
  48     return ts.forEachChild(ctx.sourceFile, function cb(node) {
  49         if (tsutils_1.isForInStatement(node) && tsutils_1.isBlock(node.statement) && !isFiltered(node.statement)) {
  50             ctx.addFailureAtNode(node, Rule.FAILURE_STRING);
  51         }
  52         return ts.forEachChild(node, cb);
  53     });
  54 }
  55 function isFiltered(_a) {
  56     var statements = _a.statements;
  57     switch (statements.length) {
  58         case 0:
  59             return true;
  60         case 1:
  61             return statements[0].kind === ts.SyntaxKind.IfStatement;
  62         default:
  63             return (statements[0].kind === ts.SyntaxKind.IfStatement &&
  64                 nodeIsContinue(statements[0].thenStatement));
  65     }
  66 }
  67 function nodeIsContinue(node) {
  68     return (node.kind === ts.SyntaxKind.ContinueStatement ||
  69         (tsutils_1.isBlock(node) &&
  70             node.statements.length === 1 &&
  71             node.statements[0].kind === ts.SyntaxKind.ContinueStatement));
  72 }
  73 var templateObject_1;