no-unreachable-loop

禁止循环体只能执行一次迭代的循环

永远无法到达第二次迭代的循环可能是代码中的错误。

for (let i = 0; i < arr.length; i++) {
    if (arr[i].name === myName) {
        doSomething(arr[i]);
        // break was supposed to be here
    }
    break;
}
1
2
3
4
5
6
7

在极少数情况下，如果只打算执行一次迭代（或最多执行一次迭代），则应将代码重构为使用 if 条件语句，而不是使用 while、do-while 和 for 循环。避免在这些情况下使用循环结构被认为是最佳实践。

规则详情

此规则旨在通过对循环体执行静态代码路径分析来检测和禁止最多执行一次迭代的循环。

特别是，此规则将禁止循环体在所有代码路径中都退出循环的循环。如果循环体中的所有代码路径都以 break、return 或 throw 语句结束，则无论循环条件如何，此类循环的第二次迭代肯定无法到达。

此规则检查 while、do-while、for、for-in 和 for-of 循环。您可以选择性地禁用对这些结构的检查。

此规则的 **不正确** 代码示例

/*eslint no-unreachable-loop: "error"*/

while (foo) {
    doSomething(foo);
    foo = foo.parent;
    break;
}

function verifyList(head) {
    let item = head;
    do {
        if (verify(item)) {
            return true;
        } else {
            return false;
        }
    } while (item);
}

function findSomething(arr) {
    for (var i = 0; i < arr.length; i++) {
        if (isSomething(arr[i])) {
            return arr[i];
        } else {
            throw new Error("Doesn't exist.");
        }
    }
}

for (key in obj) {
    if (key.startsWith("_")) {
        break;
    }
    firstKey = key;
    firstValue = obj[key];
    break;
}

for (foo of bar) {
    if (foo.id === id) {
        doSomething(foo);
    }
    break;
}
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

此规则的 **正确** 代码示例

/*eslint no-unreachable-loop: "error"*/

while (foo) {
    doSomething(foo);
    foo = foo.parent;
}

function verifyList(head) {
    let item = head;
    do {
        if (verify(item)) {
            item = item.next;
        } else {
            return false;
        }
    } while (item);

    return true;
}

function findSomething(arr) {
    for (var i = 0; i < arr.length; i++) {
        if (isSomething(arr[i])) {
            return arr[i];
        }
    }
    throw new Error("Doesn't exist.");
}

for (key in obj) {
    if (key.startsWith("_")) {
        continue;
    }
    firstKey = key;
    firstValue = obj[key];
    break;
}

for (foo of bar) {
    if (foo.id === id) {
        doSomething(foo);
        break;
    }
}
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

请注意，此规则并非旨在检查循环条件，并且不会在以下示例等情况下发出警告。

此规则的其他 **正确** 代码示例

/*eslint no-unreachable-loop: "error"*/

do {
    doSomething();
} while (false)

for (let i = 0; i < 1; i++) {
    doSomething(i);
}

for (const a of [1]) {
    doSomething(a);
}
1
2
3
4
5
6
7
8
9
10
11
12
13

选项

此规则具有一个对象选项，其中包含一个选项

• "ignore" - 一个可选的循环类型数组，此规则将忽略这些类型。

ignore

您可以在 "ignore" 数组中指定最多 5 个不同的元素

• "WhileStatement" - 忽略所有 while 循环。
• "DoWhileStatement" - 忽略所有 do-while 循环。
• "ForStatement" - 忽略所有 for 循环（不适用于 for-in 和 for-of 循环）。
• "ForInStatement" - 忽略所有 for-in 循环。
• "ForOfStatement" - 忽略所有 for-of 循环。

使用 "ignore" 选项的此规则的 **正确** 代码示例

/*eslint no-unreachable-loop: ["error", { "ignore": ["ForInStatement", "ForOfStatement"] }]*/

for (var key in obj) {
  hasEnumerableProperties = true;
  break;
}

for (const a of b) break;
1
2
3
4
5
6
7
8

已知限制

一般来说，静态代码路径分析不会评估条件。由于这一事实，此规则可能会错过报告以下情况

for (let i = 0; i < 10; i++) {
    doSomething(i);
    if (true) {
        break;
    }
}
1
2
3
4
5
6

相关规则

• no-unreachable
• no-constant-condition
• no-unmodified-loop-condition
• for-direction

版本

此规则是在 ESLint v7.3.0 中引入的。

资源

• 规则源代码
• 测试源代码