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

   1 "use strict";
   2 /**
   3  * @license
   4  * Copyright 2013 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.id = function (input) {
  29         return input;
  30     };
  31     Rule.prototype.apply = function (sourceFile) {
  32         return this.applyWithFunction(sourceFile, walk);
  33     };
  34     /* tslint:disable:object-literal-sort-keys */
  35     Rule.metadata = {
  36         ruleName: "no-string-literal",
  37         description: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n            Forbids unnecessary string literal property access.\n            Allows `obj[\"prop-erty\"]` (can't be a regular property access).\n            Disallows `obj[\"property\"]` (should be `obj.property`)."], ["\n            Forbids unnecessary string literal property access.\n            Allows \\`obj[\"prop-erty\"]\\` (can't be a regular property access).\n            Disallows \\`obj[\"property\"]\\` (should be \\`obj.property\\`)."]))),
  38         rationale: Lint.Utils.dedent(templateObject_2 || (templateObject_2 = tslib_1.__makeTemplateObject(["\n            If `--noImplicitAny` is turned off,\n            property access via a string literal will be 'any' if the property does not exist."], ["\n            If \\`--noImplicitAny\\` is turned off,\n            property access via a string literal will be 'any' if the property does not exist."]))),
  39         optionsDescription: "Not configurable.",
  40         options: null,
  41         optionExamples: [true],
  42         type: "functionality",
  43         typescriptOnly: false,
  44         hasFix: true,
  45     };
  46     /* tslint:enable:object-literal-sort-keys */
  47     Rule.FAILURE_STRING = "object access via string literals is disallowed";
  48     return Rule;
  49 }(Lint.Rules.AbstractRule));
  50 exports.Rule = Rule;
  51 function walk(ctx) {
  52     return ts.forEachChild(ctx.sourceFile, function cb(node) {
  53         if (tsutils_1.isElementAccessExpression(node)) {
  54             var argument = node.argumentExpression;
  55             if (argument !== undefined &&
  56                 tsutils_1.isStringLiteral(argument) &&
  57                 tsutils_1.isValidPropertyAccess(argument.text)) {
  58                 var unescapeIdentifier =
  59                 // typescript@<2.5.0 has an extra underscore in escaped identifier text content,
  60                 // to avoid fixing issue `expr['__foo'] → expr.___foo`, unescapeIdentifier() is to be used
  61                 // As of typescript@3, unescapeIdentifier() removed, thus check in runtime, if the method exists
  62                 // tslint:disable-next-line no-unsafe-any strict-boolean-expressions
  63                 ts.unescapeIdentifier || Rule.id;
  64                 var propertyName = unescapeIdentifier(argument.text);
  65                 ctx.addFailureAtNode(argument, Rule.FAILURE_STRING,
  66                 // expr['foo'] -> expr.foo
  67                 Lint.Replacement.replaceFromTo(node.expression.end, node.end, "." + propertyName));
  68             }
  69         }
  70         return ts.forEachChild(node, cb);
  71     });
  72 }
  73 var templateObject_1, templateObject_2;