Fix/debug depth (#926)

calvintwr · web-flow · commit cac39b1c5b01 · 2024-05-31T13:34:49.000+02:00
* fix debug format options ignored

* moved sinon to devDependencies
diff --git a/package.json b/package.json
@@ -26,7 +26,7 @@
   "scripts": {
     "lint": "xo",
     "test": "npm run test:node && npm run test:browser && npm run lint",
-    "test:node": "istanbul cover _mocha -- test.js",
+    "test:node": "istanbul cover _mocha -- test.js test.node.js",
     "test:browser": "karma start --single-run",
     "test:coverage": "cat ./coverage/lcov.info | coveralls"
   },
@@ -44,6 +44,7 @@
     "karma-mocha": "^1.3.0",
     "mocha": "^5.2.0",
     "mocha-lcov-reporter": "^1.2.0",
+    "sinon": "^14.0.0",
     "xo": "^0.23.0"
   },
   "peerDependenciesMeta": {
diff --git a/src/node.js b/src/node.js
@@ -187,11 +187,11 @@ function getDate() {
 }
 
 /**
- * Invokes `util.format()` with the specified arguments and writes to stderr.
+ * Invokes `util.formatWithOptions()` with the specified arguments and writes to stderr.
  */
 
 function log(...args) {
-	return process.stderr.write(util.format(...args) + '\n');
+	return process.stderr.write(util.formatWithOptions(exports.inspectOpts, ...args) + '\n');
 }
 
 /**
diff --git a/test.node.js b/test.node.js
@@ -0,0 +1,40 @@
+/* eslint-env mocha */
+
+const assert = require('assert');
+const util = require('util');
+const sinon = require('sinon');
+const debug = require('./src/node');
+
+const formatWithOptionsSpy = sinon.spy(util, 'formatWithOptions');
+beforeEach(() => {
+	formatWithOptionsSpy.resetHistory();
+});
+
+describe('debug node', () => {
+	describe('formatting options', () => {
+		it('calls util.formatWithOptions', () => {
+			debug.enable('*');
+			const stdErrWriteStub = sinon.stub(process.stderr, 'write');
+			const log = debug('formatting options');
+			log('hello world');
+			assert(util.formatWithOptions.callCount === 1);
+			stdErrWriteStub.restore();
+		});
+
+		it('calls util.formatWithOptions with inspectOpts', () => {
+			debug.enable('*');
+			const options = {
+				hideDate: true,
+				colors: true,
+				depth: 10,
+				showHidden: true
+			};
+			Object.assign(debug.inspectOpts, options);
+			const stdErrWriteStub = sinon.stub(process.stderr, 'write');
+			const log = debug('format with inspectOpts');
+			log('hello world2');
+			assert.deepStrictEqual(util.formatWithOptions.getCall(0).args[0], options);
+			stdErrWriteStub.restore();
+		});
+	});
+});

Original file line number	Diff line number	Diff line change
`@@ -187,11 +187,11 @@ function getDate() {`
`187`	`187`	`}`
`188`	`188`
`189`	`189`	`/**`
`190`		- * Invokes `util.format()` with the specified arguments and writes to stderr.
	`190`	+ * Invokes `util.formatWithOptions()` with the specified arguments and writes to stderr.
`191`	`191`	`*/`
`192`	`192`
`193`	`193`	`function log(...args) {`
`194`		`- return process.stderr.write(util.format(...args) + '\n');`
	`194`	`+ return process.stderr.write(util.formatWithOptions(exports.inspectOpts, ...args) + '\n');`
`195`	`195`	`}`
`196`	`196`
`197`	`197`	`/**`