如何在Jest覆盖率统计中忽略指定函数？

问题本质 #

esbuild-jest默认会清除代码里的注释，包括你加的/* istanbul ignore next */，导致Jest根本看不到这些忽略规则，所以不管你把注释放在哪都没用。

解决步骤 #

1. 修改jest配置，让esbuild保留istanbul注释
   打开jest.config.js，在esbuild-jest的配置项里添加两个参数：comments用来指定保留istanbul相关注释，keepNames确保函数名不被压缩（帮助覆盖率工具正确识别目标函数）：

   module.exports = {
     clearMocks: true,
     transform: {
       '.(js|ts)$': ['esbuild-jest', { 
         sourcemap: true,
         // 只保留istanbul忽略注释
         comments: /istanbul ignore/,
         keepNames: true
       }],
     },
     setupFilesAfterEnv: ['./jest.setup.ts'],
     collectCoverage: true,
   };
   

2. 把注释放在正确的位置
   将/* istanbul ignore next */放在你要忽略的函数定义的前一行，确保它和目标函数直接关联：

   // 对应你handler.ts的代码结构
   /* istanbul ignore next */
   export const yourFunction = () => {
     return untestableCode(); // 第90行
   };
   

   如果是单行箭头函数，注释放在export前面就行：

   /* istanbul ignore next */
   export const yourFunction = () => untestableCode();
   

3. 重新运行覆盖率检查
   跑一遍Jest的覆盖率命令，看看第90行是不是已经被排除统计了。

备选方案（如果上面的方法没效果） #

要是esbuild的配置还是不生效，可以试试：

• 换成ts-jest当转换器，它对istanbul注释的支持更成熟，就是编译速度比esbuild慢一点。
• 在jest配置的coveragePathIgnorePatterns里加规则忽略整个handler.ts，但这是下策，因为会忽略整个文件的覆盖率。

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