"use strict"; /** * @license * Copyright 2014 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 }); exports.Rule = void 0; var tslib_1 = require("tslib"); var ts = require("typescript"); var Lint = require("../index"); var Rule = /** @class */ (function (_super) { tslib_1.__extends(Rule, _super); function Rule() { return _super !== null && _super.apply(this, arguments) || this; } Rule.prototype.apply = function (sourceFile) { var requiresWalker = new NoVarRequiresWalker(sourceFile, this.getOptions()); return this.applyWithWalker(requiresWalker); }; /* tslint:disable:object-literal-sort-keys */ Rule.metadata = { ruleName: "no-var-requires", description: "Disallows the use of require statements except in import statements.", descriptionDetails: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n In other words, the use of forms such as `var module = require(\"module\")` are banned.\n Instead use ES2015-style imports or `import foo = require('foo')` imports."], ["\n In other words, the use of forms such as \\`var module = require(\"module\")\\` are banned.\n Instead use ES2015-style imports or \\`import foo = require('foo')\\` imports."]))), optionsDescription: "Not configurable.", options: null, optionExamples: [true], rationale: Lint.Utils.dedent(templateObject_2 || (templateObject_2 = tslib_1.__makeTemplateObject(["\n AMD-style `require([])` and CommonJS-style `require(\"\")` statements are environment-specific\n and more difficult to statically analyze.\n\n ES2015-style `import`s are part of the JavaScript language specfication and recommended as the path going forward.\n TypeScript will compile them to environment-specific forms as needed.\n "], ["\n AMD-style \\`require([])\\` and CommonJS-style \\`require(\"\")\\` statements are environment-specific\n and more difficult to statically analyze.\n\n ES2015-style \\`import\\`s are part of the JavaScript language specfication and recommended as the path going forward.\n TypeScript will compile them to environment-specific forms as needed.\n "]))), type: "typescript", typescriptOnly: true, }; /* tslint:enable:object-literal-sort-keys */ Rule.FAILURE_STRING = "require statement not part of an import statement"; return Rule; }(Lint.Rules.AbstractRule)); exports.Rule = Rule; // tslint:disable-next-line:deprecation var NoVarRequiresWalker = /** @class */ (function (_super) { tslib_1.__extends(NoVarRequiresWalker, _super); function NoVarRequiresWalker() { return _super !== null && _super.apply(this, arguments) || this; } NoVarRequiresWalker.prototype.createScope = function () { return {}; }; NoVarRequiresWalker.prototype.visitCallExpression = function (node) { var expression = node.expression; if (this.getCurrentDepth() <= 1 && expression.kind === ts.SyntaxKind.Identifier) { var identifierName = expression.text; if (identifierName === "require") { // if we're calling (invoking) require, then it's not part of an import statement this.addFailureAtNode(node, Rule.FAILURE_STRING); } } _super.prototype.visitCallExpression.call(this, node); }; return NoVarRequiresWalker; }(Lint.ScopeAwareRuleWalker)); var templateObject_1, templateObject_2;