Exploit the second console.dir argument

* fixes jestjs#10176 * repeats behaviour of the node.js Console class https://github.com/nodejs/node/blob/9918bdf5cb07f58d230522244a372cbb1b510956/lib/internal/console/constructor.js
xamgore · Jun 20, 2020 · 5c9f124 · 5c9f124
1 parent 4471bbb
commit 5c9f124
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 6 deletions.
diff --git a/packages/jest-console/src/BufferedConsole.ts b/packages/jest-console/src/BufferedConsole.ts
@@ -7,7 +7,7 @@
 
 import assert = require('assert');
 import {Console} from 'console';
-import {format} from 'util';
+import {format, formatWithOptions, inspect} from 'util';
 import chalk = require('chalk');
 import {ErrorWithStack, formatTime} from 'jest-util';
 import type {
@@ -98,8 +98,9 @@ export default class BufferedConsole extends Console {
     this._log('debug', format(firstArg, ...rest));
   }
 
-  dir(firstArg: unknown, ...rest: Array<unknown>): void {
-    this._log('dir', format(firstArg, ...rest));
+  dir(firstArg: unknown, options: NodeJS.InspectOptions = {}): void {
+    const representation = inspect(firstArg, options);
+    this._log('dir', formatWithOptions(options, representation));
   }
 
   dirxml(firstArg: unknown, ...rest: Array<unknown>): void {

diff --git a/packages/jest-console/src/CustomConsole.ts b/packages/jest-console/src/CustomConsole.ts
@@ -6,7 +6,7 @@
  */
 
 import assert = require('assert');
-import {format} from 'util';
+import {format, formatWithOptions, inspect} from 'util';
 import {Console} from 'console';
 import chalk = require('chalk');
 import {clearLine, formatTime} from 'jest-util';
@@ -75,8 +75,9 @@ export default class CustomConsole extends Console {
     this._log('debug', format(firstArg, ...args));
   }
 
-  dir(firstArg: unknown, ...args: Array<unknown>): void {
-    this._log('dir', format(firstArg, ...args));
+  dir(firstArg: unknown, options: NodeJS.InspectOptions = {}): void {
+    const representation = inspect(firstArg, options);
+    this._log('dir', formatWithOptions(options, representation));
   }
 
   dirxml(firstArg: unknown, ...args: Array<unknown>): void {

diff --git a/packages/jest-console/src/__tests__/CustomConsole.test.ts b/packages/jest-console/src/__tests__/CustomConsole.test.ts
@@ -186,4 +186,13 @@ describe('CustomConsole', () => {
       expect(_stdout).toMatch('ms');
     });
   });
+
+  describe('dir', () => {
+    test('should print the deepest value', () => {
+      const deepObject = {1: {2: {3: {4: {5: {6: 'value'}}}}}};
+      _console.dir(deepObject, {depth: 6});
+
+      expect(_stdout).toMatch('value');
+    });
+  });
 });
diff --git a/packages/jest-console/src/__tests__/bufferedConsole.test.ts b/packages/jest-console/src/__tests__/bufferedConsole.test.ts
@@ -146,4 +146,13 @@ describe('CustomConsole', () => {
       expect(stdout()).toMatch('ms');
     });
   });
+
+  describe('dir', () => {
+    test('should print the deepest value', () => {
+      const deepObject = {1: {2: {3: {4: {5: {6: 'value'}}}}}};
+      _console.dir(deepObject, {depth: 6});
+
+      expect(stdout()).toMatch('value');
+    });
+  });
 });