diff options
Diffstat (limited to 'node_modules/tslint/lib/rules/noInvalidThisRule.js')
-rw-r--r-- | node_modules/tslint/lib/rules/noInvalidThisRule.js | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/node_modules/tslint/lib/rules/noInvalidThisRule.js b/node_modules/tslint/lib/rules/noInvalidThisRule.js new file mode 100644 index 000000000..b2fb22aa5 --- /dev/null +++ b/node_modules/tslint/lib/rules/noInvalidThisRule.js @@ -0,0 +1,97 @@ +"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 OPTION_FUNCTION_IN_METHOD = "check-function-in-method"; +var DEPRECATED_OPTION_FUNCTION_IN_METHOD = "no-this-in-function-in-method"; +var Rule = (function (_super) { + tslib_1.__extends(Rule, _super); + function Rule() { + return _super !== null && _super.apply(this, arguments) || this; + } + Rule.prototype.apply = function (sourceFile) { + var _this = this; + var hasOption = function (name) { return _this.ruleArguments.indexOf(name) !== -1; }; + var checkFuncInMethod = hasOption(DEPRECATED_OPTION_FUNCTION_IN_METHOD) || hasOption(OPTION_FUNCTION_IN_METHOD); + return this.applyWithFunction(sourceFile, walk, checkFuncInMethod); + }; + return Rule; +}(Lint.Rules.AbstractRule)); +/* tslint:disable:object-literal-sort-keys */ +Rule.metadata = { + ruleName: "no-invalid-this", + description: "Disallows using the `this` keyword outside of classes.", + rationale: "See [the rule's author's rationale here.](https://github.com/palantir/tslint/pull/1105#issue-147549402)", + optionsDescription: (_a = ["\n One argument may be optionally provided:\n\n * `", "` disallows using the `this` keyword in functions within class methods."], _a.raw = ["\n One argument may be optionally provided:\n\n * \\`", "\\` disallows using the \\`this\\` keyword in functions within class methods."], Lint.Utils.dedent(_a, OPTION_FUNCTION_IN_METHOD)), + options: { + type: "array", + items: { + type: "string", + enum: [OPTION_FUNCTION_IN_METHOD], + }, + minLength: 0, + maxLength: 1, + }, + optionExamples: [true, [true, OPTION_FUNCTION_IN_METHOD]], + type: "functionality", + typescriptOnly: false, +}; +/* tslint:enable:object-literal-sort-keys */ +Rule.FAILURE_STRING_OUTSIDE = "the \"this\" keyword is disallowed outside of a class body"; +Rule.FAILURE_STRING_INSIDE = "the \"this\" keyword is disallowed in function bodies inside class methods, " + + "use arrow functions instead"; +exports.Rule = Rule; +function walk(ctx) { + var sourceFile = ctx.sourceFile, checkFuncInMethod = ctx.options; + var inClass = false; + var inFunctionInClass = false; + ts.forEachChild(sourceFile, function cb(node) { + switch (node.kind) { + case ts.SyntaxKind.ClassDeclaration: + case ts.SyntaxKind.ClassExpression: + if (!inClass) { + inClass = true; + ts.forEachChild(node, cb); + inClass = false; + return; + } + break; + case ts.SyntaxKind.FunctionDeclaration: + case ts.SyntaxKind.FunctionExpression: + if (inClass) { + inFunctionInClass = true; + ts.forEachChild(node, cb); + inFunctionInClass = false; + return; + } + break; + case ts.SyntaxKind.ThisKeyword: + if (!inClass) { + ctx.addFailureAtNode(node, Rule.FAILURE_STRING_OUTSIDE); + } + else if (checkFuncInMethod && inFunctionInClass) { + ctx.addFailureAtNode(node, Rule.FAILURE_STRING_INSIDE); + } + return; + } + ts.forEachChild(node, cb); + }); +} +var _a; |