diff options
Diffstat (limited to 'node_modules/tslint/lib/rules/awaitPromiseRule.js')
-rw-r--r-- | node_modules/tslint/lib/rules/awaitPromiseRule.js | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/node_modules/tslint/lib/rules/awaitPromiseRule.js b/node_modules/tslint/lib/rules/awaitPromiseRule.js new file mode 100644 index 000000000..18c255e72 --- /dev/null +++ b/node_modules/tslint/lib/rules/awaitPromiseRule.js @@ -0,0 +1,81 @@ +"use strict"; +/** + * @license + * Copyright 2017 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) { + var promiseTypes = new Set(["Promise"].concat(this.ruleArguments)); + var tc = program.getTypeChecker(); + return this.applyWithFunction(sourceFile, function (ctx) { return walk(ctx, tc, promiseTypes); }); + }; + return Rule; +}(Lint.Rules.TypedRule)); +/* tslint:disable:object-literal-sort-keys */ +Rule.metadata = { + ruleName: "await-promise", + description: "Warns for an awaited value that is not a Promise.", + optionsDescription: (_a = ["\n A list of 'string' names of any additional classes that should also be handled as Promises.\n "], _a.raw = ["\n A list of 'string' names of any additional classes that should also be handled as Promises.\n "], Lint.Utils.dedent(_a)), + options: { + type: "list", + listType: { + type: "array", + items: { type: "string" }, + }, + }, + optionExamples: [true, [true, "Thenable"]], + type: "functionality", + typescriptOnly: true, + requiresTypeInfo: true, +}; +/* tslint:enable:object-literal-sort-keys */ +Rule.FAILURE_STRING = "'await' of non-Promise."; +exports.Rule = Rule; +function walk(ctx, tc, promiseTypes) { + return ts.forEachChild(ctx.sourceFile, cb); + function cb(node) { + if (tsutils_1.isAwaitExpression(node) && !couldBePromise(tc.getTypeAtLocation(node.expression))) { + ctx.addFailureAtNode(node, Rule.FAILURE_STRING); + } + return ts.forEachChild(node, cb); + } + function couldBePromise(type) { + if (Lint.isTypeFlagSet(type, ts.TypeFlags.Any) || isPromiseType(type)) { + return true; + } + if (isUnionType(type)) { + return type.types.some(couldBePromise); + } + var bases = type.getBaseTypes(); + return bases !== undefined && bases.some(couldBePromise); + } + function isPromiseType(type) { + var target = type.target; + return target !== undefined && target.symbol !== undefined && promiseTypes.has(target.symbol.name); + } +} +function isUnionType(type) { + return Lint.isTypeFlagSet(type, ts.TypeFlags.Union); +} +var _a; |