test_runner: allow user-defined color themes via NODE_TEST_RUNNER_THEME

[elvessilvavieira]

This PR addresses #58937 by introducing support for user-defined color customization in the test runner output.

Users can now configure the theme colors by setting the NODE_TEST_RUNNER_THEME environment variable with a JSON string.

I followed the current implementation style by using the colors already defined in internal/util/colors. While the issue raises a concern about color contrast, I preferred to stick with the existing set of colors to maintain consistency. I simply chose to allow color overrides instead of changing how shouldColorize or the color system itself behaves.

I’d appreciate feedback on whether this was the right approach. Thx

NODE_TEST_RUNNER_THEME='{"fail":"blue","pass":"yellow","info":"red","base":"red","duration":"green","skip":"blue"}

[nodejs-github-bot]

Review requested:

• @nodejs/test_runner

[pmarchini]

Hey @elvessilvavieira, thanks for the contribution!

Honestly, I don't think we should go down this road for the following reasons:

1. We usually pass options via flags instead of env vars, and I don't think this case should break the standard.
2. I don't like the idea of passing a JSON string via an option.

A user can just decide to use a custom reporter if they want a different output style.
The pain point I see is specifically related to the coverage report because, as far as I recall, it doesn't allow any kind of customization via reporter.

I still see value in what you're proposing, and I'm wondering if it could make sense to have a method like https://nodejs.org/api/test.html#assertregistername-fn that allows the user to configure its preferences.

WDYT?

[elvessilvavieira]

Thanks a lot @pmarchini for the feedback

So, following your suggestion and the assert.register approach. Do you recommend something like this?

import { configureTheme } from 'node:test';

configureTheme({
  info: 'blue',
  pass: 'green',
});
 

[pmarchini]

I'm not 100% sure about the function name, but yes, I was thinking about a similar API! 🚀

[elvessilvavieira]

I'm not 100% sure about the function name, but yes, I was thinking about a similar API! 🚀

Thanks again. I'll implement it

[MoLow]

FWIW I am -1, I think this use case doesn't really justify support in core and it can be solved with a custom reporter
not blocking tough since I am just trying to get back from a long time off from the project

[github-actions]

This pull request has been marked as stale due to 210 days of inactivity.
It will be automatically closed in 30 days if no further activity occurs. If this is still relevant, please leave a comment or update it to keep it open.