diff options
Diffstat (limited to 'node_modules/tslint/lib/rules/promiseFunctionAsyncRule.js')
-rw-r--r-- | node_modules/tslint/lib/rules/promiseFunctionAsyncRule.js | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/node_modules/tslint/lib/rules/promiseFunctionAsyncRule.js b/node_modules/tslint/lib/rules/promiseFunctionAsyncRule.js new file mode 100644 index 000000000..c035b6095 --- /dev/null +++ b/node_modules/tslint/lib/rules/promiseFunctionAsyncRule.js @@ -0,0 +1,70 @@ +"use strict"; +/** + * @license + * Copyright 2016 Palantir Technologies, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +Object.defineProperty(exports, "__esModule", { value: true }); +var tslib_1 = require("tslib"); +var tsutils_1 = require("tsutils"); +var ts = require("typescript"); +var Lint = require("../index"); +var Rule = (function (_super) { + tslib_1.__extends(Rule, _super); + function Rule() { + return _super !== null && _super.apply(this, arguments) || this; + } + Rule.prototype.applyWithProgram = function (sourceFile, program) { + return this.applyWithFunction(sourceFile, function (ctx) { return walk(ctx, program.getTypeChecker()); }); + }; + return Rule; +}(Lint.Rules.TypedRule)); +/* tslint:disable:object-literal-sort-keys */ +Rule.metadata = { + ruleName: "promise-function-async", + description: "Requires any function or method that returns a promise to be marked async.", + rationale: (_a = ["\n Ensures that each function is only capable of 1) returning a rejected promise, or 2)\n throwing an Error object. In contrast, non-`async` `Promise`-returning functions\n are technically capable of either. This practice removes a requirement for consuming\n code to handle both cases.\n "], _a.raw = ["\n Ensures that each function is only capable of 1) returning a rejected promise, or 2)\n throwing an Error object. In contrast, non-\\`async\\` \\`Promise\\`-returning functions\n are technically capable of either. This practice removes a requirement for consuming\n code to handle both cases.\n "], Lint.Utils.dedent(_a)), + optionsDescription: "Not configurable.", + options: null, + optionExamples: [true], + type: "typescript", + typescriptOnly: false, + requiresTypeInfo: true, +}; +/* tslint:enable:object-literal-sort-keys */ +Rule.FAILURE_STRING = "functions that return promises must be async"; +exports.Rule = Rule; +function walk(ctx, tc) { + return ts.forEachChild(ctx.sourceFile, function cb(node) { + switch (node.kind) { + case ts.SyntaxKind.MethodDeclaration: + case ts.SyntaxKind.FunctionDeclaration: + if (node.body === undefined) { + break; + } + // falls through + case ts.SyntaxKind.FunctionExpression: + case ts.SyntaxKind.ArrowFunction: + if (!tsutils_1.hasModifier(node.modifiers, ts.SyntaxKind.AsyncKeyword) && returnsPromise(node, tc)) { + ctx.addFailure(node.getStart(ctx.sourceFile), node.body.pos, Rule.FAILURE_STRING); + } + } + return ts.forEachChild(node, cb); + }); +} +function returnsPromise(node, tc) { + var type = tc.getReturnTypeOfSignature(tc.getTypeAtLocation(node).getCallSignatures()[0]); + return type.symbol !== undefined && type.symbol.name === "Promise"; +} +var _a; |