noVarKeywordRule.js 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. "use strict";
  2. /**
  3. * @license
  4. * Copyright 2015 Palantir Technologies, Inc.
  5. *
  6. * Licensed under the Apache License, Version 2.0 (the "License");
  7. * you may not use this file except in compliance with the License.
  8. * You may obtain a copy of the License at
  9. *
  10. * http://www.apache.org/licenses/LICENSE-2.0
  11. *
  12. * Unless required by applicable law or agreed to in writing, software
  13. * distributed under the License is distributed on an "AS IS" BASIS,
  14. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. * See the License for the specific language governing permissions and
  16. * limitations under the License.
  17. */
  18. Object.defineProperty(exports, "__esModule", { value: true });
  19. var tslib_1 = require("tslib");
  20. var tsutils_1 = require("tsutils");
  21. var ts = require("typescript");
  22. var Lint = require("../index");
  23. var Rule = /** @class */ (function (_super) {
  24. tslib_1.__extends(Rule, _super);
  25. function Rule() {
  26. return _super !== null && _super.apply(this, arguments) || this;
  27. }
  28. Rule.prototype.apply = function (sourceFile) {
  29. return this.applyWithFunction(sourceFile, walk);
  30. };
  31. /* tslint:disable:object-literal-sort-keys */
  32. Rule.metadata = {
  33. ruleName: "no-var-keyword",
  34. description: "Disallows usage of the `var` keyword.",
  35. descriptionDetails: "Use `let` or `const` instead.",
  36. hasFix: true,
  37. optionsDescription: "Not configurable.",
  38. options: null,
  39. optionExamples: [true],
  40. type: "functionality",
  41. typescriptOnly: false,
  42. };
  43. /* tslint:enable:object-literal-sort-keys */
  44. Rule.FAILURE_STRING = "Forbidden 'var' keyword, use 'let' or 'const' instead";
  45. return Rule;
  46. }(Lint.Rules.AbstractRule));
  47. exports.Rule = Rule;
  48. function walk(ctx) {
  49. var sourceFile = ctx.sourceFile;
  50. return ts.forEachChild(sourceFile, function cb(node) {
  51. var parent = node.parent;
  52. if (tsutils_1.isVariableDeclarationList(node)
  53. && !tsutils_1.isBlockScopedVariableDeclarationList(node)
  54. // If !isVariableStatement, this is inside of a for loop.
  55. && (!tsutils_1.isVariableStatement(parent) || !isGlobalVarDeclaration(parent))) {
  56. var start = node.getStart(sourceFile);
  57. var width = "var".length;
  58. // Don't apply fix in a declaration file, because may have meant 'const'.
  59. var fix = sourceFile.isDeclarationFile ? undefined : new Lint.Replacement(start, width, "let");
  60. ctx.addFailureAt(start, width, Rule.FAILURE_STRING, fix);
  61. }
  62. return ts.forEachChild(node, cb);
  63. });
  64. }
  65. // Allow `declare var x: number;` or `declare global { var x: number; }`
  66. function isGlobalVarDeclaration(node) {
  67. var parent = node.parent;
  68. return tsutils_1.hasModifier(node.modifiers, ts.SyntaxKind.DeclareKeyword)
  69. || parent.kind === ts.SyntaxKind.ModuleBlock && tsutils_1.isNodeFlagSet(parent.parent, ts.NodeFlags.GlobalAugmentation);
  70. }