noStringThrowRule.js 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. "use strict";
  2. /**
  3. * @license
  4. * Copyright 2016 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-string-throw",
  34. description: "Flags throwing plain strings or concatenations of strings " +
  35. "because only Errors produce proper stack traces.",
  36. hasFix: true,
  37. options: null,
  38. optionsDescription: "Not configurable.",
  39. type: "functionality",
  40. typescriptOnly: false,
  41. };
  42. /* tslint:enable:object-literal-sort-keys */
  43. Rule.FAILURE_STRING = "Throwing plain strings (not instances of Error) gives no stack traces";
  44. return Rule;
  45. }(Lint.Rules.AbstractRule));
  46. exports.Rule = Rule;
  47. function walk(ctx) {
  48. var sourceFile = ctx.sourceFile;
  49. return ts.forEachChild(ctx.sourceFile, function cb(node) {
  50. if (tsutils_1.isThrowStatement(node)) {
  51. var expression = node.expression;
  52. if (isString(expression)) {
  53. ctx.addFailureAtNode(node, Rule.FAILURE_STRING, [
  54. Lint.Replacement.appendText(expression.getStart(sourceFile), "new Error("),
  55. Lint.Replacement.appendText(expression.getEnd(), ")"),
  56. ]);
  57. }
  58. }
  59. return ts.forEachChild(node, cb);
  60. });
  61. }
  62. function isString(node) {
  63. switch (node.kind) {
  64. case ts.SyntaxKind.StringLiteral:
  65. case ts.SyntaxKind.NoSubstitutionTemplateLiteral:
  66. case ts.SyntaxKind.TemplateExpression:
  67. return true;
  68. case ts.SyntaxKind.BinaryExpression: {
  69. var _a = node, operatorToken = _a.operatorToken, left = _a.left, right = _a.right;
  70. return operatorToken.kind === ts.SyntaxKind.PlusToken && (isString(left) || isString(right));
  71. }
  72. case ts.SyntaxKind.ParenthesizedExpression:
  73. return isString(node.expression);
  74. default:
  75. return false;
  76. }
  77. }