istanbul-instrumenter-loader

使用 istanbul-lib-instrument 来测试 JS 文件,以生成后续代码覆盖率报告

安装

npm i -D istanbul-instrumenter-loader

用法

参考

结构

├─ src
│ |– components
│ | |– bar
│ | │ |─ index.js
│ | |– foo/
│     |– index.js
|– test
| |– src
| | |– components
| | | |– foo
| | | | |– index.js

为生成所有组件(包括您没写测试的那些)的代码覆盖率报告,你需要 require 所有业务和测试的代码。相关内容在 karma-webpack 其它用法 有涉及。

test/index.js

// 从 `project/test/src/components/**/index.js` 中 require 所有的测试用例
const tests = require.context('./src/components/', true, /index\.js$/);

tests.keys().forEach(tests);

// 从 `project/src/components/**/index.js` 中 require 所有的组件
const components = require.context('../src/components/', true, /index\.js$/);

components.keys().forEach(components);

ℹ️ 以下为 karma 的唯一入口起点文件

karma.conf.js

config.set({
  ...
  files: [
    'test/index.js'
  ],
  preprocessors: {
    'test/index.js': 'webpack'
  },
  webpack: {
    ...
    module: {
      rules: [
        // 仅使用 Istanbul 测试源
        {
          test: /\.js$/,
          use: { loader: 'istanbul-instrumenter-loader' },
          include: path.resolve('src/components/')
        }
      ]
    }
    ...
  },
  reporters: [ 'progress', 'coverage-istanbul' ],
  coverageIstanbulReporter: {
    reports: [ 'text-summary' ],
    fixWebpackSourcePaths: true
  }
  ...
});

使用 Babel

您必须将该检测作为后续步骤运行

webpack.config.js

{
  test: /\.js$|\.jsx$/,
  use: {
    loader: 'istanbul-instrumenter-loader',
    options: { esModules: true }
  },
  enforce: 'post',
  exclude: /node_modules|\.spec\.js$/,
}

选项

此 loader 支持 istanbul-lib-instrument 的所有配置选项

名称 类型 默认值 描述
debug {Boolean} false 打开调试模式
compact {Boolean} true 压缩代码
autoWrap {Boolean} false 设置为 true 以允许函数外的返回语句
esModules {Boolean} false 设置为 true 以检测 ES2015 模块
coverageVariable {String} __coverage__ 全局覆盖变量的名称
preserveComments {Boolean} false 输出中保留注释
produceSourceMap {Boolean} false 设置为 true 以生成已检测代码的 source map
sourceMapUrlCallback {Function} null 在原始代码中找到 source map URL 时调用的回调函数。该函数的调用参数有源文件名以及 source map url。

webpack.config.js

{
  test: /\.js$/,
  use: {
    loader: 'istanbul-instrumenter-loader',
    options: {...options}
  }
}

Maintainers


Kir Belevich

Juho Vepsäläinen

Joshua Wiens

Michael Ciniawsky

Matt Lewis