util: add more predefined color codes to inspect.colors #30659

BridgeAR · 2019-11-26T14:40:38Z

commit: util: improve inspect's customInspect performance

This improves the performance to copy user options that are then
passed through to the custom inspect function.

The performance improvement depends on the complexity of the custom
inspect function. For very basic cases this is 100% faster than
before.

commit: util: add more predefined color codes to inspect.colors

This adds most commonly used ANSI color codes to
`util.inspect.colors`.

@nodejs/util PTAL

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

This improves the performance to copy user options that are then passed through to the custom inspect function. The performance improvement depends on the complexity of the custom inspect function. For very basic cases this is 100% faster than before.

This adds most commonly used ANSI color codes to `util.inspect.colors`.

doc/api/util.md

Trott · 2019-11-26T14:51:35Z

I'd consider adding more colors that we support to be semver-minor. Once we add it, we'll risk breaking people's stuff if we ever take it away.

Not strongly opposed (at least at this moment), but wondering if we might want to leave robust color support to userland modules and just support the relatively small number of colors we already support. Is there a justification for these colors in particular over the colors that we already have?

BridgeAR · 2019-11-26T15:00:04Z

@Trott I actually already have follow-up pull requests that add further "robust" color support to Node.js.

This is just a first step in that direction. I recently had another PR open (#29676) where I needed a color code that we did not yet have in our predefined ones. We also need more APIs to properly handle colors internally. Otherwise it's not possible to add colors in Node.js core and that is something I try to slowly move forward.

nodejs-github-bot · 2019-11-26T17:41:40Z

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

devsnek · 2019-12-02T18:38:50Z

lib/internal/util/inspect.js

+  });
+}
+
+defineColorAlias('gray', 'grey');


grey/gray seem motivated, but why are the rest of these here?

Mainly due to different descriptions depending on where these ANSI codes are described. I have no strong opinion on either of these names. I thought it does not hurt to allow different aliases so people could use what ever they feel most comfortable with. The camel case and all lower cased versions are just there to prevent typos.

nodejs-github-bot · 2019-12-02T19:57:08Z

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

BridgeAR · 2019-12-03T17:09:38Z

@nodejs/util this could use another review :)

BridgeAR · 2019-12-06T00:29:33Z

@nodejs/util @nodejs/repl @devsnek @Trott I would like to land this soon. I have multiple PRs that need more color support.

I'll land this if there's no objection in the next 24 hours.

lib/internal/util/inspect.js

antsmartian

LGTM

nodejs-github-bot · 2019-12-06T21:49:39Z

CI: https://ci.nodejs.org/job/node-test-pull-request/27420/ ✔️

This improves the performance to copy user options that are then passed through to the custom inspect function. The performance improvement depends on the complexity of the custom inspect function. For very basic cases this is 100% faster than before. PR-URL: #30659 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>

This adds most commonly used ANSI color codes to `util.inspect.colors`. PR-URL: #30659 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>

BridgeAR · 2019-12-06T23:36:45Z

Landed in 2a0ec9c, 832290a 🎉

This improves the performance to copy user options that are then passed through to the custom inspect function. The performance improvement depends on the complexity of the custom inspect function. For very basic cases this is 100% faster than before. PR-URL: #30659 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>

This adds most commonly used ANSI color codes to `util.inspect.colors`. PR-URL: #30659 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>

This improves the performance to copy user options that are then passed through to the custom inspect function. The performance improvement depends on the complexity of the custom inspect function. For very basic cases this is 100% faster than before. PR-URL: #30659 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>

This adds most commonly used ANSI color codes to `util.inspect.colors`. PR-URL: #30659 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>

This improves the performance to copy user options that are then passed through to the custom inspect function. The performance improvement depends on the complexity of the custom inspect function. For very basic cases this is 100% faster than before. PR-URL: #30659 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>

This adds most commonly used ANSI color codes to `util.inspect.colors`. PR-URL: #30659 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>

BridgeAR added 2 commits November 26, 2019 15:32

util: add more predefined color codes to inspect.colors

de5d3a5

This adds most commonly used ANSI color codes to `util.inspect.colors`.

nodejs-github-bot added the util Issues and PRs related to the built-in util module. label Nov 26, 2019

This comment has been minimized.

Sign in to view

Trott reviewed Nov 26, 2019

View reviewed changes

doc/api/util.md Outdated Show resolved Hide resolved

Trott added the semver-minor PRs that contain new features and should be released in the next minor version. label Nov 26, 2019

fixup: util: add more predefined color codes to inspect.colors

6d6b860

This comment has been minimized.

Sign in to view

BridgeAR added the performance Issues and PRs related to the performance of Node.js. label Nov 26, 2019

fixup: improve doc wording

87e6091

devsnek reviewed Dec 2, 2019

View reviewed changes

jasnell approved these changes Dec 2, 2019

View reviewed changes

targos approved these changes Dec 6, 2019

View reviewed changes

lib/internal/util/inspect.js Show resolved Hide resolved

antsmartian approved these changes Dec 6, 2019

View reviewed changes

fixup: util: improve inspect's customInspect performance

8f5432d

This comment has been minimized.

Sign in to view

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

BridgeAR closed this Dec 6, 2019

MylesBorins mentioned this pull request Dec 13, 2019

v13.4.0 proposal #30937

Merged

targos mentioned this pull request Jan 15, 2020

v12.15.0 release proposal #31368

Closed

BridgeAR deleted the improve-user-options-perf branch January 20, 2020 12:07

MylesBorins mentioned this pull request Feb 8, 2020

v12.16.0 proposal #31691

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: add more predefined color codes to inspect.colors #30659

util: add more predefined color codes to inspect.colors #30659

BridgeAR commented Nov 26, 2019

This comment has been minimized.

Trott commented Nov 26, 2019

BridgeAR commented Nov 26, 2019 •

edited

Loading

This comment has been minimized.

nodejs-github-bot commented Nov 26, 2019

devsnek Dec 2, 2019

BridgeAR Dec 2, 2019

nodejs-github-bot commented Dec 2, 2019

BridgeAR commented Dec 3, 2019

BridgeAR commented Dec 6, 2019

antsmartian left a comment

This comment has been minimized.

nodejs-github-bot commented Dec 6, 2019 •

edited by BridgeAR

Loading

BridgeAR commented Dec 6, 2019

util: add more predefined color codes to inspect.colors #30659

util: add more predefined color codes to inspect.colors #30659

Conversation

BridgeAR commented Nov 26, 2019

Checklist

This comment has been minimized.

Trott commented Nov 26, 2019

BridgeAR commented Nov 26, 2019 • edited Loading

This comment has been minimized.

nodejs-github-bot commented Nov 26, 2019

devsnek Dec 2, 2019

Choose a reason for hiding this comment

BridgeAR Dec 2, 2019

Choose a reason for hiding this comment

nodejs-github-bot commented Dec 2, 2019

BridgeAR commented Dec 3, 2019

BridgeAR commented Dec 6, 2019

antsmartian left a comment

Choose a reason for hiding this comment

This comment has been minimized.

nodejs-github-bot commented Dec 6, 2019 • edited by BridgeAR Loading

BridgeAR commented Dec 6, 2019

BridgeAR commented Nov 26, 2019 •

edited

Loading

nodejs-github-bot commented Dec 6, 2019 •

edited by BridgeAR

Loading