Document potential issue with mocha JSON reporter

liu-shaojun · Mar 31, 2021 · 0e5d21a · 0e5d21a
1 parent ee12681
commit 0e5d21a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -286,6 +286,10 @@ You can use following example configuration in `package.json`:
   "test": "mocha --reporter json > test-results.json"
 }
 ```
+
+Test processing might fail if any of your tests writes anything on standard output.
+Mocha unfortunately doesn't have option to store `json` output directly to file and we have to rely on redirecting its standard output.
+There is a work in progress to fix it: [mocha#4607](https://github.com/mochajs/mocha/pull/4607)
 </details>
 
 ## GitHub limitations