TypeScript中为while(true)循环加退出逻辑适配测试覆盖率工具

我正尝试让测试覆盖率计算工具兼容while(true)循环。当前工具认为循环结束分支从未执行，判定测试覆盖率不足，这是工具的bug。但在工具上游修复或支持忽略注释前，需要临时解决方案。

问题代码如下，功能与测试均正常，但因循环永不退出导致覆盖率缺失：

function* greetings1(): Generator<string, never, undefined> {
  while(true) {
    yield 'hello'
  }
}

我曾尝试定义常量TRUE，通过测试模拟替换为false让循环退出，但出现TypeScript类型错误：A function returning 'never' cannot have a reachable end point. ts(2534)，代码如下：

const TRUE: true = true
function* greetings2(): Generator<string, never, undefined> {
  while(TRUE) {
    yield 'hello'
  }
}

我需要在不牺牲类型定义、无需对整个函数体做类型转换的前提下，为while(true)循环添加退出机制；若需要对常量TRUE做特殊类型转换也可以接受。另外，我尝试过使用break，但覆盖率工具认为break退出与循环条件变为false是不同情况，无法彻底解决问题，最好能让循环自然结束。我一年前曾提出过相关问题：《Istanbul代码覆盖率：忽略while true循环的else分支》。

解决方案 #

可以通过添加永远不会在生产环境执行的throw语句来同时满足类型检查和测试覆盖率要求，具体实现如下：

// 定义常量，通过类型断言确保编译时TypeScript认为它永远是true
const TRUE = true as true;

function* greetings(): Generator<string, never, undefined> {
  while (TRUE) {
    yield 'hello';
  }
  // 仅测试环境下会执行到这里，throw语句确保函数返回类型仍为never
  throw new Error('循环正常结束后的不可达代码');
}

方案说明：

1. 类型兼容性：生产环境中TRUE为true，循环永不退出，throw语句永远不会执行，函数返回never类型完全符合定义；测试环境下即使TRUE被替换为false，循环结束后执行throw，函数仍因抛出错误而返回never类型，不会触发ts(2534)错误。
2. 覆盖率解决：测试时将TRUE替换为false，循环会自然结束，覆盖率工具会识别到循环的结束分支被执行，从而解决覆盖率缺失问题。
3. 无额外类型转换：仅对常量TRUE做了as true的类型断言，未修改函数体的整体类型定义。

如果需要更简洁的写法，也可以用unreachable工具函数（常见于TypeScript项目）替代throw语句：

function unreachable(): never {
  throw new Error('Unreachable code');
}

const TRUE = true as true;

function* greetings(): Generator<string, never, undefined> {
  while (TRUE) {
    yield 'hello';
  }
  unreachable();
}

内容的提问来源于stack exchange，提问作者cyberixae