util: add colors to debuglog()

This adds colors to the passed through arguments in case the stream supports colors. The PID will also be highlighted. PR-URL: #30930 Reviewed-By: James M Snell <[email protected]>

Author: BridgeAR

lib/internal/util/debuglog.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const{ format }=require('internal/util/inspect');
+const{inspect,format, formatWithOptions}=require('internal/util/inspect');
 
 const{ RegExp }=primordials;
 
@@ -40,8 +40,10 @@ function debuglogImpl(set){
 constpid=process.pid;
 emitWarningIfNeeded(set);
 debugs[set]=functiondebug(...args){
-constmsg=format(...args);
-process.stderr.write(format('%s %d: %s\n',set,pid,msg));
+constcolors=process.stderr.hasColors&&process.stderr.hasColors();
+constmsg=formatWithOptions({ colors }, ...args);
+constcoloredPID=inspect(pid,{ colors });
+process.stderr.write(format('%s %s: %s\n',set,coloredPID,msg));
 };
 }else{
 debugs[set]=null;

test/sequential/test-util-debug.js

@@ -22,6 +22,7 @@
 'use strict';
 constcommon=require('../common');
 constassert=require('assert');
+constutil=require('util');
 
 const[,,modeArgv,sectionArgv]=process.argv;
 
@@ -54,19 +55,36 @@ function parent(){
 test('*-test',true,'abc-test');
 }
 
-functiontest(environ,shouldWrite,section){
+functiontest(environ,shouldWrite,section,forceColors=false){
 letexpectErr='';
 constexpectOut='ok\n';
 
 constspawn=require('child_process').spawn;
 constchild=spawn(process.execPath,[__filename,'child',section],{
-env: Object.assign(process.env,{NODE_DEBUG: environ})
+env: Object.assign(process.env,{
+NODE_DEBUG: environ,
+FORCE_COLOR: forceColors ? 'true' : 'false'
+})
 });
 
 if(shouldWrite){
-expectErr=
-`${section.toUpperCase()}${child.pid}: this{is: 'a'} /debugging/\n${
-section.toUpperCase()}${child.pid}: num=1 str=a obj={"foo":"bar"}\n`;
+if(forceColors){
+const{ colors, styles }=util.inspect;
+constaddCodes=(arr)=>[`\x1B[${arr[0]}m`,`\x1B[${arr[1]}m`];
+constnum=addCodes(colors[styles.number]);
+conststr=addCodes(colors[styles.string]);
+constregexp=addCodes(colors[styles.regexp]);
+conststart=`${section.toUpperCase()}${num[0]}${child.pid}${num[1]}`;
+constdebugging=`${regexp[0]}/debugging/${regexp[1]}`;
+expectErr=
+`${start}: this{is: ${str[0]}'a'${str[1]} } ${debugging}\n`+
+`${start}: num=1 str=a obj={"foo":"bar"}\n`;
+}else{
+conststart=`${section.toUpperCase()}${child.pid}`;
+expectErr=
+`${start}: this{is: 'a'} /debugging/\n`+
+`${start}: num=1 str=a obj={"foo":"bar"}\n`;
+}
 }
 
 leterr='';
@@ -85,12 +103,20 @@ function test(environ, shouldWrite, section){
 assert(!c);
 assert.strictEqual(err,expectErr);
 assert.strictEqual(out,expectOut);
+// Run the test again, this time with colors enabled.
+if(!forceColors){
+test(environ,shouldWrite,section,true);
+}
 }));
 }
 
 
 functionchild(section){
-constutil=require('util');
+consttty=require('tty');
+// Make sure we check for colors, no matter of the stream's default.
+Object.defineProperty(process.stderr,'hasColors',{
+value: tty.WriteStream.prototype.hasColors
+});
 constdebug=util.debuglog(section);
 debug('this',{is: 'a'},/debugging/);
 debug('num=%d str=%s obj=%j',1,'a',{foo: 'bar'});