noInvalidTemplateStringsRule.js 2.5 KB

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