4 * Copyright 2017 Palantir Technologies, Inc.
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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
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);
26 return _super !== null && _super.apply(this, arguments) || this;
28 Rule.METH_SIGN_STRING = function (ps) {
29 var type = ps.type, questionToken = ps.questionToken;
30 var result = ps.name.getText();
31 if (questionToken !== undefined) {
34 if (type !== undefined && tsutils_1.isFunctionTypeNode(type) && type.type !== undefined) {
35 if (type.typeParameters !== undefined) {
36 var tps = type.typeParameters.map(function (tp) { return tp.getText(); }).join(", ");
37 result += "<" + tps + ">";
39 var args = type.parameters.map(function (v) { return v.getText(); }).join(", ");
40 result += "(" + args + "): " + type.type.getText() + ";";
44 Rule.prototype.apply = function (sourceFile) {
45 return this.applyWithFunction(sourceFile, walk);
47 /* tslint:disable:object-literal-sort-keys */
49 ruleName: "prefer-method-signature",
50 description: "Prefer `foo(): void` over `foo: () => void` in interfaces and types.",
52 optionsDescription: "Not configurable.",
54 optionExamples: [true],
56 typescriptOnly: false,
58 /* tslint:enable:object-literal-sort-keys */
59 Rule.FAILURE_STRING = "Use a method signature instead of a property signature of function type.";
61 }(Lint.Rules.AbstractRule));
64 return ts.forEachChild(ctx.sourceFile, function cb(node) {
65 if (tsutils_1.isPropertySignature(node)) {
67 if (type !== undefined && tsutils_1.isFunctionTypeNode(type)) {
68 ctx.addFailureAtNode(node.name, Rule.FAILURE_STRING, type.type === undefined
70 : [Lint.Replacement.replaceNode(node, Rule.METH_SIGN_STRING(node))]);
73 return ts.forEachChild(node, cb);