.config/coc/extensions/node_modules/coc-prettier/node_modules/tslint/lib/rules/noStringThrowRule.js

   1 "use strict";
   2 /**
   3  * @license
   4  * Copyright 2018 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 noStringThrowRule_examples_1 = require("./code-examples/noStringThrowRule.examples");
  24 var Rule = /** @class */ (function (_super) {
  25     tslib_1.__extends(Rule, _super);
  26     function Rule() {
  27         return _super !== null && _super.apply(this, arguments) || this;
  28     }
  29     Rule.prototype.apply = function (sourceFile) {
  30         return this.applyWithFunction(sourceFile, walk);
  31     };
  32     /* tslint:disable:object-literal-sort-keys */
  33     Rule.metadata = {
  34         ruleName: "no-string-throw",
  35         description: "Flags throwing plain strings or concatenations of strings.",
  36         hasFix: true,
  37         options: null,
  38         optionExamples: [true],
  39         optionsDescription: "Not configurable.",
  40         rationale: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n            Example \u2013 Doing it right\n\n            ```ts\n            // throwing an Error from typical function, whether sync or async\n            if (!productToAdd) {\n                throw new Error(\"How can I add new product when no value provided?\");\n            }\n            ```\n\n            Example \u2013 Anti Pattern\n\n            ```ts\n            // throwing a string lacks any stack trace information and other important data properties\n            if (!productToAdd) {\n                throw (\"How can I add new product when no value provided?\");\n            }\n            ```\n\n            Only Error objects contain a `.stack` member equivalent to the current stack trace.\n            Primitives such as strings do not.\n        "], ["\n            Example \u2013 Doing it right\n\n            \\`\\`\\`ts\n            // throwing an Error from typical function, whether sync or async\n            if (!productToAdd) {\n                throw new Error(\"How can I add new product when no value provided?\");\n            }\n            \\`\\`\\`\n\n            Example \u2013 Anti Pattern\n\n            \\`\\`\\`ts\n            // throwing a string lacks any stack trace information and other important data properties\n            if (!productToAdd) {\n                throw (\"How can I add new product when no value provided?\");\n            }\n            \\`\\`\\`\n\n            Only Error objects contain a \\`.stack\\` member equivalent to the current stack trace.\n            Primitives such as strings do not.\n        "]))),
  41         codeExamples: noStringThrowRule_examples_1.codeExamples,
  42         type: "functionality",
  43         typescriptOnly: false,
  44     };
  45     /* tslint:enable:object-literal-sort-keys */
  46     Rule.FAILURE_STRING = "Throwing plain strings (not instances of Error) gives no stack traces";
  47     return Rule;
  48 }(Lint.Rules.AbstractRule));
  49 exports.Rule = Rule;
  50 function walk(ctx) {
  51     var sourceFile = ctx.sourceFile;
  52     return ts.forEachChild(ctx.sourceFile, function cb(node) {
  53         if (tsutils_1.isThrowStatement(node)) {
  54             var expression = node.expression;
  55             if (expression !== undefined && isString(expression)) {
  56                 // To prevent this fix from creating invalid syntax, we must ensure that the "throw"
  57                 // token is succeeded by a space if no other characters precede the string literal.
  58                 var offset = expression.getStart() - node.getStart();
  59                 var numCharactersBetweenTokens = offset - "throw".length;
  60                 var newError = numCharactersBetweenTokens === 0 ? " new Error(" : "new Error(";
  61                 ctx.addFailureAtNode(node, Rule.FAILURE_STRING, [
  62                     Lint.Replacement.appendText(expression.getStart(sourceFile), newError),
  63                     Lint.Replacement.appendText(expression.getEnd(), ")"),
  64                 ]);
  65             }
  66         }
  67         return ts.forEachChild(node, cb);
  68     });
  69 }
  70 function isString(node) {
  71     switch (node.kind) {
  72         case ts.SyntaxKind.StringLiteral:
  73         case ts.SyntaxKind.NoSubstitutionTemplateLiteral:
  74         case ts.SyntaxKind.TemplateExpression:
  75             return true;
  76         case ts.SyntaxKind.BinaryExpression: {
  77             var _a = node, operatorToken = _a.operatorToken, left = _a.left, right = _a.right;
  78             return (operatorToken.kind === ts.SyntaxKind.PlusToken &&
  79                 (isString(left) || isString(right)));
  80         }
  81         case ts.SyntaxKind.ParenthesizedExpression:
  82             return isString(node.expression);
  83         default:
  84             return false;
  85     }
  86 }
  87 var templateObject_1;