quotes

强制一致地使用反引号、双引号或单引号

一些该规则报告的问题可以通过 --fix 命令行选项 自动修复

JavaScript 允许您以以下三种方式之一定义字符串：双引号、单引号和反引号（从 ECMAScript 6 开始）。例如：

/*eslint-env es6*/

var double = "double";
var single = 'single';
var backtick = `backtick`;    // ES6 only

这些行中的每一行都创建一个字符串，在某些情况下，可以互换使用。选择如何在代码库中定义字符串是模板字面（允许解释嵌入的表达式）之外的一种风格。

许多代码库要求以一致的方式定义字符串。

规则详情

此规则强制一致地使用反引号、双引号或单引号。

选项

该规则有两个选项，一个字符串选项和一个对象选项。

字符串选项：

• "double"（默认）要求尽可能使用双引号
• "single" 要求尽可能使用单引号
• "backtick" 要求尽可能使用反引号

对象选项：

• "avoidEscape": true 允许字符串使用单引号或双引号，只要字符串包含必须转义的引号
• "allowTemplateLiterals": true 允许字符串使用反引号

已弃用：对象属性 avoid-escape 已弃用；请改用对象属性 avoidEscape。

double

此规则使用默认 "double" 选项的错误代码示例：

/*eslint quotes: ["error", "double"]*/

var single = 'single';
var unescaped = 'a string containing "double" quotes';
var backtick = `back\ntick`; // you can use \n in single or double quoted strings

此规则使用默认 "double" 选项的正确代码示例：

/*eslint quotes: ["error", "double"]*/
/*eslint-env es6*/

var double = "double";
var backtick = `back
tick`;  // backticks are allowed due to newline
var backtick = tag`backtick`; // backticks are allowed due to tag

single

此规则使用 "single" 选项的错误代码示例：

/*eslint quotes: ["error", "single"]*/

var double = "double";
var unescaped = "a string containing 'single' quotes";

此规则使用 "single" 选项的正确代码示例：

/*eslint quotes: ["error", "single"]*/
/*eslint-env es6*/

var single = 'single';
var backtick = `back${x}tick`; // backticks are allowed due to substitution

backticks

此规则使用 "backtick" 选项的错误代码示例：

/*eslint quotes: ["error", "backtick"]*/

var single = 'single';
var double = "double";
var unescaped = 'a string containing `backticks`';

此规则使用 "backtick" 选项的正确代码示例：

/*eslint quotes: ["error", "backtick"]*/
/*eslint-env es6*/

var backtick = `backtick`;

avoidEscape

此规则使用 "double", { "avoidEscape": true } 选项的其他正确代码示例：

/*eslint quotes: ["error", "double", { "avoidEscape": true }]*/

var single = 'a string containing "double" quotes';

此规则使用 "single", { "avoidEscape": true } 选项的其他正确代码示例：

/*eslint quotes: ["error", "single", { "avoidEscape": true }]*/

var double = "a string containing 'single' quotes";

此规则使用 "backtick", { "avoidEscape": true } 选项的其他正确代码示例：

/*eslint quotes: ["error", "backtick", { "avoidEscape": true }]*/

var double = "a string containing `backtick` quotes"

allowTemplateLiterals

此规则使用 "double", { "allowTemplateLiterals": true } 选项的其他正确代码示例：

/*eslint quotes: ["error", "double", { "allowTemplateLiterals": true }]*/

var double = "double";
var double = `double`;

此规则使用 "single", { "allowTemplateLiterals": true } 选项的其他正确代码示例：

/*eslint quotes: ["error", "single", { "allowTemplateLiterals": true }]*/

var single = 'single';
var single = `single`;

{ "allowTemplateLiterals": false } 不会禁止使用所有模板字面。如果您想禁止任何模板字面实例，请使用 no-restricted-syntax 并定位 TemplateLiteral 选择器。

何时不使用

如果您不需要字符串样式的一致性，您可以安全地禁用此规则。