Node.js项目中Istanbul与Mocha报错“Reference Error: suite is not defined”

这个错误很常见，原因其实很简单：suite是MochaTDD接口提供的全局函数，当你用Istanbul运行测试时，没有正确告诉Mocha要使用TDD模式，导致它默认启用了BDD接口，自然识别不了suite啦。

下面给你几个可行的解决办法：

方法1：直接在命令行传递Mocha参数给Istanbul #

你单独运行_mocha时指定了-u tdd参数，但用Istanbul时需要把Mocha的参数放在--后面，用来区分Istanbul自身的参数和要传递给Mocha的参数。试试这条命令：

istanbul cover _mocha -- -u tdd -R spec qa/tdd_Person.js

同样，BDD模式的覆盖率测试可以这么跑：

istanbul cover _mocha -- -u bdd -R spec qa/bdd_Person.js

这里的--是关键，它会让Istanbul把后面的所有参数原封不动传给Mocha，这样Mocha就知道要启用TDD接口，suite也就被正确定义了。

方法2：在package.json中配置scripts（更推荐） #

每次敲长命令太麻烦，你可以在项目的package.json里添加测试和覆盖率的脚本，以后直接用npm命令运行就行：

{
  "scripts": {
    "test:tdd": "./node_modules/.bin/_mocha -u tdd -R spec qa/tdd_Person.js",
    "test:bdd": "./node_modules/.bin/_mocha -u bdd -R spec qa/bdd_Person.js",
    "coverage:tdd": "istanbul cover _mocha -- -u tdd -R spec qa/tdd_Person.js",
    "coverage:bdd": "istanbul cover _mocha -- -u bdd -R spec qa/bdd_Person.js"
  }
}

配置好后，运行TDD的覆盖率测试只需敲：

npm run coverage:tdd

这样不仅方便，还能把命令统一管理，团队协作时也更清晰。

额外注意事项 #

• 如果你的项目里全局安装了Mocha和Istanbul，也可以去掉./node_modules/.bin/前缀，直接用mocha或istanbul命令，但推荐用本地安装的版本，避免环境差异。
• 确保你的Istanbul和Mocha版本兼容，比如一些较新的Mocha版本可能需要调整命令（比如用mocha代替_mocha），如果遇到问题可以试试替换成istanbul cover mocha -- ...。
• 如果有多个TDD风格的测试文件，你可以直接指定目录，比如istanbul cover _mocha -- -u tdd -R spec qa/，这样会自动运行qa目录下所有符合条件的测试文件。

内容的提问来源于stack exchange，提问作者Andrew S