@achil/babel-plugin-istanbul 中文文档教程

Question

babel-plugin-istanbul

有问题？ 想贡献？ 加入我们的community slack。

一个 Babel 插件，可以用 Istanbul 覆盖率检测你的代码。 它可以立即与 karma-coverage 和 Node.js 上的 mocha 一起使用（通过 纽约)。

注意：此插件不会生成任何报告或将任何数据保存到任何文件； 它只会将检测代码添加到您的 JavaScript 源代码中。 要与测试工具集成，请参阅集成部分。

Usage

安装它：

npm install --save-dev babel-plugin-istanbul

在测试模式下将它添加到 .babelrc：

{
  "env": {
    "test": {
      "plugins": [ "istanbul" ]
    }
  }
}

可选地，使用 cross-env 设置 NODE_ENV=test：

{
  "scripts": {
    "test": "cross-env NODE_ENV=test nyc --reporter=lcov --reporter=text mocha test/*.js"
  }
}

Integrations

karma

它只适用于 Karma。 首先，确保代码已经被 Babel 转译（使用 karma-babel-preprocessor、karma-webpack 或 karma-browserify ). 然后，根据文档简单地设置karma-coverage，但是不要添加coverage 预处理器。这个插件已经检测了你的代码，Karma 应该会自动拾取它。

它已经通过 bemusic/bemuse 项目进行了测试，其中包含约 2400 条语句。

mocha on node.js (through nyc)

配置 Mocha 以使用 Babel 转译 JavaScript 代码，然后您可以使用 nyc 运行测试，它将收集所有的覆盖率报告。

babel-plugin-istanbul 遵循来自 nyc 的 include/exclude 配置选项， 但您还需要通过在您的 package.json 中添加这些设置来配置 NYC 不检测您的代码：

  "nyc": {
    "sourceMap": false,
    "instrument": false
  },

Ignoring files

您不想覆盖您的测试文件，因为这会造成偏差您的报道结果。 您可以通过提供匹配 nyc 的 exclude/include 规则的插件选项来配置它：

{
  "env": {
    "test": {
      "plugins": [
        ["istanbul", {
          "exclude": [
            "**/*.spec.js"
          ]
        }]
      ]
    }
  }
}

如果您没有在 Babel 配置中提供选项，插件将在 "nyc"exclude/include 配置code> 键入 package.json。

您还可以使用伊斯坦布尔的忽略提示< /a> 指定特定的代码行以跳过检测。

Source Maps

默认情况下，此插件将获取内联源映射并将它们附加到检测代码，以便代码覆盖率可以重新映射回原始源，即使对于多步骤构建过程也是如此。 这可能会占用大量内存。 设置 useInlineSourceMaps 来防止这种行为。

{
  "env": {
    "test": {
      "plugins": [
        ["istanbul", {
          "useInlineSourceMaps": false
        }]
      ]
    }
  }
}

如果您以编程方式检测代码，则可以显式传递源映射。

import babelPluginIstanbul from 'babel-plugin-istanbul';

function instrument(sourceCode, sourceMap, fileName) {
  return babel.transform(sourceCode, {
    filename,
    plugins: [
      [babelPluginIstanbul, {
        inputSourceMap: sourceMap
      }]
    ]
  })
}

Credit where credit is due

babel-plugin-istanbul 中使用的方法受到 Thai Pangsakulyanont 的原始库 babel-plugin-__coverage__。