.config/coc/extensions/node_modules/coc-prettier/node_modules/tslint/lib/rules/noEmptyInterfaceRule.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 noEmptyInterface_examples_1 = require("./code-examples/noEmptyInterface.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: "no-empty-interface",
  35         description: "Forbids empty interfaces.",
  36         rationale: "An empty interface is equivalent to its supertype (or `{}`).",
  37         optionsDescription: "Not configurable.",
  38         options: null,
  39         type: "typescript",
  40         typescriptOnly: true,
  41         codeExamples: noEmptyInterface_examples_1.codeExamples,
  42     };
  43     /* tslint:enable:object-literal-sort-keys */
  44     Rule.FAILURE_STRING = "An empty interface is equivalent to `{}`.";
  45     Rule.FAILURE_STRING_FOR_EXTENDS = "An interface declaring no members is equivalent to its supertype.";
  46     return Rule;
  47 }(Lint.Rules.AbstractRule));
  48 exports.Rule = Rule;
  49 function walk(ctx) {
  50     return ts.forEachChild(ctx.sourceFile, function cb(node) {
  51         if (tsutils_1.isInterfaceDeclaration(node) &&
  52             node.members.length === 0 &&
  53             (node.heritageClauses === undefined ||
  54                 extendsOneTypeWithoutTypeArguments(node.heritageClauses[0]))) {
  55             return ctx.addFailureAtNode(node.name, node.heritageClauses !== undefined
  56                 ? Rule.FAILURE_STRING_FOR_EXTENDS
  57                 : Rule.FAILURE_STRING);
  58         }
  59         return ts.forEachChild(node, cb);
  60     });
  61 }
  62 function extendsOneTypeWithoutTypeArguments(_a) {
  63     var types = _a.types;
  64     switch (types.length) {
  65         case 0:
  66             return true; // don't crash on empty extends list
  67         case 1:
  68             return types[0].typeArguments === undefined; // allow interfaces that provide type arguments for the extended type
  69         default:
  70             return false; // allow interfaces extending more than one types
  71     }
  72 }