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

   1 "use strict";
   2 /**
   3  * @license
   4  * Copyright 2019 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 utils = require("tsutils");
  21 var ts = require("typescript");
  22 var Lint = require("../index");
  23 var staticThis_examples_1 = require("./code-examples/staticThis.examples");
  24 var Rule = /** @class */ (function (_super) {
  25     tslib_1.__extends(Rule, _super);
  26     function Rule() {
  27         return _super !== null && _super.apply(this, arguments) || this;
  28     }
  29     Rule.prototype.apply = function (sourceFile) {
  30         return this.applyWithFunction(sourceFile, walk);
  31     };
  32     /* tslint:disable:object-literal-sort-keys */
  33     Rule.metadata = {
  34         ruleName: "static-this",
  35         description: "Ban the use of `this` in static methods.",
  36         hasFix: true,
  37         options: null,
  38         optionsDescription: "",
  39         optionExamples: [true],
  40         /* tslint:disable:max-line-length */
  41         rationale: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n            Static `this` usage can be confusing for newcomers.\n            It can also become imprecise when used with extended classes when a static `this` of a parent class no longer specifically refers to the parent class.\n        "], ["\n            Static \\`this\\` usage can be confusing for newcomers.\n            It can also become imprecise when used with extended classes when a static \\`this\\` of a parent class no longer specifically refers to the parent class.\n        "]))),
  42         /* tslint:enable:max-line-length */
  43         type: "functionality",
  44         typescriptOnly: false,
  45         codeExamples: staticThis_examples_1.codeExamples,
  46     };
  47     /* tslint:enable:object-literal-sort-keys */
  48     Rule.FAILURE_STRING = "Use the parent class name instead of `this` when in a `static` context.";
  49     return Rule;
  50 }(Lint.Rules.AbstractRule));
  51 exports.Rule = Rule;
  52 function walk(ctx) {
  53     var currentParentClass;
  54     var cb = function (node) {
  55         var originalParentClass = currentParentClass;
  56         if (utils.isClassLikeDeclaration(node.parent)) {
  57             currentParentClass = undefined;
  58             if (utils.hasModifier(node.modifiers, ts.SyntaxKind.StaticKeyword)) {
  59                 currentParentClass = node.parent;
  60             }
  61             ts.forEachChild(node, cb);
  62             currentParentClass = originalParentClass;
  63             return;
  64         }
  65         if (node.kind === ts.SyntaxKind.ThisKeyword && currentParentClass !== undefined) {
  66             var fix = void 0;
  67             if (currentParentClass.name !== undefined) {
  68                 fix = Lint.Replacement.replaceNode(node, currentParentClass.name.text);
  69             }
  70             ctx.addFailureAtNode(node, Rule.FAILURE_STRING, fix);
  71             return;
  72         }
  73         ts.forEachChild(node, cb);
  74     };
  75     ts.forEachChild(ctx.sourceFile, cb);
  76 }
  77 var templateObject_1;