aboutsummaryrefslogtreecommitdiff
path: root/node_modules/tslint/lib/rules/noVoidExpressionRule.js
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/tslint/lib/rules/noVoidExpressionRule.js')
-rw-r--r--node_modules/tslint/lib/rules/noVoidExpressionRule.js87
1 files changed, 87 insertions, 0 deletions
diff --git a/node_modules/tslint/lib/rules/noVoidExpressionRule.js b/node_modules/tslint/lib/rules/noVoidExpressionRule.js
new file mode 100644
index 000000000..e80ec2cf6
--- /dev/null
+++ b/node_modules/tslint/lib/rules/noVoidExpressionRule.js
@@ -0,0 +1,87 @@
+"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 ts = require("typescript");
+var Lint = require("../index");
+var utils_1 = require("../language/utils");
+var OPTION_IGNORE_ARROW_FUNCTION_SHORTHAND = "ignore-arrow-function-shorthand";
+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 ignoreArrowFunctionShorthand = this.ruleArguments.indexOf(OPTION_IGNORE_ARROW_FUNCTION_SHORTHAND) !== -1;
+ return this.applyWithFunction(sourceFile, function (ctx) { return walk(ctx, program.getTypeChecker()); }, { ignoreArrowFunctionShorthand: ignoreArrowFunctionShorthand });
+ };
+ return Rule;
+}(Lint.Rules.TypedRule));
+/* tslint:disable:object-literal-sort-keys */
+Rule.metadata = {
+ ruleName: "no-void-expression",
+ description: "Requires expressions of type `void` to appear in statement position.",
+ optionsDescription: (_a = ["\n If `", "` is provided, `() => returnsVoid()` will be allowed.\n Otherwise, it must be written as `() => { returnsVoid(); }`."], _a.raw = ["\n If \\`", "\\` is provided, \\`() => returnsVoid()\\` will be allowed.\n Otherwise, it must be written as \\`() => { returnsVoid(); }\\`."], Lint.Utils.dedent(_a, OPTION_IGNORE_ARROW_FUNCTION_SHORTHAND)),
+ options: {
+ type: "array",
+ items: {
+ type: "string",
+ enum: [OPTION_IGNORE_ARROW_FUNCTION_SHORTHAND],
+ },
+ minLength: 0,
+ maxLength: 1,
+ },
+ requiresTypeInfo: true,
+ type: "functionality",
+ typescriptOnly: false,
+};
+/* tslint:enable:object-literal-sort-keys */
+Rule.FAILURE_STRING = "Expression has type `void`. Put it on its own line as a statement.";
+exports.Rule = Rule;
+function walk(ctx, checker) {
+ var sourceFile = ctx.sourceFile, ignoreArrowFunctionShorthand = ctx.options.ignoreArrowFunctionShorthand;
+ return ts.forEachChild(sourceFile, function cb(node) {
+ if (isPossiblyVoidExpression(node)
+ && !isParentAllowedVoid(node)
+ && utils_1.isTypeFlagSet(checker.getTypeAtLocation(node), ts.TypeFlags.Void)) {
+ ctx.addFailureAtNode(node, Rule.FAILURE_STRING);
+ }
+ return ts.forEachChild(node, cb);
+ });
+ function isParentAllowedVoid(node) {
+ switch (node.parent.kind) {
+ case ts.SyntaxKind.ExpressionStatement:
+ return true;
+ case ts.SyntaxKind.ArrowFunction:
+ return ignoreArrowFunctionShorthand;
+ default:
+ return false;
+ }
+ }
+}
+function isPossiblyVoidExpression(node) {
+ switch (node.kind) {
+ case ts.SyntaxKind.AwaitExpression:
+ case ts.SyntaxKind.CallExpression:
+ case ts.SyntaxKind.TaggedTemplateExpression:
+ return true;
+ default:
+ return false;
+ }
+}
+var _a;