diff options
Diffstat (limited to 'node_modules/tslint/lib/rules/quotemarkRule.js')
-rw-r--r-- | node_modules/tslint/lib/rules/quotemarkRule.js | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/node_modules/tslint/lib/rules/quotemarkRule.js b/node_modules/tslint/lib/rules/quotemarkRule.js new file mode 100644 index 000000000..4226e8ed1 --- /dev/null +++ b/node_modules/tslint/lib/rules/quotemarkRule.js @@ -0,0 +1,120 @@ +"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_JSX_SINGLE = "jsx-single"; +var OPTION_JSX_DOUBLE = "jsx-double"; +var OPTION_AVOID_TEMPLATE = "avoid-template"; +var OPTION_AVOID_ESCAPE = "avoid-escape"; +var Rule = (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.isEnabled = function () { + return _super.prototype.isEnabled.call(this) && (this.ruleArguments[0] === OPTION_SINGLE || this.ruleArguments[0] === OPTION_DOUBLE); + }; + Rule.prototype.apply = function (sourceFile) { + var args = this.ruleArguments; + if (args.length > 0) { + if (args[0] !== OPTION_SINGLE && args[0] !== OPTION_DOUBLE) { + throw new Error("First argument to 'quotemark' rule should be \"" + OPTION_SINGLE + "\" or \"" + OPTION_DOUBLE + "\""); + } + } + var quoteMark = args[0] === OPTION_SINGLE ? "'" : '"'; + return this.applyWithFunction(sourceFile, walk, { + avoidEscape: hasArg(OPTION_AVOID_ESCAPE), + avoidTemplate: hasArg(OPTION_AVOID_TEMPLATE), + jsxQuoteMark: hasArg(OPTION_JSX_SINGLE) ? "'" : hasArg(OPTION_JSX_DOUBLE) ? '"' : quoteMark, + quoteMark: quoteMark, + }); + function hasArg(name) { + return args.indexOf(name) !== -1; + } + }; + return Rule; +}(Lint.Rules.AbstractRule)); +/* tslint:disable:object-literal-sort-keys */ +Rule.metadata = { + ruleName: "quotemark", + description: "Requires single or double quotes for string literals.", + hasFix: true, + optionsDescription: (_a = ["\n Five arguments may be optionally provided:\n\n * `\"", "\"` enforces single quotes.\n * `\"", "\"` enforces double quotes.\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 * `\"", "\"` 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\"'`."], _a.raw = ["\n Five arguments may be optionally provided:\n\n * \\`\"", "\"\\` enforces single quotes.\n * \\`\"", "\"\\` enforces double quotes.\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 * \\`\"", "\"\\` 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\"'\\`."], Lint.Utils.dedent(_a, OPTION_SINGLE, OPTION_DOUBLE, OPTION_JSX_SINGLE, OPTION_JSX_DOUBLE, OPTION_AVOID_TEMPLATE, OPTION_AVOID_ESCAPE, OPTION_DOUBLE, OPTION_AVOID_ESCAPE)), + options: { + type: "array", + items: { + type: "string", + enum: [OPTION_SINGLE, OPTION_DOUBLE, OPTION_JSX_SINGLE, OPTION_JSX_DOUBLE, OPTION_AVOID_ESCAPE], + }, + minLength: 0, + maxLength: 5, + }, + optionExamples: [ + [true, OPTION_SINGLE, OPTION_AVOID_ESCAPE, OPTION_AVOID_TEMPLATE], + [true, OPTION_SINGLE, OPTION_JSX_DOUBLE], + ], + type: "style", + typescriptOnly: false, +}; +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); + if (needsQuoteEscapes && options.avoidEscape) { + if (node.kind === ts.SyntaxKind.StringLiteral) { + return; + } + // If expecting double quotes, fix a template `a "quote"` to `a 'quote'` anyway, + // always preferring *some* quote mark over a template. + fixQuoteMark = expectedQuoteMark === '"' ? "'" : '"'; + if (node.text.includes(fixQuoteMark)) { + return; + } + } + 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); + }); +} +var _a; |