如何从独立Cypress测试仓库获取主代码的代码覆盖率？

方案一：主仓库构建插桩代码并发布私有包 #

这是最可靠的跨仓库覆盖率方案，核心是将主仓库代码插桩后作为依赖提供给测试仓库。

• 主仓库配置插桩工具
  根据构建工具选择对应插桩插件：

  • Webpack/Babel：安装babel-plugin-istanbul，在babel.config.js中配置测试环境启用插件：

    module.exports = {
      env: {
        test: {
          plugins: ['istanbul']
        }
      }
    };
    

  • Vite：安装vite-plugin-istanbul，在vite.config.js中添加插件配置：

    import istanbul from 'vite-plugin-istanbul';
    export default {
      plugins: [
        istanbul({
          include: 'src/**/*',
          exclude: ['node_modules', 'test/**/*'],
          extension: ['.js', '.vue', '.ts']
        })
      ]
    };
    

• 构建并发布插桩代码
  在主仓库执行构建命令（如npm run build）生成带覆盖率插桩标记的产物，发布到私有npm仓库（如Verdaccio），或通过npm link本地关联到测试仓库。

• 测试仓库配置Cypress覆盖率

  • 安装@cypress/code-coverage依赖；
  • 在cypress/support/e2e.js中引入支持脚本：

    import '@cypress/code-coverage/support';
    

  • 在cypress.config.js中注册覆盖率任务：

    import { defineConfig } from 'cypress';
    import codeCoverageTask from '@cypress/code-coverage/task';
    
    export default defineConfig({
      e2e: {
        setupNodeEvents(on, config) {
          codeCoverageTask(on, config);
          return config;
        }
      }
    });
    

• 生成覆盖率报告
  运行Cypress测试后，测试仓库根目录会生成coverage文件夹，包含主代码的完整覆盖率报告。

方案二：本地联动双仓库动态插桩 #

适合本地开发场景，无需发布包，直接联动两个仓库的代码：

• 本地链接主仓库
  在主仓库根目录执行npm link将包注册到本地全局；在测试仓库根目录执行npm link <主仓库包名>，让测试仓库使用本地主仓库代码。

• 主仓库启动插桩开发服务
  修改主仓库启动脚本，确保加载插桩配置。例如React项目：

  "scripts": {
    "start:coverage": "react-scripts start --env test"
  }
  

  执行npm run start:coverage启动带插桩的开发服务器。

• 测试仓库指向主服务
  在测试仓库的cypress.config.js中设置baseUrl为主仓库开发服务器地址（如http://localhost:3000），运行Cypress测试即可收集覆盖率数据。

• 调整报告路径（可选）
  若需将报告输出到主仓库，可在测试仓库的.nycrc中配置：

  {
    "report-dir": "../main-repo/coverage"
  }
  

方案三：CI流水线中拉取主仓库插桩 #

适合CI环境自动处理，无需本地配置：

• CI脚本拉取主仓库
  在CI流程中，先拉取主仓库代码到测试仓库的子目录（如./main-repo），并安装主仓库依赖。

• 主仓库构建插桩产物
  在主仓库目录执行构建命令，生成带插桩的静态产物。

• 测试仓库配置静态服务
  启动静态服务器指向主仓库的构建产物目录，将Cypress的baseUrl设置为该服务器地址。

• 运行测试生成报告
  执行Cypress测试，收集覆盖率数据后生成报告，可配置CI将报告上传到指定平台。

关键注意事项 #

• 确保插桩工具覆盖所有需要统计的源码文件，避免排除核心业务代码目录；
• 单页应用需确保所有路由都被测试用例访问到，否则覆盖率会缺失部分分支；
• 若报告路径映射错误，可通过测试仓库的.nycrc配置include字段指定主仓库源码路径：

  {
    "include": ["../main-repo/src/**/*"],
    "exclude": ["../main-repo/node_modules/**/*"]
  }
  

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