feat: support reporting AggregateErrors

lib/cli/run-option-metadata.js

@@ -49,7 +49,7 @@ const TYPES = (exports.types = {
     'sort',
     'watch'
   ],
-  number: ['retries', 'jobs'],
+  number: ['retries', 'jobs', 'jsonStringifyWhitespace'],
   string: [
     'config',
     'fgrep',
@@ -78,6 +78,7 @@ exports.aliases = {
   ignore: ['exclude'],
   invert: ['i'],
   jobs: ['j'],
+  jsonStringifyWhitespace: ['jsw'],
   'no-colors': ['C'],
   'node-option': ['n'],
   parallel: ['p'],

lib/reporters/base.js

@@ -246,6 +246,7 @@ exports.list = function (failures) {
     if (test.err && test.err.multiple) {
       if (multipleTest !== test) {
         multipleTest = test;
+
         multipleErr = [test.err].concat(test.err.multiple);
       }
       err = multipleErr.shift();
@@ -301,11 +302,37 @@ exports.list = function (failures) {
       }
       testTitle += str;
     });
-
     Base.consoleLog(fmt, i + 1, testTitle, msg, stack);
+
+    // Handles formatting and printing Aggregate errors
+    if (test.err.errors) {
+      for (const error of test.err.errors) {
+        const testTitle = addIndent(`Error ${error.message}`, 0);
+        const stack = addIndent(error.stack, 3);
+
+        Base.consoleLog(fmt, error.message, testTitle, '', stack);
+      }
+    }
   });
 };
 
+/**
+ * Adds indentation to a given text string.
+ *
+ * @param {string} text - The input text to be indented.
+ * @param {number} [level=1] - The number of levels of indentation. Default is 1.
+ * @param {string} [indentString='  '] - The string used for one level of indentation. Default is two spaces.
+ * @returns {string} The indented text.
+ */
+function addIndent(text, level = 1, indentString = '  ') {
+  const indent = indentString.repeat(level);
+  const indentedText = text
+    .split('\n')
+    .map(line => `${indent}${line}`)
+    .join('\n');
+  return indentedText;
+}
+
 /**
  * Constructs a new `Base` reporter instance.
  *
@@ -544,7 +571,6 @@ var objToString = Object.prototype.toString;
 function sameType(a, b) {
   return objToString.call(a) === objToString.call(b);
 }
-
 Base.consoleLog = consoleLog;
 
 Base.abstract = true;

lib/reporters/json.js

@@ -78,7 +78,7 @@ function JSONReporter(runner, options = {}) {
 
     runner.testResults = obj;
 
-    var json = JSON.stringify(obj, null, 2);
+    var json = JSON.stringify(obj, null, options.jsonStringifyWhitespace || 2);
     if (output) {
       try {
         fs.mkdirSync(path.dirname(output), {recursive: true});
@@ -153,6 +153,7 @@ function cleanCycles(obj) {
  */
 function errorJSON(err) {
   var res = {};
+
   Object.getOwnPropertyNames(err).forEach(function (key) {
     res[key] = err[key];
   }, err);

test/reporters/base.spec.js

@@ -507,21 +507,34 @@ describe('Base reporter', function () {
     );
   });
 
-  describe('when reporter output immune to user test changes', function () {
-    var baseConsoleLog;
+  it('should list all the errors within an AggregateError', function () {
+    var err1 = new Error('1');
+    var err2 = new Error('2');
+    var aggErr = new AggregateError([err1, err2], '2 errors');
 
-    beforeEach(function () {
-      sinon.restore();
-      sinon.stub(console, 'log');
-      baseConsoleLog = sinon.stub(Base, 'consoleLog');
-    });
+    var test = makeTest(aggErr);
+    list([test]);
 
-    it('should let you stub out console.log without effecting reporters output', function () {
-      Base.list([]);
-      baseConsoleLog.restore();
+    var errOut = stdout.join('\n').trim();
 
-      expect(baseConsoleLog, 'was called');
-      expect(console.log, 'was not called');
-    });
+    expect(errOut, 'to contain', '1) Error 1:', '2) Error 2:');
+  });
+});
+
+describe('when reporter output immune to user test changes', function () {
+  var baseConsoleLog;
+
+  beforeEach(function () {
+    sinon.restore();
+    sinon.stub(console, 'log');
+    baseConsoleLog = sinon.stub(Base, 'consoleLog');
+  });
+
+  it('should let you stub out console.log without effecting reporters output', function () {
+    Base.list([]);
+    baseConsoleLog.restore();
+
+    expect(baseConsoleLog, 'was called');
+    expect(console.log, 'was not called');
   });
 });