eslint-plugin-stylistic-compat
Version:
Compatibility version of @stylistic/eslint-plugin for Node.js >= 12 and ESLint v8
340 lines (335 loc) • 14.2 kB
JavaScript
'use strict';
var utils = require('../utils.js');
var vendor = require('../vendor.js');
var _sliceInstanceProperty = require('/runtime-corejs3/core-js/instance/slice');
var _String$raw = require('/runtime-corejs3/core-js/string/raw');
var _Array$from = require('/runtime-corejs3/core-js/array/from');
var _Array$isArray = require('/runtime-corejs3/core-js/array/is-array');
var _includesInstanceProperty = require('/runtime-corejs3/core-js/instance/includes');
require('/runtime-corejs3/core-js/object/from-entries');
require('/runtime-corejs3/core-js/instance/map');
require('/runtime-corejs3/core-js/instance/filter');
require('/runtime-corejs3/core-js/object/entries');
require('/runtime-corejs3/core-js/set');
require('/runtime-corejs3/core-js/instance/flags');
require('/runtime-corejs3/core-js/instance/starts-with');
require('/runtime-corejs3/core-js/instance/concat');
require('/runtime-corejs3/core-js/object/keys');
require('/runtime-corejs3/core-js/instance/reduce');
require('/runtime-corejs3/core-js/object/assign');
require('/runtime-corejs3/core-js/instance/keys');
require('/runtime-corejs3/core-js/instance/find');
require('/runtime-corejs3/core-js/instance/reverse');
require('/runtime-corejs3/core-js/object/define-property');
require('/runtime-corejs3/core-js/object/create');
require('/runtime-corejs3/core-js/object/freeze');
require('/runtime-corejs3/core-js/instance/last-index-of');
require('/runtime-corejs3/core-js/object/define-properties');
require('/runtime-corejs3/core-js/instance/index-of');
require('/runtime-corejs3/core-js/instance/at');
require('/runtime-corejs3/core-js/symbol');
require('/runtime-corejs3/core-js/symbol/iterator');
require('/runtime-corejs3/core-js/parse-int');
require('/runtime-corejs3/core-js/parse-float');
require('/runtime-corejs3/core-js/weak-map');
require('/runtime-corejs3/core-js/global-this');
require('/runtime-corejs3/core-js/instance/for-each');
require('eslint/use-at-your-own-risk');
require('eslint');
require('/runtime-corejs3/core-js/object/get-own-property-descriptor');
require('/runtime-corejs3/core-js/map');
require('/runtime-corejs3/core-js/instance/some');
require('/runtime-corejs3/core-js/instance/every');
require('/runtime-corejs3/core-js/instance/sort');
require('/runtime-corejs3/core-js/array/of');
require('/runtime-corejs3/core-js/instance/entries');
require('/runtime-corejs3/core-js/instance/find-index');
require('/runtime-corejs3/core-js/instance/flat');
require('/runtime-corejs3/core-js/instance/values');
require('/runtime-corejs3/core-js/object/get-own-property-names');
require('/runtime-corejs3/core-js/number/is-finite');
require('/runtime-corejs3/core-js/number/is-nan');
require('/runtime-corejs3/core-js/number/parse-float');
require('/runtime-corejs3/core-js/number/parse-int');
require('/runtime-corejs3/core-js/object/is');
require('/runtime-corejs3/core-js/object/is-extensible');
require('/runtime-corejs3/core-js/object/is-frozen');
require('/runtime-corejs3/core-js/object/is-sealed');
require('/runtime-corejs3/core-js/object/values');
require('/runtime-corejs3/core-js/string/from-code-point');
require('/runtime-corejs3/core-js/instance/code-point-at');
require('/runtime-corejs3/core-js/instance/ends-with');
require('/runtime-corejs3/core-js/instance/pad-end');
require('/runtime-corejs3/core-js/instance/pad-start');
require('/runtime-corejs3/core-js/instance/trim');
require('/runtime-corejs3/core-js/instance/trim-end');
require('/runtime-corejs3/core-js/instance/trim-left');
require('/runtime-corejs3/core-js/instance/trim-right');
require('/runtime-corejs3/core-js/instance/trim-start');
require('/runtime-corejs3/core-js/symbol/for');
require('/runtime-corejs3/core-js/symbol/key-for');
require('/runtime-corejs3/core-js/object/prevent-extensions');
require('/runtime-corejs3/core-js/object/seal');
require('/runtime-corejs3/core-js/object/get-prototype-of');
require('/runtime-corejs3/core-js/symbol/replace');
require('/runtime-corejs3/core-js/instance/bind');
require('/runtime-corejs3/core-js/instance/splice');
require('/runtime-corejs3/core-js/instance/repeat');
function switchQuote(str) {
const newQuote = this.quote;
const oldQuote = str[0];
if (newQuote === oldQuote) return str;
return newQuote + _sliceInstanceProperty(str).call(str, 1, -1).replace(/\\(\$\{|\r\n?|\n|.)|["'`]|\$\{|(\r\n?|\n)/gu, (match, escaped, newline) => {
if (escaped === oldQuote || oldQuote === "`" && escaped === "${") return escaped;
if (match === newQuote || newQuote === "`" && match === "${") return `\\${match}`;
if (newline && oldQuote === "`") return "\\n";
return match;
}) + newQuote;
}
const QUOTE_SETTINGS = {
double: {
quote: '"',
alternateQuote: "'",
description: "doublequote",
convert: switchQuote
},
single: {
quote: "'",
alternateQuote: '"',
description: "singlequote",
convert: switchQuote
},
backtick: {
quote: "`",
alternateQuote: '"',
description: "backtick",
convert: switchQuote
}
};
const UNESCAPED_LINEBREAK_PATTERN = new RegExp(_String$raw`(^|[^\\])(\\\\)*[${_Array$from(utils.LINEBREAKS).join("")}]`, "u");
const AVOID_ESCAPE = "avoid-escape";
var _baseRule = utils.createRule({
name: "quotes",
package: "js",
meta: {
type: "layout",
docs: {
description: "Enforce the consistent use of either backticks, double, or single quotes"
},
fixable: "code",
schema: [{
type: "string",
enum: ["single", "double", "backtick"]
}, {
anyOf: [{
type: "string",
enum: ["avoid-escape"]
}, {
type: "object",
properties: {
avoidEscape: {
type: "boolean"
},
allowTemplateLiterals: {
anyOf: [{
type: "boolean"
}, {
type: "string",
enum: ["never", "avoidEscape", "always"]
}]
},
ignoreStringLiterals: {
type: "boolean"
}
},
additionalProperties: false
}]
}],
messages: {
wrongQuotes: "Strings must use {{description}}."
}
},
create(context) {
const quoteOption = context.options[0];
const settings = QUOTE_SETTINGS[quoteOption || "double"];
const options = context.options[1];
const sourceCode = context.sourceCode;
let avoidEscape = false;
let ignoreStringLiterals = false;
let allowTemplateLiteralsAlways = false;
let allowTemplateLiteralsToAvoidEscape = false;
if (typeof options === "object") {
avoidEscape = options.avoidEscape === true;
ignoreStringLiterals = options.ignoreStringLiterals === true;
if (typeof options.allowTemplateLiterals === "string") {
allowTemplateLiteralsAlways = options.allowTemplateLiterals === "always";
allowTemplateLiteralsToAvoidEscape = allowTemplateLiteralsAlways || options.allowTemplateLiterals === "avoidEscape";
} else if (typeof options.allowTemplateLiterals === "boolean") {
allowTemplateLiteralsAlways = options.allowTemplateLiterals === true;
allowTemplateLiteralsToAvoidEscape = options.allowTemplateLiterals === true;
}
} else if (options === AVOID_ESCAPE) {
avoidEscape = true;
}
function isJSXLiteral(node) {
if (!node.parent) return false;
return node.parent.type === "JSXAttribute" || node.parent.type === "JSXElement" || node.parent.type === "JSXFragment";
}
function isDirective(node) {
return node.type === "ExpressionStatement" && node.expression.type === "Literal" && typeof node.expression.value === "string" && !utils.isParenthesised(sourceCode, node.expression);
}
function isExpressionInOrJustAfterDirectivePrologue(node) {
if (!node.parent) return false;
if (!utils.isTopLevelExpressionStatement(node.parent)) return false;
const block = node.parent.parent;
if (!block || !("body" in block) || !_Array$isArray(block.body)) return false;
for (let i = 0; i < block.body.length; ++i) {
const statement = block.body[i];
if (statement === node.parent) return true;
if (!isDirective(statement)) break;
}
return false;
}
function isAllowedAsNonBacktick(node) {
const parent = node.parent;
if (!parent) return false;
switch (parent.type) {
// Directive Prologues.
case "ExpressionStatement":
return !utils.isParenthesised(sourceCode, node) && isExpressionInOrJustAfterDirectivePrologue(node);
// LiteralPropertyName.
case "Property":
case "PropertyDefinition":
case "MethodDefinition":
return parent.key === node && !parent.computed;
// ModuleSpecifier.
case "ImportDeclaration":
case "ExportNamedDeclaration":
return parent.source === node;
// ModuleExportName or ModuleSpecifier.
case "ExportAllDeclaration":
return parent.exported === node || parent.source === node;
// ModuleExportName.
case "ImportSpecifier":
return parent.imported === node;
// ModuleExportName.
case "ExportSpecifier":
return parent.local === node || parent.exported === node;
case "ImportAttribute":
return parent.value === node;
// Others don't allow.
default:
return false;
}
}
function isUsingFeatureOfTemplateLiteral(node) {
const hasTag = node.parent.type === "TaggedTemplateExpression" && node === node.parent.quasi;
if (hasTag) return true;
const hasStringInterpolation = node.expressions.length > 0;
if (hasStringInterpolation) return true;
const isMultilineString = node.quasis.length >= 1 && UNESCAPED_LINEBREAK_PATTERN.test(node.quasis[0].value.raw);
if (isMultilineString) return true;
return false;
}
return {
Literal(node) {
if (ignoreStringLiterals) return;
const val = node.value;
const rawVal = node.raw;
if (settings && typeof val === "string") {
let isValid = quoteOption === "backtick" && isAllowedAsNonBacktick(node) || isJSXLiteral(node) || utils.isSurroundedBy(rawVal, settings.quote);
if (!isValid && avoidEscape) isValid = utils.isSurroundedBy(rawVal, settings.alternateQuote) && _includesInstanceProperty(rawVal).call(rawVal, settings.quote);
if (!isValid) {
context.report({
node,
messageId: "wrongQuotes",
data: {
description: settings.description
},
fix(fixer) {
if (quoteOption === "backtick" && utils.hasOctalOrNonOctalDecimalEscapeSequence(rawVal)) {
return null;
}
return fixer.replaceText(node, settings.convert(node.raw));
}
});
}
}
},
TemplateLiteral(node) {
var _context;
if (allowTemplateLiteralsAlways || quoteOption === "backtick" || isUsingFeatureOfTemplateLiteral(node)) {
return;
}
if (allowTemplateLiteralsToAvoidEscape && avoidEscape && _includesInstanceProperty(_context = sourceCode.getText(node)).call(_context, settings.quote)) return;
context.report({
node,
messageId: "wrongQuotes",
data: {
description: settings.description
},
fix(fixer) {
if (utils.isTopLevelExpressionStatement(node.parent) && !utils.isParenthesised(sourceCode, node)) {
return null;
}
return fixer.replaceText(node, settings.convert(sourceCode.getText(node)));
}
});
}
};
}
});
const baseRule = /* @__PURE__ */utils.castRuleModule(_baseRule);
var quotes = utils.createRule({
name: "quotes",
package: "ts",
meta: {
type: "layout",
docs: {
description: "Enforce the consistent use of either backticks, double, or single quotes"
},
fixable: "code",
hasSuggestions: baseRule.meta.hasSuggestions,
messages: baseRule.meta.messages,
schema: baseRule.meta.schema
},
defaultOptions: ["double", {
allowTemplateLiterals: "never",
avoidEscape: false,
ignoreStringLiterals: false
}],
create(context, [option]) {
const rules = baseRule.create(context);
function isAllowedAsNonBacktick(node) {
var _parent$parent;
const parent = node.parent;
switch (parent == null ? undefined : parent.type) {
case vendor.distExports.AST_NODE_TYPES.TSAbstractMethodDefinition:
case vendor.distExports.AST_NODE_TYPES.TSMethodSignature:
case vendor.distExports.AST_NODE_TYPES.TSPropertySignature:
case vendor.distExports.AST_NODE_TYPES.TSModuleDeclaration:
case vendor.distExports.AST_NODE_TYPES.TSExternalModuleReference:
return true;
case vendor.distExports.AST_NODE_TYPES.TSEnumMember:
return node === parent.id;
case vendor.distExports.AST_NODE_TYPES.TSAbstractPropertyDefinition:
case vendor.distExports.AST_NODE_TYPES.PropertyDefinition:
return parent.key === node && !parent.computed;
case vendor.distExports.AST_NODE_TYPES.TSLiteralType:
return ((_parent$parent = parent.parent) == null ? undefined : _parent$parent.type) === vendor.distExports.AST_NODE_TYPES.TSImportType;
default:
return false;
}
}
return {
Literal(node) {
if (option === "backtick" && isAllowedAsNonBacktick(node)) return;
rules.Literal(node);
},
TemplateLiteral(node) {
rules.TemplateLiteral(node);
}
};
}
});
module.exports = quotes;