istanbul-instrumenter-loader

Instrument JS files with istanbul-lib-instrument for subsequent code coverage reporting

安装

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

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

tests.keys().forEach(tests);

// requires 所有在 `project/src/components/**/index.js` 中的组件
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

You must run the instrumentation as a post step

webpack.config.js

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

Options

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

Name
Type
Default
Description
Name
debug
Type
{Boolean}
Default
false
Description
Turn on debugging mode
Name
compact
Type
{Boolean}
Default
true
Description
Generate compact code
Name
autoWrap
Type
{Boolean}
Default
false
Description
Set to true to allow return statements outside of functions
Name
esModules
Type
{Boolean}
Default
false
Description
Set to true to instrument ES2015 Modules
Name
coverageVariable
Type
{String}
Default
__coverage__
Description
Name of global coverage variable
Name
preserveComments
Type
{Boolean}
Default
false
Description
Preserve comments in output
Name
produceSourceMap
Type
{Boolean}
Default
false
Description
Set to true to produce a source map for the instrumented code
Name
sourceMapUrlCallback
Type
{Function}
Default
null
Description
A callback function that is called when a source map URL is found in the original code. This function is called with the source filename and the 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


原文:https://webpack.js.org/loaders/istanbul-instrumenter-loader/