util,console: colorize regexp groups, character classes, etc #59710

BridgeAR · 2025-09-01T19:49:25Z

This adds a parser to parse the regular expression and to highlight different parts of a regular expression in case colors are active.

It is a one time pass algorithm and should therefore not cause too much overhead during parsing.

As side effect, it is now possible to create individual styles to colorize inspected values values as a user likes. This might for example be expanded to numbers with numeric separators, highlighting the separators or decimal points different.

It would in theory also be possible to return a changed string. That is however not the intention for this API as it is only triggered in case colors are active.

I used a very fine granular differentiation to highlight all differences and to make sure key characters are visible fast.
I decided to handle it with a depth instead of fixed groups that define the color for the group. I think this is an improvement over the current implementation either way and we could still change it later, if it is deemed better to have fixed colors instead.

I know of one case that this is not showing correct: if a unicode property is seemingly started, while not being one without the u or v flag and it also containing a seemingly legitimate ending.

This adds a parser to parse the regular expression and to highlight different parts of a regular expression in case colors are active. It is a one time pass algorithm and should therefore not cause too much overhead during parsing. As side effect, it is now possible to create individual styles to colorize inspected values values as a user likes. This might for example be expanded to numbers with numeric separators, highlighting the separators or decimal points different. It would in theory also be possible to return a changed string. That is however not the intention for this API as it is only triggered in case colors are active.

BridgeAR · 2025-09-01T23:47:56Z

I marked this as semver major, no matter that we normally do not treat util.inspect changes as breaking.
I guess the styles change could be something that is somewhere expected to always be a string.

codecov · 2025-09-02T00:40:42Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.95%. Comparing base (f993fca) to head (88f87c3).
⚠️ Report is 177 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #59710      +/-   ##
==========================================
+ Coverage   89.88%   89.95%   +0.07%     
==========================================
  Files         656      667      +11     
  Lines      192947   197065    +4118     
  Branches    37841    38483     +642     
==========================================
+ Hits       173427   177274    +3847     
- Misses      12054    12198     +144     
- Partials     7466     7593     +127

Files with missing lines	Coverage Δ
lib/internal/util/inspect.js	`99.96% <100.00%> (+0.08%)`	⬆️

... and 146 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

benjamingr

As mentioned in private it would probably be less code to use the ast parser on the regexp instead of parsing it on our own - but since this is coloring and this provides nice and helpful ux for inspect users (pretty much everyone) I'm fine with my current concerns and still a strong +1 on this

nodejs-github-bot · 2025-09-03T13:00:22Z

CI: https://ci.nodejs.org/job/node-test-pull-request/69028/

BridgeAR · 2025-09-03T13:02:59Z

@nodejs/tsc PTAL due to this being a semver major in my opinion.

BridgeAR · 2025-09-03T13:34:39Z

CITGM https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/3631/

mcollina

lgtm

nodejs-github-bot · 2025-09-03T21:39:00Z

CI: https://ci.nodejs.org/job/node-test-pull-request/69039/

BridgeAR · 2025-09-03T22:11:30Z

I could not see any related failures in CITGM

BridgeAR · 2025-09-04T11:50:06Z

