# 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;
}

在只有一次迭代（或最多一次迭代）是预期行为的极少数情况下，应重构代码以使用 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;
}

此规则的正确代码示例：

/*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;
    }
}

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

此规则的附加正确代码示例：

/*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);
}

# 选项

此规则有一个对象选项，有一个选项：

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

# 已知限制

静态代码路径分析通常不评估条件。由于这一事实，此规则可能会遗漏报告案例，例如：

for (let i = 0; i < 10; i++) {
    doSomething(i);
    if (true) {
        break;
    }
}

← no-unreachable no-unsafe-finally →