#719 - Support decoration with process information

README.md

@@ -170,6 +170,8 @@ change the behavior of the debug logging:
 | `DEBUG_COLORS`| Whether or not to use colors in the debug output. |
 | `DEBUG_DEPTH` | Object inspection depth.                    |
 | `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. |
+| `DEBUG_PROCESS` | Prefixes logs with a title in square brackets. |
+| `DEBUG_PROCESS_PID` | Prefixes logs with the process id in square brackets. |
 
 
 __Note:__ The environment variables beginning with `DEBUG_` end up being

src/node.js

@@ -128,16 +128,18 @@ exports.inspectOpts = Object.keys(process.env).filter(key => {
 			return k.toUpperCase();
 		});
 
-	// Coerce string value into JS value
 	let val = process.env[key];
-	if (/^(yes|on|true|enabled)$/i.test(val)) {
-		val = true;
-	} else if (/^(no|off|false|disabled)$/i.test(val)) {
-		val = false;
-	} else if (val === 'null') {
-		val = null;
-	} else {
-		val = Number(val);
+	if (prop !== 'process') { // Don't coerce known string values
+		// Coerce string value into JS value
+		if (/^(yes|on|true|enabled)$/i.test(val)) {
+			val = true;
+		} else if (/^(no|off|false|disabled)$/i.test(val)) {
+			val = false;
+		} else if (val === 'null') {
+			val = null;
+		} else {
+			val = Number(val);
+		}
 	}
 
 	obj[prop] = val;
@@ -161,7 +163,12 @@ function useColors() {
  */
 
 function formatArgs(args) {
-	const {namespace: name, useColors} = this;
+	let {namespace: name, useColors} = this;
+
+	const proc = exports.inspectOpts.process || (exports.inspectOpts.processPid ? process.pid : undefined);
+	if (proc) {
+		name = `[${proc}] ${name}`;
+	}
 
 	if (useColors) {
 		const c = this.color;

test.js

@@ -20,6 +20,40 @@ describe('debug', () => {
 		assert.doesNotThrow(() => debug.enable(true));
 	});
 
+	it('honors process decoration', function () {
+		const options = debug.inspectOpts;
+		if (!options) { // Browser
+			this.skip();
+			return;
+		}
+		const optionKeys = ['process', 'processPid', 'colors', 'hideDate'];
+		const oldValues = optionKeys.map(k => debug.inspectOpts[k]);
+
+		try {
+			options.colors = false;
+			options.hideDate = true;
+
+			let messageArgs;
+			const log = debug('bar');
+			log.enabled = true;
+			log.log = (...args) => {
+				messageArgs = args;
+			};
+
+			options.processPid = true;
+			log('baz');
+			assert.strictEqual(messageArgs[0], `[${process.pid}] bar baz`, 'should reflect DEBUG_PROCESS_PID');
+
+			options.process = 'foo';
+			log('baz');
+			assert.strictEqual(messageArgs[0], '[foo] bar baz', 'should reflect DEBUG_PROCESS');
+		} finally {
+			optionKeys.forEach((k, i) => {
+				options[k] = oldValues[i];
+			});
+		}
+	});
+
 	it('honors global debug namespace enable calls', () => {
 		assert.deepStrictEqual(debug('test:12345').enabled, false);
 		assert.deepStrictEqual(debug('test:67890').enabled, false);