ESLint 样式

外观

@stylistic/js/

引号 ​

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

js
/*eslint-env es6*/

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

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

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

规则详情 ​

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

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

选项 ​

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

字符串选项

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

对象选项

  • "avoidEscape": true 允许字符串使用单引号、双引号或模板字面量，只要字符串包含一个否则必须转义的引号
  • "allowTemplateLiterals": true 允许字符串使用反引号
  • "ignoreStringLiterals": true 不报告字符串字面量，只报告模板字符串

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

双引号 ​

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

js
/*eslint @stylistic/js/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
incorrect

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

js
/*eslint @stylistic/js/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
correct

单引号 ​

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

js
/*eslint @stylistic/js/quotes: ["error", "single"]*/

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

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

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

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

反引号 ​

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

js
/*eslint @stylistic/js/quotes: ["error", "backtick"]*/

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

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

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

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

avoidEscape ​

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

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

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

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

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

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

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

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

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

allowTemplateLiterals ​

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

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

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

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

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

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

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

何时不使用它 ​

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