引号

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

此规则在 ESLint v8.53.0 中已弃用。请使用 相应的规则 在 @stylistic/eslint-plugin-js 中。

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

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

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

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

规则详情

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

此规则知道指令序言，例如 "use strict"，如果这样做会改变指令序言的解释方式，则不会标记或自动修复它们。

选项

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

字符串选项

• "double"（默认）要求在可能的情况下使用双引号
• "single" 要求在可能的情况下使用单引号
• "backtick" 要求在可能的情况下使用反引号

对象选项

• "avoidEscape": true 允许字符串使用单引号或双引号，只要字符串包含一个否则需要转义的引号
• "allowTemplateLiterals": true 允许字符串使用反引号

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

双引号

使用默认的 "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
1
2
3
4
5

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

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

var double = "double";
var backtick = `back
tick`;  // backticks are allowed due to newline
var backtick = tag`backtick`; // backticks are allowed due to tag
1
2
3
4
5
6

单引号

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

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

var double = "double";
var unescaped = "a string containing 'single' quotes";
1
2
3
4

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

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

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

反引号

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

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

var single = 'single';
var double = "double";
var unescaped = 'a string containing `backticks`';
1
2
3
4
5

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

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

"use strict"; // directives must use single or double quotes
var backtick = `backtick`;
var obj = { 'prop-name': `value` }; // backticks not allowed for property names
1
2
3
4
5

避免转义

使用 "double", { "avoidEscape": true } 选项，此规则的附加正确代码示例

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

var single = 'a string containing "double" quotes';
1
2
3

使用 "single", { "avoidEscape": true } 选项，此规则的附加正确代码示例

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

var double = "a string containing 'single' quotes";
1
2
3

使用 "backtick", { "avoidEscape": true } 选项，此规则的附加正确代码示例

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

var double = "a string containing `backtick` quotes"
1
2
3

允许模板字面量

使用 "double", { "allowTemplateLiterals": true } 选项，此规则的附加正确代码示例

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

var double = "double";
var double = `double`;
1
2
3
4

使用 "single", { "allowTemplateLiterals": true } 选项，此规则的附加正确代码示例

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

var single = 'single';
var single = `single`;
1
2
3
4

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

何时不使用它

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

版本

此规则是在 ESLint v0.0.7 中引入的。

资源

• 规则来源
• 测试来源