cli: style node --help output with util.styleText

Apply util.styleText to the `node --help` output for improved visual
hierarchy and scannability. Styling is applied only when the output
stream supports color (detected via util.styleText's built-in
shouldColorize), so piped/redirected output and NO_COLOR remain plain
text with no behavior change.
- Bold: Usage lines, Options:, Environment variables: headers
- Bold green: CLI option names (e.g. --inspect, -e, --eval)
- Bold magenta: environment variable names (e.g. NODE_PATH)
- Dim: "(currently set)" annotation
- Blue underline: documentation URL
Column-width math uses unstyled string lengths to preserve alignment
regardless of styling. The "(currently set)" annotation is styled via
post-processing after layout to avoid breaking the fold() width
calculation.
Signed-off-by: Adrian Estrada <edsadr@gmail.com>
PR-URL: #64484
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day>

Author: edsadr

lib/internal/main/print_help.js

@@ -25,11 +25,16 @@ const {
 }=require('internal/process/pre_execution');
 
 const{ getCLIOptionsInfo, getOptionValue }=require('internal/options');
+const{ styleText }=require('util');
 
 consttypeLookup=[];
 for(constkeyofObjectKeys(types))
 typeLookup[types[key]]=key;
 
+functionstyle(format,text){
+returnstyleText(format,text,{stream: process.stdout});
+}
+
 // Environment variables are parsed ad-hoc throughout the code base,
 // so we gather the documentation here.
 const{ hasIntl, hasSmallICU, hasNodeOptions }=internalBinding('config');
@@ -117,7 +122,7 @@ function getArgDescription(type) {
 }
 
 functionformat(
-{ options, aliases =newSafeMap(), firstColumn, secondColumn },
+{ options, aliases =newSafeMap(), firstColumn, secondColumn, nameStyle =[]},
 ){
 lettext='';
 letmaxFirstColumnUsed=0;
@@ -176,7 +181,7 @@ function format(
 displayHelpText+=' (currently set)';
 }
 
-text+=displayName;
+text+=style(nameStyle,displayName);
 maxFirstColumnUsed=MathMax(maxFirstColumnUsed,displayName.length);
 if(displayName.length>=firstColumn)
 text+='\n'+StringPrototypeRepeat(' ',firstColumn);
@@ -194,6 +199,7 @@ function format(
  aliases,
 firstColumn: maxFirstColumnUsed+2,
  secondColumn,
+ nameStyle,
 });
 }
 
@@ -214,20 +220,29 @@ function print(stream) {
 'interactive mode if a tty)'});
 options.set('--',{helpText: 'indicate the end of node options'});
 lethelpText=(
-'Usage: node [options] [ script.js ] [arguments]\n'+
-' node inspect [options] [ script.js | host:port ] [arguments]\n\n'+
-'Options:\n');
+style('bold',
+'Usage: node [options] [ script.js ] [arguments]\n'+
+' node inspect [options] [ script.js | host:port ] [arguments]')+
+'\n\n'+style('bold','Options:')+'\n');
 helpText+=(indent(format({
- options, aliases, firstColumn, secondColumn,
+ options, aliases, firstColumn, secondColumn,nameStyle: ['bold','green'],
 }),2));
 
-helpText+=('\nEnvironment variables:\n');
+helpText+=('\n'+style('bold','Environment variables:')+'\n');
 
 helpText+=(format({
-options: envVars, firstColumn, secondColumn,
+options: envVars, firstColumn, secondColumn,nameStyle: ['bold','magenta'],
 }));
 
-helpText+=('\nDocumentation can be found at https://nodejs.org/');
+helpText+=('\nDocumentation can be found at '+
+style(['blue','underline'],'https://nodejs.org/'));
+
+helpText=RegExpPrototypeSymbolReplace(
+/\(currentlyset\)/g,
+helpText,
+style('dim',' (currently set)'),
+);
+
 console.log(helpText);
 }
 

test/parallel/test-cli-node-print-help-style.js

@@ -0,0 +1,64 @@
+'use strict';
+
+constcommon=require('../common');
+constassert=require('assert');
+const{ execFile }=require('child_process');
+
+// eslint-disable-next-line no-control-regex
+constANSI_SGR_REGEX=newRegExp('\x1b\\[[0-9;]*m','g');
+
+functionstripAnsi(text){
+returntext.replace(ANSI_SGR_REGEX,'');
+}
+
+// Test: FORCE_COLOR=1 produces styled output
+{
+constenv={ ...process.env,FORCE_COLOR: '1'};
+execFile(process.execPath,['--help'],{ env },
+common.mustSucceed((stdout)=>{
+assert.ok(stdout.includes('\x1b[1m'),'bold for headers should be present');
+assert.ok(stdout.includes('\x1b[32m'),'green for option names should be present');
+assert.ok(stdout.includes('\x1b[35m'),'magenta for env var names should be present');
+assert.ok(stdout.includes('\x1b[34m'),'blue for URL should be present');
+assert.ok(stdout.includes('\x1b[4m'),'underline for URL should be present');
+}));
+}
+
+// Test: NO_COLOR=1 produces plain output
+{
+constenv={ ...process.env,NO_COLOR: '1'};
+deleteenv.FORCE_COLOR;
+execFile(process.execPath,['--help'],{ env },
+common.mustSucceed((stdout)=>{
+assert.ok(stripAnsi(stdout)===stdout,
+'no ANSI escape sequences should be present with NO_COLOR=1');
+}));
+}
+
+// Test: piped (non-TTY, no FORCE_COLOR) produces plain output
+{
+constenv={ ...process.env};
+deleteenv.FORCE_COLOR;
+deleteenv.NO_COLOR;
+deleteenv.NODE_DISABLE_COLORS;
+execFile(process.execPath,['--help'],{ env },
+common.mustSucceed((stdout)=>{
+assert.ok(stripAnsi(stdout)===stdout,
+'no ANSI escape sequences should be present when piped (non-TTY)');
+}));
+}
+
+// Test: alignment preservation - stripped styled output matches plain output
+{
+constenvStyled={ ...process.env,FORCE_COLOR: '1'};
+constenvPlain={ ...process.env,NO_COLOR: '1'};
+deleteenvPlain.FORCE_COLOR;
+execFile(process.execPath,['--help'],{env: envStyled},
+common.mustSucceed((styledStdout)=>{
+execFile(process.execPath,['--help'],{env: envPlain},
+common.mustSucceed((plainStdout)=>{
+assert.ok(stripAnsi(styledStdout)===plainStdout,
+'stripped styled output should match plain output (alignment preservation)');
+}));
+}));
+}