noInvalidTemplateStringsRule.js 2.6KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  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 utils = 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-invalid-template-strings",
  34. description: "Warns on use of `\${` in non-template strings.",
  35. optionsDescription: "Not configurable.",
  36. options: null,
  37. optionExamples: [true],
  38. rationale: "Interpolation will only work for template strings.",
  39. type: "functionality",
  40. typescriptOnly: false,
  41. };
  42. /* tslint:enable:object-literal-sort-keys */
  43. Rule.FAILURE_STRING = "Interpolation will only work for template strings.";
  44. return Rule;
  45. }(Lint.Rules.AbstractRule));
  46. exports.Rule = Rule;
  47. function walk(ctx) {
  48. return ts.forEachChild(ctx.sourceFile, function cb(node) {
  49. if (utils.isStringLiteral(node)) {
  50. check(node);
  51. }
  52. return ts.forEachChild(node, cb);
  53. });
  54. function check(node) {
  55. var text = node.getText(ctx.sourceFile);
  56. var findTemplateStrings = /\\*\$\{/g;
  57. var instance = findTemplateStrings.exec(text);
  58. while (instance !== null) {
  59. var matchLength = instance[0].length;
  60. var backslashCount = matchLength - 2;
  61. var instanceIsEscaped = backslashCount % 2 === 1;
  62. if (!instanceIsEscaped) {
  63. var start = node.getStart() + (instance.index + backslashCount);
  64. ctx.addFailureAt(start, 2, Rule.FAILURE_STRING);
  65. }
  66. instance = findTemplateStrings.exec(text);
  67. }
  68. }
  69. }