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

   1 "use strict";
   2 /**
   3  * @license
   4  * Copyright 2017 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     /* tslint:enable:object-literal-sort-keys */
  29     Rule.FAILURE_STRING_FACTORY = function (typeName, messageAddition) {
  30         return "Don't use '" + typeName + "' as a type." + (messageAddition !== undefined ? " " + messageAddition : "");
  31     };
  32     Rule.prototype.apply = function (sourceFile) {
  33         return this.applyWithFunction(sourceFile, walk, this.ruleArguments.map(parseOption));
  34     };
  35     /* tslint:disable:object-literal-sort-keys */
  36     Rule.metadata = {
  37         ruleName: "ban-types",
  38         description: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n            Bans specific types from being used. Does not ban the\n            corresponding runtime objects from being used."], ["\n            Bans specific types from being used. Does not ban the\n            corresponding runtime objects from being used."]))),
  39         options: {
  40             type: "list",
  41             listType: {
  42                 type: "array",
  43                 items: { type: "string" },
  44                 minLength: 1,
  45                 maxLength: 2,
  46             },
  47         },
  48         optionsDescription: Lint.Utils.dedent(templateObject_2 || (templateObject_2 = tslib_1.__makeTemplateObject(["\n            A list of `[\"regex\", \"optional explanation here\"]`, which bans\n            types that match `regex`"], ["\n            A list of \\`[\"regex\", \"optional explanation here\"]\\`, which bans\n            types that match \\`regex\\`"]))),
  49         optionExamples: [[true, ["Object", "Use {} instead."], ["String"]]],
  50         type: "typescript",
  51         typescriptOnly: true,
  52     };
  53     return Rule;
  54 }(Lint.Rules.AbstractRule));
  55 exports.Rule = Rule;
  56 function parseOption(_a) {
  57     var pattern = _a[0], message = _a[1];
  58     return { message: message, pattern: new RegExp("^" + pattern + "$") };
  59 }
  60 function walk(ctx) {
  61     return ts.forEachChild(ctx.sourceFile, function cb(node) {
  62         if (tsutils_1.isTypeReferenceNode(node)) {
  63             var typeName = node.getText(ctx.sourceFile);
  64             for (var _i = 0, _a = ctx.options; _i < _a.length; _i++) {
  65                 var ban = _a[_i];
  66                 if (ban.pattern.test(typeName)) {
  67                     ctx.addFailureAtNode(node, Rule.FAILURE_STRING_FACTORY(typeName, ban.message));
  68                     break;
  69                 }
  70             }
  71         }
  72         return ts.forEachChild(node, cb);
  73     });
  74 }
  75 var templateObject_1, templateObject_2;