使用 rewire / cross-env 获取覆盖率报告时出错

Question

我正在尝试使用 nyc 获取覆盖率报告，如果我不使用 cross-env 插件，它会很好用。

cross-env NODE_ENV=test nyc mocha --ui bdd --reporter spec --colors --require babel-core/register tests --recursive

执行此命令代码覆盖率不会运行正确，结果如下：

 31 passing (1s)

----------|----------|----------|----------|----------|-------------------|
File      |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
----------|----------|----------|----------|----------|-------------------|
All files |        0 |        0 |        0 |        0 |                   |
----------|----------|----------|----------|----------|-------------------|

但是，如果我运行这个 nyc mocha --ui bdd --reporter spec --colors --require babel-core/register tests --recursive 它会按预期工作。

---------------------|----------|----------|----------|----------|-------------------|
File                 |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
---------------------|----------|----------|----------|----------|-------------------|
All files            |    79.45 |    64.29 |    35.71 |    84.62 |                   |
 constants           |      100 |      100 |      100 |      100 |                   |
  index.js           |      100 |      100 |      100 |      100 |                   |
 db                  |    77.05 |    64.29 |    33.33 |    83.02 |                   |
---------------------|----------|----------|----------|----------|-------------------|

问题是我需要设置 env 变量才能使用允许我正确运行测试的 rewire 插件（事实上，大多数测试都因此失败）。

这是我的.bebelrc

{
  "presets": ["es2015"],
  "env": {
    "test": {
      "plugins": ["istanbul", "babel-plugin-rewire"]
    }
  }
}

注意：我认为这个问题与babel-plugin-rewire有关。事实上，即使删除 cross-env 并将插件集合放在根目录中也会给我相同的空覆盖结果。

Answer 1

我在 babel 配置文件和插件中找到了解决这个问题的方法。为避免这种情况，最好使用最后一个环境预设。我也 created a repo 重现了错误，并且有一个类似于 post.

的自述文件

与rewire/cross-env

运行使用默认命令（使用 rewire 和 cross-env）的测试将生成一个空的覆盖率报告：

npm run test

此命令将只执行测试，并且它们都将通过

npm run test:cov

这将执行之前的 test 脚本，但会添加覆盖率报告，结果为空

----------|----------|----------|----------|----------|-------------------|
File      |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
----------|----------|----------|----------|----------|-------------------|
All files |        0 |        0 |        0 |        0 |                   |
----------|----------|----------|----------|----------|-------------------|

没有rewire/cross-env

从测试脚本中删除 cross-env NODE_ENV=test 将避免加载重新布线并生成正确的覆盖率。副作用是使用重新布线的测试将失败。

npm run test2

将运行没有 cross-env 的脚本，因此 babel 将不会加载 rewire 插件，因此一项测试将失败。

npm run test:cov2

此命令将使用之前的 test2 脚本并生成覆盖。在这种情况下，将正确生成覆盖率报告。

------------------|----------|----------|----------|----------|-------------------|
File              |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
------------------|----------|----------|----------|----------|-------------------|
All files         |    64.29 |      100 |    54.55 |    66.67 |                   |
 src              |       75 |      100 |       60 |    85.71 |                   |
  a-dependency.js |      100 |      100 |      100 |      100 |                   |
  a-module.js     |       60 |      100 |        0 |       75 |                 6 |
 tests            |       60 |      100 |       50 |       60 |                   |
  test.js         |       60 |      100 |       50 |       60 |... 23,24,26,27,28 |
------------------|----------|----------|----------|----------|-------------------|

但由于缺少 rewire 插件而不正确。

babelrc (es2015)

{
  "presets": ["es2015"],
  "env": {
    "test": {
      "plugins": ["istanbul", "rewire"]
    }
  }
}

这是方案中使用的babel配置文件。从插件集合中删除 rewire 插件将生成并清空 npm run test:cov 的覆盖范围，但不会使用 npm run test:cov2（未使用 cross-env）。

如果我这样修改babelrc

{
  "presets": ["es2015"],
  "plugins": ["istanbul", "rewire"]
}

npm run test:cov（有cross-env）和npm run test:cov2（没有cross-env）。将生成一个空结果。

如果我删除两个插件

{
  "presets": ["es2015"]
}

两个命令（有和没有 cross-env）都会生成一个覆盖率结果（部分，因为一个测试会失败）

从插件集合中仅删除 istanbul 将生成一个完整的覆盖文件，这就是结果（如预期的那样）

------------------|----------|----------|----------|----------|-------------------|
File              |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
------------------|----------|----------|----------|----------|-------------------|
All files         |      100 |      100 |      100 |      100 |                   |
 src              |      100 |      100 |      100 |      100 |                   |
  a-dependency.js |      100 |      100 |      100 |      100 |                   |
  a-module.js     |      100 |      100 |      100 |      100 |                   |
 tests            |      100 |      100 |      100 |      100 |                   |
  test.js         |      100 |      100 |      100 |      100 |                   |
------------------|----------|----------|----------|----------|-------------------|

babelrc（环境）

在围绕之前的 es2015 预设解决了这个问题后，我转向了 env 预设。使用 npm install babel-preset-env --save-dev 安装它，然后我以这种方式修改了我的 babelrc。

{
  "presets": [
    ["env", {
      "targets": {
        "node": "current"
      }
    }]
  ],
  "env": {
    "test": {
      "plugins": ["istanbul", "rewire"]
    }
  }
}

在这种情况下 npm run test 可以正常工作并且 npm run test:cov 将生成正确的覆盖率报告。 cross-end 或 rewire 都不会有问题。

结论

如果在使用 es2015 预设时与 babel 结合使用，rewire 和 cross-env 都会产生问题。要使用此预设生成报告，显然足以从 babel 插件中删除 istanbul 并仅使用 rewire（在这种情况下，它也适用于 cross-env）。

我宁愿建议升级到 env 预设并按照建议使用 babel 插件（除非它会给您的项目带来其他问题）

环境

> node --version
v9.4.0
> npm --version
5.6.0
>ver
Microsoft Windows [Version 10.0.16299.309]

在 MacOS 上观察到相同的行为

使用 rewire / cross-env 获取覆盖率报告时出错

Error getting the coverage report with rewire / cross-env

javascript

mocha.js

node.js

istanbul

nyc

与rewire/cross-env

没有rewire/cross-env

babelrc (es2015)

babelrc（环境）

结论

环境