@mcollina @benjamingr @RafaelGSS @marco-ippolito PTAL. I need a reconfirmation for the latest changes (I hope the changes work for without-Intl builds. I didn't test it locally).

nodejs-github-bot · 2025-09-04T13:17:02Z

CI: https://ci.nodejs.org/job/node-test-pull-request/69052/

nodejs-github-bot · 2025-09-04T16:45:25Z

CI: https://ci.nodejs.org/job/node-test-pull-request/69059/

nodejs-github-bot · 2025-09-04T23:29:45Z

CI: https://ci.nodejs.org/job/node-test-pull-request/69061/

nodejs-github-bot · 2025-09-05T13:08:14Z

CI: https://ci.nodejs.org/job/node-test-pull-request/69072/

nodejs-github-bot · 2025-09-05T14:29:23Z

Landed in fdef072

assert: * (SEMVER-MAJOR) move assert.fail with multiple arguments to eol (James M Snell) #58532 * (SEMVER-MAJOR) move CallTracker to EOL (James M Snell) #58006 assert,util: * (SEMVER-MAJOR) fail promise comparison in deep equal checks (Ruben Bridgewater) #59448 * (SEMVER-MAJOR) handle invalid dates as equal in deep comparison (Ruben Bridgewater) #57627 async_hooks: * (SEMVER-MAJOR) move `asyncResource` property on bound function to EOL (James M Snell) #58618 buffer: * (SEMVER-MAJOR) move SlowBuffer to EOL (Filip Skokan) #58220 build: * (SEMVER-MAJOR) bump minimum Clang version to 19 (Michaël Zasso) #59048 * (SEMVER-MAJOR) reset embedder string to "-node.0" (Michaël Zasso) #58064 * (SEMVER-MAJOR) stop distributing Corepack (Antoine du Hamel) #57617 child_process: * (SEMVER-MAJOR) move _channel to end-of-life (James M Snell) #58527 crypto: * (SEMVER-MAJOR) runtime-deprecate default shake128/256 output lengths (Filip Skokan) #59008 * (SEMVER-MAJOR) move deprecated hash and mgf1Hash options to EOL (James M Snell) #58706 * (SEMVER-MAJOR) runtime deprecate ECDH.setPublicKey() (James M Snell) #58620 deps: * (SEMVER-MAJOR) V8: backport 1d3362c55396 (Shu-yu Guo) #58064 * (SEMVER-MAJOR) V8: cherry-pick 4f38995c8295 (Shu-yu Guo) #58064 * (SEMVER-MAJOR) V8: cherry-pick 044b9b6f589d (Rezvan Mahdavi Hezaveh) #58064 * (SEMVER-MAJOR) V8: cherry-pick d2ad518a0b57 (Joyee Cheung) #58064 * (SEMVER-MAJOR) V8: revert 6d6c1e680c7b (Michaël Zasso) #58064 * (SEMVER-MAJOR) V8: revert e3cddbedb205 (Michaël Zasso) #58064 * (SEMVER-MAJOR) use std::map in MSVC STL for EphemeronRememberedSet (Joyee Cheung) #58064 * (SEMVER-MAJOR) patch V8 for illumos (Dan McDonald) #58064 * (SEMVER-MAJOR) remove problematic comment from v8-internal (Michaël Zasso) #58064 * (SEMVER-MAJOR) define V8_PRESERVE_MOST as no-op on Windows (Stefan Stojanovic) #58064 * (SEMVER-MAJOR) fix FP16 bitcasts.h (Stefan Stojanovic) #58064 * (SEMVER-MAJOR) patch V8 to avoid duplicated zlib symbol (Michaël Zasso) #58064 * (SEMVER-MAJOR) update V8 to 13.7.152.9 (Michaël Zasso) #58064 dgram: * (SEMVER-MAJOR) move deprecated APIs to EOL (James M Snell) #58474 dns: * (SEMVER-MAJOR) move falsy hostname in lookup to end-of-life (James M Snell) #58619 fs: * (SEMVER-MAJOR) move FileHandle close on GC to EOL (James M Snell) #58536 * (SEMVER-MAJOR) move rmdir recursive option to end-of-life (James M Snell) #58616 * (SEMVER-MAJOR) make `processReadResult()` and `readSyncRecursive()` private (Livia Medeiros) #58672 * (SEMVER-MAJOR) move fs stream open method to eol (James M Snell) #58529 * (SEMVER-MAJOR) remove `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, `fs.X_OK` (Livia Medeiros) #55862 http: * (SEMVER-MAJOR) deprecate writeHeader (Sebastian Beltran) #59060 lib: * (SEMVER-MAJOR) expose global ErrorEvent (Richie Bendall) #58920 * (SEMVER-MAJOR) deprecate `_stream_*` modules (Dario Piotrowicz) #58337 * (SEMVER-MAJOR) deprecate _tls_common and _tls_wrap (Dario Piotrowicz) #57643 module: * (SEMVER-MAJOR) move Module._debug to end-of-life (James M Snell) #58473 node-api: * (SEMVER-MAJOR) add warning for NAPI_EXPERIMENTAL (Miguel Marcondes Filho) #58280 perf_hooks: * (SEMVER-MAJOR) move deprecated accessors to EOF (James M Snell) #58531 process: * (SEMVER-MAJOR) move multipleResolves event to EOL (James M Snell) #58707 repl: * (SEMVER-MAJOR) eol deprecate instantiating without new (Aviv Keller) #59495 src: * (SEMVER-MAJOR) store `Local` for `CallbackScope` on stack (Anna Henningsen) #59705 * (SEMVER-MAJOR) remove node.h APIs to make callback without an async context (Chengzhong Wu) #58471 * (SEMVER-MAJOR) remove deprecated node::EmitBeforeExit and node::EmitExit (Chengzhong Wu) #58469 * (SEMVER-MAJOR) remove deprecated node::CreatePlatform and node::FreePlatform (Chengzhong Wu) #58470 * (SEMVER-MAJOR) remove deprecated node::InitializeNodeWithArgs (Chengzhong Wu) #58470 * (SEMVER-MAJOR) update NODE_MODULE_VERSION to 138 (Michaël Zasso) #58064 src,permission: * (SEMVER-MAJOR) add --allow-net permission (Rafael Gonzaga) #58517 tls: * (SEMVER-MAJOR) move IP-address servername deprecation to eol (James M Snell) #58533 tools: * (SEMVER-MAJOR) update V8 gypfiles for 13.7 (Michaël Zasso) #58064 url: * (SEMVER-MAJOR) move bad port deprecation in legacy url to end-of-life (James M Snell) #58617 util,console: * (SEMVER-MAJOR) colorize regexp groups, character classes, etc (Ruben Bridgewater) #59710 worker: * (SEMVER-MAJOR) move terminate callback to end-of-life (James M Snell) #58528 PR-URL: #59896

assert: * (SEMVER-MAJOR) move assert.fail with multiple arguments to eol (James M Snell) #58532 * (SEMVER-MAJOR) move CallTracker to EOL (James M Snell) #58006 assert,util: * (SEMVER-MAJOR) fail promise comparison in deep equal checks (Ruben Bridgewater) #59448 * (SEMVER-MAJOR) handle invalid dates as equal in deep comparison (Ruben Bridgewater) #57627 async_hooks: * (SEMVER-MAJOR) move `asyncResource` property on bound function to EOL (James M Snell) #58618 buffer: * (SEMVER-MAJOR) move SlowBuffer to EOL (Filip Skokan) #58220 build: * (SEMVER-MAJOR) bump minimum Clang version to 19 (Michaël Zasso) #59048 * (SEMVER-MAJOR) reset embedder string to "-node.0" (Michaël Zasso) #58064 * (SEMVER-MAJOR) stop distributing Corepack (Antoine du Hamel) #57617 child_process: * (SEMVER-MAJOR) move _channel to end-of-life (James M Snell) #58527 crypto: * (SEMVER-MAJOR) runtime-deprecate default shake128/256 output lengths (Filip Skokan) #59008 * (SEMVER-MAJOR) move deprecated hash and mgf1Hash options to EOL (James M Snell) #58706 * (SEMVER-MAJOR) runtime deprecate ECDH.setPublicKey() (James M Snell) #58620 deps: * (SEMVER-MAJOR) V8: backport 1d3362c55396 (Shu-yu Guo) #58064 * (SEMVER-MAJOR) V8: cherry-pick 4f38995c8295 (Shu-yu Guo) #58064 * (SEMVER-MAJOR) V8: cherry-pick 044b9b6f589d (Rezvan Mahdavi Hezaveh) #58064 * (SEMVER-MAJOR) V8: cherry-pick d2ad518a0b57 (Joyee Cheung) #58064 * (SEMVER-MAJOR) V8: revert 6d6c1e680c7b (Michaël Zasso) #58064 * (SEMVER-MAJOR) V8: revert e3cddbedb205 (Michaël Zasso) #58064 * (SEMVER-MAJOR) use std::map in MSVC STL for EphemeronRememberedSet (Joyee Cheung) #58064 * (SEMVER-MAJOR) patch V8 for illumos (Dan McDonald) #58064 * (SEMVER-MAJOR) remove problematic comment from v8-internal (Michaël Zasso) #58064 * (SEMVER-MAJOR) define V8_PRESERVE_MOST as no-op on Windows (Stefan Stojanovic) #58064 * (SEMVER-MAJOR) fix FP16 bitcasts.h (Stefan Stojanovic) #58064 * (SEMVER-MAJOR) patch V8 to avoid duplicated zlib symbol (Michaël Zasso) #58064 * (SEMVER-MAJOR) update V8 to 13.7.152.9 (Michaël Zasso) #58064 dgram: * (SEMVER-MAJOR) move deprecated APIs to EOL (James M Snell) #58474 dns: * (SEMVER-MAJOR) move falsy hostname in lookup to end-of-life (James M Snell) #58619 fs: * (SEMVER-MAJOR) move FileHandle close on GC to EOL (James M Snell) #58536 * (SEMVER-MAJOR) move rmdir recursive option to end-of-life (James M Snell) #58616 * (SEMVER-MAJOR) make `processReadResult()` and `readSyncRecursive()` private (Livia Medeiros) #58672 * (SEMVER-MAJOR) move fs stream open method to eol (James M Snell) #58529 * (SEMVER-MAJOR) remove `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, `fs.X_OK` (Livia Medeiros) #55862 http: * (SEMVER-MAJOR) deprecate writeHeader (Sebastian Beltran) #59060 lib: * (SEMVER-MAJOR) expose global ErrorEvent (Richie Bendall) #58920 * (SEMVER-MAJOR) deprecate `_stream_*` modules (Dario Piotrowicz) #58337 * (SEMVER-MAJOR) deprecate _tls_common and _tls_wrap (Dario Piotrowicz) #57643 module: * (SEMVER-MAJOR) move Module._debug to end-of-life (James M Snell) #58473 node-api: * (SEMVER-MAJOR) add warning for NAPI_EXPERIMENTAL (Miguel Marcondes Filho) #58280 perf_hooks: * (SEMVER-MAJOR) move deprecated accessors to EOF (James M Snell) #58531 process: * (SEMVER-MAJOR) move multipleResolves event to EOL (James M Snell) #58707 repl: * (SEMVER-MAJOR) eol deprecate instantiating without new (Aviv Keller) #59495 src: * (SEMVER-MAJOR) store `Local` for `CallbackScope` on stack (Anna Henningsen) #59705 * (SEMVER-MAJOR) remove node.h APIs to make callback without an async context (Chengzhong Wu) #58471 * (SEMVER-MAJOR) remove deprecated node::EmitBeforeExit and node::EmitExit (Chengzhong Wu) #58469 * (SEMVER-MAJOR) remove deprecated node::CreatePlatform and node::FreePlatform (Chengzhong Wu) #58470 * (SEMVER-MAJOR) remove deprecated node::InitializeNodeWithArgs (Chengzhong Wu) #58470 * (SEMVER-MAJOR) update NODE_MODULE_VERSION to 138 (Michaël Zasso) #58064 src,permission: * (SEMVER-MAJOR) add --allow-net permission (Rafael Gonzaga) #58517 tls: * (SEMVER-MAJOR) move IP-address servername deprecation to eol (James M Snell) #58533 tools: * (SEMVER-MAJOR) update V8 gypfiles for 13.7 (Michaël Zasso) #58064 url: * (SEMVER-MAJOR) move bad port deprecation in legacy url to end-of-life (James M Snell) #58617 util,console: * (SEMVER-MAJOR) colorize regexp groups, character classes, etc (Ruben Bridgewater) #59710 worker: * (SEMVER-MAJOR) move terminate callback to end-of-life (James M Snell) #58528 PR-URL: #59896 Signed-off-by: RafaelGSS <rafael.nunu@hotmail.com>

BridgeAR added util Issues and PRs related to the built-in util module. console Issues and PRs related to the console subsystem. labels Sep 1, 2025

nodejs-github-bot added the needs-ci PRs that need a full CI run. label Sep 1, 2025

fixup!

7c528bc

BridgeAR marked this pull request as ready for review September 1, 2025 23:45

BridgeAR added the semver-major PRs that contain breaking changes and should be released in the next major version. label Sep 1, 2025

BridgeAR added 4 commits September 2, 2025 11:07

fixup!

0d7143a

fixup!

6f0a303

fixup!

d041b14

fixup!

5edbd0f

benjamingr approved these changes Sep 2, 2025

View reviewed changes

BridgeAR added 2 commits September 2, 2025 13:49

fixup! please linter

0d04c93

fixup!

d727cf5

benjamingr approved these changes Sep 3, 2025

View reviewed changes

BridgeAR added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 3, 2025

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 3, 2025

BridgeAR added the needs-citgm PRs that need a CITGM CI run. label Sep 3, 2025

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 3, 2025

marco-ippolito approved these changes Sep 3, 2025

View reviewed changes

mcollina approved these changes Sep 3, 2025

View reviewed changes

RafaelGSS approved these changes Sep 3, 2025

View reviewed changes

BridgeAR added 2 commits September 4, 2025 01:20

fixup! saveguard against without intl and more robust implementation

e013bf2

fixup! please linter

a16eb71

RafaelGSS approved these changes Sep 4, 2025

View reviewed changes

BridgeAR added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 4, 2025

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 4, 2025

fixup! fix intl check

88f87c3

ljharb approved these changes Sep 4, 2025

View reviewed changes

BridgeAR added the request-ci Add this label to start a Jenkins CI on a PR. label Sep 4, 2025

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Sep 4, 2025

BridgeAR added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Sep 5, 2025

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 5, 2025

nodejs-github-bot merged commit fdef072 into nodejs:main Sep 5, 2025
64 checks passed

RafaelGSS mentioned this pull request Sep 15, 2025

2025-10-15, Version 25.0.0 (Current) #59896

Open

8 tasks

Uh oh!

util,console: colorize regexp groups, character classes, etc #59710

util,console: colorize regexp groups, character classes, etc #59710

Uh oh!

Conversation

BridgeAR commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

BridgeAR commented Sep 1, 2025

Uh oh!

codecov bot commented Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

benjamingr left a comment

Choose a reason for hiding this comment

Uh oh!

nodejs-github-bot commented Sep 3, 2025

Uh oh!

BridgeAR commented Sep 3, 2025

Uh oh!

BridgeAR commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

nodejs-github-bot commented Sep 3, 2025

Uh oh!

BridgeAR commented Sep 3, 2025

Uh oh!

BridgeAR commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nodejs-github-bot commented Sep 4, 2025

Uh oh!

nodejs-github-bot commented Sep 4, 2025

Uh oh!

nodejs-github-bot commented Sep 4, 2025

Uh oh!

nodejs-github-bot commented Sep 5, 2025

Uh oh!

Uh oh!

nodejs-github-bot commented Sep 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

BridgeAR commented Sep 1, 2025 •

edited

Loading

codecov bot commented Sep 2, 2025 •

edited

Loading

BridgeAR commented Sep 3, 2025 •

edited

Loading

BridgeAR commented Sep 4, 2025 •

edited

Loading