Mochaによるテスト実行時に複数のレポーターを使用する方法

Mochaによるテスト実行時に、複数のレポーターを使用する方法を紹介します。

パッケージをインストール

@mochajs/multi-reporterパッケージをインストールします。

$ npm i -D @mochajs/multi-reporter

Mochaの設定ファイルを更新

Mochaの設定ファイル（.mocharc.jsonなど）にreporterを追加し、@mochajs/multi-reporterを指定します。

.mocharc.json

{
  "reporter": "@mochajs/multi-reporter"
}

mochaコマンドの--reporterオプションで指定することもできます。

package.json

{
  "scripts": {
    "test": "mocha --reporter @mochajs/multi-reporter"
  }
}

@mochajs/multi-reporterの設定ファイルを作成

@mochajs/multi-reporterの設定ファイルとして、.reporters.jsonファイルを作成します。

.reporters.json

{
  "spec": true,
  "xunit": {
    "output": "report.xml"
  }
}

設定ファイルはオブジェクト形式で、キーにはレポーター名、値には有効フラグまたはレポーターオプションを指定します。
つまり上記の設定ファイルでは、specとxunitという2つのレポーターを使用し、かつxunitのレポーターオプションでoutputをreport.xmlにするという指定になっています。

テストを実行

あとは普通にテストを実行します。

$ npm test

上記の設定の場合、specによって標準出力にテスト結果が表示され、xunitによってreport.xmlファイルが生成されます。
こうすることで、ヒューマンリーダブルな形式で結果を表示しつつ、XMLファイルやJSONファイルを出力してプログラムで扱うといったことが可能になります。