在线文档教程
Eslint
规则 | Rules

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`;

何时不使用它

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

版本

该规则在 ESLint 0.0.7中引入。

资源