spec-reporter prints retries

[CheadleCheadle]

PR Checklist

• Addresses an existing open issue: fixes Should the spec reporter report retries? #5014
• That issue was marked as status: accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

I've implemented a function called logRetries() which displays the number of the current retry along with the total number of retries, provided that the total number of retries is greater than zero. This output is formatted below the test title and highlighted in yellow as requested for ecosystem consistency. I would greatly appreciate any feedback on this addition!
Example:

[coveralls]

coverage: 94.346% (+0.01%) from 94.335%
when pulling b5d4d68 on CheadleCheadle:spec-reporter-retries
into b88978d on mochajs:master.

[JoshuaKGoldberg]

Hello again! 😄

Left some thoughts - I'm excited to see this come in!

[CheadleCheadle]

Refactored to include retry on same line(retry x1).

[JoshuaKGoldberg]

Wasn't sure if you're ready to re-request review, but just in case 🙂

[voxpelli]

Some feedback on the implementation.

On top of that: The bin/mocha.js has an unrelated permission change.

[voxpelli]

I would opt for something like this instead, to keep in the style of the others:

  runner.on(EVENT_TEST_PASS, function (test) {
    var fmt =
      indent() +
      color('checkmark', '  ' + Base.symbols.ok) +
      color('pass', ' %s');
    var fmtVars = [test.title];

    if (test.speed !== 'fast') {
      fmt += color(test.speed, ' (%dms)');
      fmtVars.push(test.duration);
    }

    if (test._currentRetry > 0) {
      fmt += color('bright yellow', ' (retry x%d)');
      fmtVars.push(test._currentRetry);
    }

    Base.consoleLog.apply(Base, [fmt].concat(fmtVars));
  });

[voxpelli]

To really stick with the theme I think we should add a 'retries' color here:

mocha/lib/reporters/base.js

Lines 64 to 90 in 24560c1

	/**
	* Default color map.
	*/
	exports.colors = {
	pass: 90,
	fail: 31,
	'bright pass': 92,
	'bright fail': 91,
	'bright yellow': 93,
	pending: 36,
	suite: 0,
	'error title': 0,
	'error message': 31,
	'error stack': 90,
	checkmark: 32,
	fast: 90,
	medium: 33,
	slow: 31,
	green: 32,
	light: 90,
	'diff gutter': 90,
	'diff added': 32,
	'diff removed': 31,
	'diff added inline': '30;42',
	'diff removed inline': '30;41'
	};

And possibly stick even more with the style of eg. durations and resolve to the color in base.js:

mocha/lib/reporters/base.js

Lines 369 to 377 in 24560c1

	runner.on(EVENT_TEST_PASS, function (test) {
	if (test.duration > test.slow()) {
	test.speed = 'slow';
	} else if (test.duration > test.slow() / 2) {
	test.speed = 'medium';
	} else {
	test.speed = 'fast';
	}
	});

And maybe do a similar style and have two levels: 'some retries' / 'many retries' With only the latter resolving to bright yellow

[voxpelli]

The underscore in _currentRetry is an old-school practice for indicating that its a private property, so we shouldn't rely on it here I think as its not intended for outside consumption.

If we want it to be exposed we should make it an explicit public property, like duration, and probably name it retries or retryCount or such

We should use the public .currentRetry() instead.