util: add styleText API to text formatting #51850

RafaelGSS · 2024-02-23T13:48:13Z

A fresh new PR from #43371.

@hemanth I took the liberty to create a new fresh PR (including a few changes) as your PR is almost 2 years old. I have included you as Co-Author I hope you don't mind (I tried to search for your handle in the OpenJS Foundation Slack, but I couldn't find it).

The concerns raised in the original blocker can be discussed again if necessary, but I believe we should have this API on Node.js.

cc: @nodejs/tsc

mcollina

lgtm

nodejs-github-bot · 2024-02-23T14:00:45Z

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

edsadr

Really happy to see this happening 🎉

lib/util.js

test/parallel/test-util-formattext.js

doc/api/util.md

nodejs-github-bot · 2024-02-23T17:30:30Z

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

aduh95

Consider pushing an amend commit to update the commit message (git commit --allow-empty -m 'amend! util: add formatText API to text formatting' -m 'util: add `styleText` API for text formatting' -m 'Co-Authored-By: Hemanth HM <hemanth.hm@gmail.com>').

nodejs-github-bot · 2024-02-23T17:58:01Z

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

doc/api/util.md

lib/util.js

hemanth · 2024-02-24T14:51:21Z

Thanks a lot for taking the initiative to restart this effort, RafaelGSS! ❤️

doc/api/util.md

Co-Authored-By: Hemanth HM <hemanth.hm@gmail.com>

Notable changes: build: * (SEMVER-MINOR) build opt to set local location of headers (Michael Dawson) #51525 crypto: * (SEMVER-MINOR) implement crypto.hash() (Joyee Cheung) #51044 * update root certificates to NSS 3.98 (Node.js GitHub Bot) #51794 doc: * add zcbenz to collaborators (Cheng Zhao) #51812 * add lemire to collaborators (Daniel Lemire) #51572 http2: * (SEMVER-MINOR) add h2 compat support for appendHeader (Tim Perry) #51412 * (SEMVER-MINOR) add server handshake utility (snek) #51172 * (SEMVER-MINOR) receive customsettings (Marten Richter) #51323 lib: * (SEMVER-MINOR) move encodingsMap to internal/util (Joyee Cheung) #51044 sea: * (SEMVER-MINOR) support sea.getRawAsset() (Joyee Cheung) #50960 * (SEMVER-MINOR) support embedding assets (Joyee Cheung) #50960 src: * (SEMVER-MINOR) print string content better in BlobDeserializer (Joyee Cheung) #50960 * (SEMVER-MINOR) support multi-line values for .env file (IlyasShabi) #51289 * (SEMVER-MINOR) add `process.loadEnvFile` and `util.parseEnv` (Yagiz Nizipli) #51476 * (SEMVER-MINOR) do not coerce dotenv paths (Tobias Nießen) #51425 stream: * (SEMVER-MINOR) implement `min` option for `ReadableStreamBYOBReader.read` (Mattias Buelens) #50888 util: * (SEMVER-MINOR) add styleText API to text formatting (Rafael Gonzaga) #51850 vm: * (SEMVER-MINOR) support using the default loader to handle dynamic import() (Joyee Cheung) #51244 PR-URL: #51932

Implements nodejs/node#51850

kibertoad · 2024-03-06T23:55:01Z

lib/util.js

