You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
mohemmionic5/Mohem/node_modules_/tslint/lib/rules/quotemarkRule.js

174 lines
9.2 KiB
JavaScript

"use strict";
/**
* @license
* Copyright 2013 Palantir Technologies, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Object.defineProperty(exports, "__esModule", { value: true });
var tslib_1 = require("tslib");
var tsutils_1 = require("tsutils");
var ts = require("typescript");
var Lint = require("../index");
var OPTION_SINGLE = "single";
var OPTION_DOUBLE = "double";
var OPTION_BACKTICK = "backtick";
var OPTION_JSX_SINGLE = "jsx-single";
var OPTION_JSX_DOUBLE = "jsx-double";
var OPTION_AVOID_TEMPLATE = "avoid-template";
var OPTION_AVOID_ESCAPE = "avoid-escape";
var Rule = /** @class */ (function (_super) {
tslib_1.__extends(Rule, _super);
function Rule() {
return _super !== null && _super.apply(this, arguments) || this;
}
/* tslint:enable:object-literal-sort-keys */
Rule.FAILURE_STRING = function (actual, expected) {
return actual + " should be " + expected;
};
Rule.prototype.apply = function (sourceFile) {
var args = this.ruleArguments;
var quotemark = getQuotemarkPreference(args);
var jsxQuotemark = getJSXQuotemarkPreference(args, quotemark);
return this.applyWithFunction(sourceFile, walk, {
avoidEscape: hasArg(OPTION_AVOID_ESCAPE),
avoidTemplate: hasArg(OPTION_AVOID_TEMPLATE),
jsxQuotemark: jsxQuotemark,
quotemark: quotemark,
});
function hasArg(name) {
return args.indexOf(name) !== -1;
}
};
/* tslint:disable:object-literal-sort-keys */
Rule.metadata = {
ruleName: "quotemark",
description: "Enforces quote character for string literals.",
hasFix: true,
optionsDescription: Lint.Utils.dedent(templateObject_1 || (templateObject_1 = tslib_1.__makeTemplateObject(["\n Five arguments may be optionally provided:\n\n * `\"", "\"` enforces single quotes.\n * `\"", "\"` enforces double quotes.\n * `\"", "\"` enforces backticks.\n * `\"", "\"` enforces single quotes for JSX attributes.\n * `\"", "\"` enforces double quotes for JSX attributes.\n * `\"", "\"` forbids single-line untagged template strings that do not contain string interpolations.\n Note that backticks may still be used if `\"", "\"` is enabled and both single and double quotes are\n present in the string (the latter option takes precedence).\n * `\"", "\"` allows you to use the \"other\" quotemark in cases where escaping would normally be required.\n For example, `[true, \"", "\", \"", "\"]` would not report a failure on the string literal\n `'Hello \"World\"'`."], ["\n Five arguments may be optionally provided:\n\n * \\`\"", "\"\\` enforces single quotes.\n * \\`\"", "\"\\` enforces double quotes.\n * \\`\"", "\"\\` enforces backticks.\n * \\`\"", "\"\\` enforces single quotes for JSX attributes.\n * \\`\"", "\"\\` enforces double quotes for JSX attributes.\n * \\`\"", "\"\\` forbids single-line untagged template strings that do not contain string interpolations.\n Note that backticks may still be used if \\`\"", "\"\\` is enabled and both single and double quotes are\n present in the string (the latter option takes precedence).\n * \\`\"", "\"\\` allows you to use the \"other\" quotemark in cases where escaping would normally be required.\n For example, \\`[true, \"", "\", \"", "\"]\\` would not report a failure on the string literal\n \\`'Hello \"World\"'\\`."])), OPTION_SINGLE, OPTION_DOUBLE, OPTION_BACKTICK, OPTION_JSX_SINGLE, OPTION_JSX_DOUBLE, OPTION_AVOID_TEMPLATE, OPTION_AVOID_ESCAPE, OPTION_AVOID_ESCAPE, OPTION_DOUBLE, OPTION_AVOID_ESCAPE),
options: {
type: "array",
items: {
type: "string",
enum: [
OPTION_SINGLE,
OPTION_DOUBLE,
OPTION_BACKTICK,
OPTION_JSX_SINGLE,
OPTION_JSX_DOUBLE,
OPTION_AVOID_ESCAPE,
OPTION_AVOID_TEMPLATE,
],
},
minLength: 0,
maxLength: 5,
},
optionExamples: [
[true, OPTION_SINGLE, OPTION_AVOID_ESCAPE, OPTION_AVOID_TEMPLATE],
[true, OPTION_SINGLE, OPTION_JSX_DOUBLE],
],
type: "style",
typescriptOnly: false,
};
return Rule;
}(Lint.Rules.AbstractRule));
exports.Rule = Rule;
function walk(ctx) {
var sourceFile = ctx.sourceFile, options = ctx.options;
ts.forEachChild(sourceFile, function cb(node) {
if (tsutils_1.isStringLiteral(node) ||
(options.avoidTemplate &&
tsutils_1.isNoSubstitutionTemplateLiteral(node) &&
node.parent.kind !== ts.SyntaxKind.TaggedTemplateExpression &&
tsutils_1.isSameLine(sourceFile, node.getStart(sourceFile), node.end))) {
var expectedQuotemark = node.parent.kind === ts.SyntaxKind.JsxAttribute
? options.jsxQuotemark
: options.quotemark;
var actualQuotemark = sourceFile.text[node.end - 1];
if (actualQuotemark === expectedQuotemark) {
return;
}
var fixQuotemark = expectedQuotemark;
var needsQuoteEscapes = node.text.includes(expectedQuotemark);
// This string requires escapes to use the expected quote mark, but `avoid-escape` was passed
if (needsQuoteEscapes && options.avoidEscape) {
if (node.kind === ts.SyntaxKind.StringLiteral) {
return;
}
// If we are expecting double quotes, use single quotes to avoid escaping.
// Otherwise, just use double quotes.
var alternativeFixQuotemark = expectedQuotemark === '"' ? "'" : '"';
if (node.text.includes(alternativeFixQuotemark)) {
// It also includes the alternative fix quote mark. Let's try to use single quotes instead,
// unless we originally expected single quotes, in which case we will try to use backticks.
// This means that we may use backtick even with avoid-template in trying to avoid escaping.
fixQuotemark = expectedQuotemark === "'" ? "`" : "'";
if (fixQuotemark === actualQuotemark) {
// We were already using the best quote mark for this scenario
return;
}
else if (node.text.includes(fixQuotemark)) {
// It contains all of the other kinds of quotes. Escaping is unavoidable, sadly.
return;
}
}
else {
fixQuotemark = alternativeFixQuotemark;
}
}
var start = node.getStart(sourceFile);
var text = sourceFile.text.substring(start + 1, node.end - 1);
if (needsQuoteEscapes) {
text = text.replace(new RegExp(fixQuotemark, "g"), "\\" + fixQuotemark);
}
text = text.replace(new RegExp("\\\\" + actualQuotemark, "g"), actualQuotemark);
return ctx.addFailure(start, node.end, Rule.FAILURE_STRING(actualQuotemark, fixQuotemark), new Lint.Replacement(start, node.end - start, fixQuotemark + text + fixQuotemark));
}
ts.forEachChild(node, cb);
});
}
function getQuotemarkPreference(ruleArguments) {
for (var _i = 0, ruleArguments_1 = ruleArguments; _i < ruleArguments_1.length; _i++) {
var arg = ruleArguments_1[_i];
switch (arg) {
case OPTION_SINGLE:
return "'";
case OPTION_DOUBLE:
return '"';
case OPTION_BACKTICK:
return "`";
default:
continue;
}
}
// Default to double quotes if no pref is found.
return '"';
}
function getJSXQuotemarkPreference(ruleArguments, regularQuotemarkPreference) {
for (var _i = 0, ruleArguments_2 = ruleArguments; _i < ruleArguments_2.length; _i++) {
var arg = ruleArguments_2[_i];
switch (arg) {
case OPTION_JSX_SINGLE:
return "'";
case OPTION_JSX_DOUBLE:
return '"';
default:
continue;
}
}
// The JSX preference was not found, so try to use the regular preference.
// If the regular pref is backtick, use double quotes instead.
return regularQuotemarkPreference !== "`" ? regularQuotemarkPreference : '"';
}
var templateObject_1;