yoda

要求或禁止 “Yoda” 条件

Yoda 条件之所以得名，是因为条件中的字面量值在前，而变量在后。例如，以下是一个 Yoda 条件

if ("red" === color) {
    // ...
}
1
2
3

这被称为 Yoda 条件，因为它读起来像“如果红色等于颜色”，类似于星球大战人物 Yoda 说话的方式。 与另一种排列操作数的方式比较

if (color === "red") {
    // ...
}
1
2
3

这通常读作“如果颜色等于红色”，这可以说是描述比较的更自然方式。

Yoda 条件的支持者强调，不可能错误地使用 = 代替 ==，因为您无法赋值给字面量值。 这样做会导致语法错误，并且您会及早被告知错误。 因此，这种做法在早期编程中非常普遍，当时工具尚不可用。

Yoda 条件的反对者指出，工具使我们成为更好的程序员，因为工具会捕获错误使用 = 代替 == 的情况（ESLint 会为您捕获此错误）。 因此，他们认为，该模式的效用并不超过使用 Yoda 条件时代码的可读性损失。

规则详情

此规则旨在强制执行将变量与字面量值进行比较的条件的一致样式。

选项

此规则可以接受字符串选项

• 如果是默认的 "never"，则比较绝不能是 Yoda 条件。
• 如果是 "always"，则字面量值必须始终放在前面。

默认的 "never" 选项可以在对象字面量中具有例外选项

• 如果 "exceptRange" 属性为 true，则该规则允许在直接包含在括号中的范围比较中使用 Yoda 条件，包括 if 或 while 条件的括号。 默认值为 false。 范围比较测试变量是否在两个字面量值之间的范围内。
• 如果 "onlyEquality" 属性为 true，则该规则仅针对相等运算符 == 和 === 报告 Yoda 条件。 默认值为 false。

onlyEquality 选项允许 exceptRange 允许的异常的超集，因此这两个选项一起使用没有意义。

never

默认 "never" 选项的错误代码示例

/*eslint yoda: "error"*/

if ("red" === color) {
    // ...
}

if (`red` === color) {
    // ...
}

if (`red` === `${color}`) {
    // ...
}

if (true == flag) {
    // ...
}

if (5 > count) {
    // ...
}

if (-1 < str.indexOf(substr)) {
    // ...
}

if (0 <= x && x < 1) {
    // ...
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

默认 "never" 选项的正确代码示例

/*eslint yoda: "error"*/

if (5 & value) {
    // ...
}

if (value === "red") {
    // ...
}

if (value === `red`) {
    // ...
}

if (`${value}` === `red`) {

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

exceptRange

"never", { "exceptRange": true } 选项的正确代码示例

/*eslint yoda: ["error", "never", { "exceptRange": true }]*/

function isReddish(color) {
    return (color.hue < 60 || 300 < color.hue);
}

if (x < -1 || 1 < x) {
    // ...
}

if (count < 10 && (0 <= rand && rand < 1)) {
    // ...
}

if (`blue` < x && x < `green`) {
    // ...
}

function howLong(arr) {
    return (0 <= arr.length && arr.length < 10) ? "short" : "long";
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

onlyEquality

"never", { "onlyEquality": true } 选项的正确代码示例

/*eslint yoda: ["error", "never", { "onlyEquality": true }]*/

if (x < -1 || 9 < x) {
}

if (x !== 'foo' && 'bar' != x) {
}

if (x !== `foo` && `bar` != x) {
}
1
2
3
4
5
6
7
8
9
10

always

"always" 选项的错误代码示例

/*eslint yoda: ["error", "always"]*/

if (color == "blue") {
    // ...
}

if (color == `blue`) {
    // ...
}
1
2
3
4
5
6
7
8
9

"always" 选项的正确代码示例

/*eslint yoda: ["error", "always"]*/

if ("blue" == value) {
    // ...
}

if (`blue` == value) {
    // ...
}

if (`blue` == `${value}`) {
    // ...
}

if (-1 < str.indexOf(substr)) {
    // ...
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

版本

此规则在 ESLint v0.7.1 中引入。

延伸阅读

Yoda 条件 - 维基百科
en.wikipedia.org

编码风格
thomas.tuerke.net

资源

• 规则来源
• 测试来源