🚀 Feature: Should the spec reporter report retries?

[lilnasy]

Prerequisites

• Checked that your issue hasn't already been filed by cross-referencing issues with the faq label
• Checked next-gen ES issues and syntax problems by using the same environment and/or transpiler configuration without Mocha to ensure it isn't just a feature that actually isn't supported in the environment in question or a bug in your code.
• 'Smoke tested' the code to be tested by running it outside the real test suite to get a better sense of whether the problem is in the code under test, your usage of Mocha, or Mocha itself
• Ensured that there is no discrepancy between the locally and globally installed versions of Mocha. You can find them with: node_modules/.bin/mocha --version(Local) and mocha --version(Global). We recommend that you not install Mocha globally.

Description

We have a few flaky tests and we would like to be aware of them. Currently, the spec reporter does not make a distinction between a test that succeeded first try and one that needed to be retried. We are probably going to create a custom reporter that extends Mocha.reporters.Spec to report the flaky tests at the end, but if it can be upstreamed, that would be ideal.

If the idea has good reception with mocha maintainers, I could try making a PR.

[JoshuaKGoldberg]

I think this is a good idea. Vitest already does this with a yellow (retry x${task.result.retryCount}) (vitest-dev/vitest#1929). Unless anybody has an alternate suggestion, I'd say we can go with that for ecosystem consistency.

The spec reporter is meant for human consumption, so adding extra info like a retry count shouldn't hurt... but just to be safe, I think we should consider this a breaking change. You never know when someone's parsing spec reporter output instead of the JSON reporter for some bizarre reason. [Relevant xkcd "workflow" comic]