+ */
+function styleText(format, text) {
+  validateString(text, 'text');
+  const formatCodes = inspect.colors[format];


~~does it make sense to do this check on every call? could be done once and cached~~

nvm, happy path should be pretty fast here, misread the code

hemanth · 2024-03-07T01:38:42Z

I was wondering if there have been any updates on this issue. It appears that #43371 was marked as blocked pending a decision. \cc @mcollina

mcollina · 2024-03-07T09:12:09Z

I guess this module landing was a decision on that.

bakkot · 2024-03-07T16:44:42Z

Seems kind of a shame to have left out support for the common NO_COLOR option environment variable, or for checking isatty and FORCE_COLOR. That means people trying to switch to this from (e.g.) picocolors or chalk or colors.js or ansi-colors or colorette or kleur are (probably unknowingly) going to end up with a worse experience for their users. Node itself supports those as well.

I'm very much in favor of the effort to pull more widely-used features into core, but I feel like the process ought to include a bit more review of what conventions the ecosystem has settled on before doing so.

meyfa · 2024-03-07T16:51:09Z

This is at stability 1.1 (Active Development), is it not? Wouldn't that mean that such functionality can still be added?

kibertoad · 2024-03-07T16:55:12Z

It only landed in 21.x so far, so yeah, should be OK to change it

RafaelGSS · 2024-03-07T23:21:13Z

Folks, please see #51959. Consider opening a new issue to discuss the feature and stability of this new API instead of commenting on this PR.

Implements nodejs/node#51850

Co-Authored-By: Hemanth HM <hemanth.hm@gmail.com> PR-URL: #51850 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Adrian Estrada <edsadr@gmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>

Notable changes: build: * (SEMVER-MINOR) build opt to set local location of headers (Michael Dawson) #51525 crypto: * (SEMVER-MINOR) implement crypto.hash() (Joyee Cheung) #51044 * update root certificates to NSS 3.98 (Node.js GitHub Bot) #51794 doc: * add lemire to collaborators (Daniel Lemire) #51572 * add zcbenz to collaborators (Cheng Zhao) #51812 lib: * (SEMVER-MINOR) move encodingsMap to internal/util (Joyee Cheung) #51044 sea: * (SEMVER-MINOR) support sea.getRawAsset() (Joyee Cheung) #50960 * (SEMVER-MINOR) support embedding assets (Joyee Cheung) #50960 src: * (SEMVER-MINOR) print string content better in BlobDeserializer (Joyee Cheung) #50960 util: * (SEMVER-MINOR) add styleText API to text formatting (Rafael Gonzaga) #51850 vm: * (SEMVER-MINOR) support using the default loader to handle dynamic import() (Joyee Cheung) #51244 PR-URL: #52212

Co-Authored-By: Hemanth HM <hemanth.hm@gmail.com> PR-URL: nodejs#51850 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Adrian Estrada <edsadr@gmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>

Notable changes: build: * (SEMVER-MINOR) build opt to set local location of headers (Michael Dawson) nodejs#51525 crypto: * (SEMVER-MINOR) implement crypto.hash() (Joyee Cheung) nodejs#51044 * update root certificates to NSS 3.98 (Node.js GitHub Bot) nodejs#51794 doc: * add zcbenz to collaborators (Cheng Zhao) nodejs#51812 * add lemire to collaborators (Daniel Lemire) nodejs#51572 http2: * (SEMVER-MINOR) add h2 compat support for appendHeader (Tim Perry) nodejs#51412 * (SEMVER-MINOR) add server handshake utility (snek) nodejs#51172 * (SEMVER-MINOR) receive customsettings (Marten Richter) nodejs#51323 lib: * (SEMVER-MINOR) move encodingsMap to internal/util (Joyee Cheung) nodejs#51044 sea: * (SEMVER-MINOR) support sea.getRawAsset() (Joyee Cheung) nodejs#50960 * (SEMVER-MINOR) support embedding assets (Joyee Cheung) nodejs#50960 src: * (SEMVER-MINOR) print string content better in BlobDeserializer (Joyee Cheung) nodejs#50960 * (SEMVER-MINOR) support multi-line values for .env file (IlyasShabi) nodejs#51289 * (SEMVER-MINOR) add `process.loadEnvFile` and `util.parseEnv` (Yagiz Nizipli) nodejs#51476 * (SEMVER-MINOR) do not coerce dotenv paths (Tobias Nießen) nodejs#51425 stream: * (SEMVER-MINOR) implement `min` option for `ReadableStreamBYOBReader.read` (Mattias Buelens) nodejs#50888 util: * (SEMVER-MINOR) add styleText API to text formatting (Rafael Gonzaga) nodejs#51850 vm: * (SEMVER-MINOR) support using the default loader to handle dynamic import() (Joyee Cheung) nodejs#51244 PR-URL: nodejs#51932

Notable changes: build: * (SEMVER-MINOR) build opt to set local location of headers (Michael Dawson) #51525 crypto: * (SEMVER-MINOR) implement crypto.hash() (Joyee Cheung) #51044 * update root certificates to NSS 3.98 (Node.js GitHub Bot) #51794 doc: * add lemire to collaborators (Daniel Lemire) #51572 * add zcbenz to collaborators (Cheng Zhao) #51812 lib: * (SEMVER-MINOR) move encodingsMap to internal/util (Joyee Cheung) #51044 sea: * (SEMVER-MINOR) support sea.getRawAsset() (Joyee Cheung) #50960 * (SEMVER-MINOR) support embedding assets (Joyee Cheung) #50960 src: * (SEMVER-MINOR) print string content better in BlobDeserializer (Joyee Cheung) #50960 util: * (SEMVER-MINOR) add styleText API to text formatting (Rafael Gonzaga) #51850 vm: * (SEMVER-MINOR) support using the default loader to handle dynamic import() (Joyee Cheung) #51244 PR-URL: #52212

RafaelGSS added the semver-minor PRs that contain new features and should be released in the next minor version. label Feb 23, 2024

nodejs-github-bot added needs-ci PRs that need a full CI run. util Issues and PRs related to the built-in util module. labels Feb 23, 2024

mcollina approved these changes Feb 23, 2024

View reviewed changes

mcollina added the request-ci Add this label to start a Jenkins CI on a PR. label Feb 23, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Feb 23, 2024

edsadr approved these changes Feb 23, 2024

View reviewed changes

marco-ippolito approved these changes Feb 23, 2024

View reviewed changes

aduh95 approved these changes Feb 23, 2024

View reviewed changes

meyfa reviewed Feb 23, 2024

View reviewed changes

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

GeoffreyBooth reviewed Feb 23, 2024

View reviewed changes

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

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

RafaelGSS changed the title ~~util: add formatText API to text formatting~~ util: add styleText API to text formatting Feb 23, 2024

RafaelGSS added the request-ci Add this label to start a Jenkins CI on a PR. label Feb 23, 2024

RafaelGSS requested review from GeoffreyBooth and aduh95 February 23, 2024 17:28

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Feb 23, 2024

aduh95 approved these changes Feb 23, 2024

View reviewed changes

RafaelGSS force-pushed the add-util-text-color branch from c969cf8 to 44b90fe Compare February 23, 2024 17:49

RafaelGSS added the request-ci Add this label to start a Jenkins CI on a PR. label Feb 23, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Feb 23, 2024

GeoffreyBooth reviewed Feb 23, 2024

View reviewed changes

doc/api/util.md Show resolved Hide resolved

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

lib/util.js Outdated Show resolved Hide resolved

MoLow reviewed Feb 25, 2024

View reviewed changes

doc/api/util.md Show resolved Hide resolved

MoLow approved these changes Feb 25, 2024

View reviewed changes

util: add styleText API to text formatting

24faff7

Co-Authored-By: Hemanth HM <hemanth.hm@gmail.com>

RafaelGSS force-pushed the add-util-text-color branch from 44b90fe to 24faff7 Compare February 25, 2024 15:46

RafaelGSS added the request-ci Add this label to start a Jenkins CI on a PR. label Feb 25, 2024

crowlKats mentioned this pull request Mar 6, 2024

feat(node/util): styleText denoland/deno#22758

Merged

crowlKats added a commit to denoland/deno that referenced this pull request Mar 6, 2024

feat(node/util): styleText (#22758)

0fb67ce

Implements nodejs/node#51850

kibertoad reviewed Mar 6, 2024

View reviewed changes

CanadaHonk mentioned this pull request Mar 7, 2024

API for text styling? wintercg/proposal-cli-api#18

Open

This was referenced Mar 7, 2024

Consider explicit string formatting module #43382

Closed

util: add colorText method #43371

Closed

littledivy pushed a commit to denoland/deno that referenced this pull request Mar 8, 2024

feat(node/util): styleText (#22758)

1a217c9

Implements nodejs/node#51850

hail2u added a commit to hail2u/hail2u.net that referenced this pull request Mar 12, 2024

Bookmark nodejs/node#51850

c1404ae

richardlau mentioned this pull request Mar 25, 2024

v20.12.0 proposal #52212

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: add styleText API to text formatting #51850

util: add styleText API to text formatting #51850

RafaelGSS commented Feb 23, 2024

mcollina left a comment

nodejs-github-bot commented Feb 23, 2024

edsadr left a comment

nodejs-github-bot commented Feb 23, 2024

aduh95 left a comment

nodejs-github-bot commented Feb 23, 2024

hemanth commented Feb 24, 2024

kibertoad Mar 6, 2024 •

edited

hemanth commented Mar 7, 2024

mcollina commented Mar 7, 2024

bakkot commented Mar 7, 2024 •

edited

meyfa commented Mar 7, 2024

kibertoad commented Mar 7, 2024

RafaelGSS commented Mar 7, 2024

util: add styleText API to text formatting #51850

util: add styleText API to text formatting #51850

Conversation

RafaelGSS commented Feb 23, 2024

mcollina left a comment

Choose a reason for hiding this comment

nodejs-github-bot commented Feb 23, 2024

edsadr left a comment

Choose a reason for hiding this comment

nodejs-github-bot commented Feb 23, 2024

aduh95 left a comment

Choose a reason for hiding this comment

nodejs-github-bot commented Feb 23, 2024

hemanth commented Feb 24, 2024

kibertoad Mar 6, 2024 • edited

Choose a reason for hiding this comment

hemanth commented Mar 7, 2024

mcollina commented Mar 7, 2024

bakkot commented Mar 7, 2024 • edited

meyfa commented Mar 7, 2024

kibertoad commented Mar 7, 2024

RafaelGSS commented Mar 7, 2024

kibertoad Mar 6, 2024 •

edited

bakkot commented Mar 7, 2024 •

edited