Skip to content

上海惠艾Hi-CC魔法球Vue3示例项目,在浏览器端实时显示代码覆盖率,未覆盖代码行,以及覆盖率历史变化。基于vite的Istanbul插桩

Notifications You must be signed in to change notification settings

thm1118/vue3-hicc-magic-demo

Repository files navigation

Hi-CC魔法球:Vue3+Vite示例项目

  • Hi-CC魔法球是 上海惠艾信息科技有限公司的前端测试覆盖率度量展示工具,通过浏览器插件方式,帮助测试人员/开发人员在测试过程中,能实时获知被测页面的代码覆盖率情况,同时反馈未被测试的代码的行号以便及时补测,是研发测试的防漏测神器
  • Hi-CC魔法球提供测试历史覆盖率记录,可累计当天最高覆盖率,累计近期最高覆盖率。
  • Hi-CC魔法球 可通过浏览器插件部署,也支持混合移动App(企业版),更详细说明参阅 Hi-CC魔法球安装说明
基本功能演示
基本功能演示: 点击图片可全屏
  • Hi-CC魔法球 支持现代前端的三大主流框架 Vue/Anguarl/React

实现原理

  • 前端代码在部署前需要 使用istanbul工具对代码"插桩"
  • “插桩”后的代码在浏览器运行时会输出覆盖率数据,在浏览器中打开控制台F12,键入 window.__coverage__可看到覆盖率数据。window.coverage
  • Hi-CC魔法球基于此数据计算并呈现。
  • 在览器扩展安装后,如果 检测到window.__coverage__是有效存在的,则会应显示浏览器扩展的魔法球,未检测到,不会显示魔法球。

如何“插桩"

  • 本仓库演示基于Vue3框架的istanbul覆盖率插桩
    • 如需查看vue2.6 的istanbul覆盖率插桩 ,请访问vue2.6示例
    • 如需查看vue2.5 的istanbul覆盖率插桩 ,请访问vue2.5示例
    • 如需查看angular6+ 的istanbul覆盖率插桩,请访问angular6+ 示例
    • 如需查看react 的istanbul覆盖率插桩,请访问react17 示例
  • Vue3项目的构建工具链通常是Vite,Vite有Istanbul工具的插件。
  • 在项目根目录下执行 yarn add -D vite-plugin-istanbul 安装该插件,成功后在package.json内会有该插件plugin
  • 在vite的配置文件 vite.config.js中配置 vite-plugin-istanbul, 添加:
...
  plugins: [
    vue(),
    istanbul({
      include: 'src/*',
      exclude: ['node_modules', 'test/'],
      extension: ['.js', '.ts', '.vue'],
      requireEnv: false,
      forceBuildInstrument: true
    }),
  ],
...

项目构建

  • 项目构建
    • 执行 yarn run buildnpm run build 构建
    • 构建输出到 dist目录下
  • 如果需要快速演示,dist目录是已构建好的SIT环境配置。可以用node工具serve或其他本地http服务工具快速启动演示,
    • serve命令安装 :yarn global add serve
    • 在dist目录下,启动一个命令行窗口,运行 serve,即可开启http服务 http://localhost:3000/

About

上海惠艾Hi-CC魔法球Vue3示例项目,在浏览器端实时显示代码覆盖率,未覆盖代码行,以及覆盖率历史变化。基于vite的Istanbul插桩

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published