noParameterReassignmentRule.js 2.4KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. "use strict";
  2. /**
  3. * @license
  4. * Copyright 2017 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. /* tslint:enable:object-literal-sort-keys */
  29. Rule.FAILURE_STRING = function (name) {
  30. return "Reassigning parameter '" + name + "' is forbidden.";
  31. };
  32. Rule.prototype.apply = function (sourceFile) {
  33. return this.applyWithFunction(sourceFile, walk);
  34. };
  35. /* tslint:disable:object-literal-sort-keys */
  36. Rule.metadata = {
  37. ruleName: "no-parameter-reassignment",
  38. description: "Disallows reassigning parameters.",
  39. optionsDescription: "Not configurable.",
  40. options: null,
  41. optionExamples: [true],
  42. type: "typescript",
  43. typescriptOnly: false,
  44. };
  45. return Rule;
  46. }(Lint.Rules.AbstractRule));
  47. exports.Rule = Rule;
  48. function walk(ctx) {
  49. tsutils_1.collectVariableUsage(ctx.sourceFile).forEach(function (variable, identifier) {
  50. if (!isParameter(identifier.parent)) {
  51. return;
  52. }
  53. for (var _i = 0, _a = variable.uses; _i < _a.length; _i++) {
  54. var use = _a[_i];
  55. if (tsutils_1.isReassignmentTarget(use.location)) {
  56. ctx.addFailureAtNode(use.location, Rule.FAILURE_STRING(identifier.text));
  57. }
  58. }
  59. });
  60. }
  61. function isParameter(node) {
  62. switch (node.kind) {
  63. case ts.SyntaxKind.Parameter:
  64. return true;
  65. case ts.SyntaxKind.BindingElement:
  66. return tsutils_1.getDeclarationOfBindingElement(node).kind === ts.SyntaxKind.Parameter;
  67. default:
  68. return false;
  69. }
  70. }