.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / tslint / lib / rules / noMisusedNewRule.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     Rule.prototype.apply = function (sourceFile) {
29         return this.applyWithFunction(sourceFile, walk);
30     };
31     /* tslint:disable:object-literal-sort-keys */
32     Rule.metadata = {
33         ruleName: "no-misused-new",
34         description: "Warns on apparent attempts to define constructors for interfaces or `new` for classes.",
35         optionsDescription: "Not configurable.",
36         options: null,
37         optionExamples: [true],
38         rationale: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n            Interfaces in TypeScript aren't meant to describe constructors on their implementations.\n            The `new` descriptor is primarily for describing JavaScript libraries.\n            If you're trying to describe a function known to be a class, it's typically better to `declare class`.\n        "], ["\n            Interfaces in TypeScript aren't meant to describe constructors on their implementations.\n            The \\`new\\` descriptor is primarily for describing JavaScript libraries.\n            If you're trying to describe a function known to be a class, it's typically better to \\`declare class\\`.\n        "]))),
39         type: "functionality",
40         typescriptOnly: true,
41     };
42     /* tslint:enable:object-literal-sort-keys */
43     Rule.FAILURE_STRING_INTERFACE = "Interfaces cannot be constructed, only classes. Did you mean `declare class`?";
44     Rule.FAILURE_STRING_CLASS = '`new` in a class is a method named "new". Did you mean `constructor`?';
45     return Rule;
46 }(Lint.Rules.AbstractRule));
47 exports.Rule = Rule;
48 function walk(ctx) {
49     return ts.forEachChild(ctx.sourceFile, function cb(node) {
50         if (tsutils_1.isMethodSignature(node)) {
51             if (tsutils_1.getPropertyName(node.name) === "constructor") {
52                 ctx.addFailureAtNode(node, Rule.FAILURE_STRING_INTERFACE);
53             }
54         }
55         else if (tsutils_1.isMethodDeclaration(node)) {
56             if (node.body === undefined &&
57                 tsutils_1.getPropertyName(node.name) === "new" &&
58                 returnTypeMatchesParent(node.parent, node)) {
59                 ctx.addFailureAtNode(node, Rule.FAILURE_STRING_CLASS);
60             }
61         }
62         else if (tsutils_1.isConstructSignatureDeclaration(node)) {
63             if (returnTypeMatchesParent(node.parent, node)) {
64                 ctx.addFailureAtNode(node, Rule.FAILURE_STRING_INTERFACE);
65             }
66         }
67         return ts.forEachChild(node, cb);
68     });
69 }
70 function returnTypeMatchesParent(parent, decl) {
71     if (parent.name === undefined || decl.type === undefined || !tsutils_1.isTypeReferenceNode(decl.type)) {
72         return false;
73     }
74     return (decl.type.typeName.kind === ts.SyntaxKind.Identifier &&
75         decl.type.typeName.text === parent.name.text);
76 }
77 var templateObject_1;