aboutsummaryrefslogtreecommitdiff
path: root/node_modules/tslint/lib/rules/noFloatingPromisesRule.js
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/tslint/lib/rules/noFloatingPromisesRule.js')
-rw-r--r--node_modules/tslint/lib/rules/noFloatingPromisesRule.js66
1 files changed, 66 insertions, 0 deletions
diff --git a/node_modules/tslint/lib/rules/noFloatingPromisesRule.js b/node_modules/tslint/lib/rules/noFloatingPromisesRule.js
new file mode 100644
index 000000000..60839c9dc
--- /dev/null
+++ b/node_modules/tslint/lib/rules/noFloatingPromisesRule.js
@@ -0,0 +1,66 @@
+"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()); }, ["Promise"].concat(this.ruleArguments));
+ };
+ return Rule;
+}(Lint.Rules.TypedRule));
+/* tslint:disable:object-literal-sort-keys */
+Rule.metadata = {
+ ruleName: "no-floating-promises",
+ description: "Promises returned by functions must be handled appropriately.",
+ descriptionDetails: "Use `no-unused-expressions` in addition to this rule to reveal even more floating promises.",
+ 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, "JQueryPromise"]],
+ rationale: "Unhandled Promises can cause unexpected behavior, such as resolving at unexpected times.",
+ type: "functionality",
+ typescriptOnly: true,
+ requiresTypeInfo: true,
+};
+/* tslint:enable:object-literal-sort-keys */
+Rule.FAILURE_STRING = "Promises must be handled appropriately";
+exports.Rule = Rule;
+function walk(ctx, tc) {
+ return ts.forEachChild(ctx.sourceFile, function cb(node) {
+ if (tsutils_1.isExpressionStatement(node) && node.expression.kind === ts.SyntaxKind.CallExpression) {
+ var symbol = tc.getTypeAtLocation(node.expression).symbol;
+ if (symbol !== undefined && ctx.options.indexOf(symbol.name) !== -1) {
+ ctx.addFailureAtNode(node.expression, Rule.FAILURE_STRING);
+ }
+ }
+ return ts.forEachChild(node, cb);
+ });
+}
+var _a;