quotes

強制統一使用反引號、雙引號或單引號

此規則已在 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 中引入。

資源

• 規則來源
• 測試來源