Merge branch 'master' into uglier-inline-snapshots

* master:
  chore(docs): update TutorialReactNative.md (jestjs#10802)
  fix: console dir should respect options (jestjs#10638)
  docs: add missing "--roots" options (jestjs#10793)

CHANGELOG.md

@@ -8,6 +8,7 @@
 
 ### Fixes
 
+- `[jest-console]` `console.dir` now respects the second argument correctly ([#10638](https://github.com/facebook/jest/pull/10638))
 - `[expect]` [**BREAKING**] Revise `expect.not.objectContaining()` to be the inverse of `expect.objectContaining()`, as documented. ([#10708](https://github.com/facebook/jest/pull/10708))
 - `[jest-resolve]` Replace read-pkg-up with escalade package ([#10781](https://github.com/facebook/jest/pull/10781))
 - `[jest-runtime]` [**BREAKING**] Do not inject `global` variable into module wrapper ([#10644](https://github.com/facebook/jest/pull/10644))

docs/CLI.md

@@ -266,6 +266,10 @@ Run tests with specified reporters. [Reporter options](configuration#reporters-a
 
 `jest --reporters="default" --reporters="jest-junit"`
 
+### `--roots`
+
+A list of paths to directories that Jest should use to search for files in.
+
 ### `--runInBand`
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.

docs/TutorialReactNative.md

@@ -35,6 +35,19 @@ Let's create a [snapshot test](SnapshotTesting.md) for a small intro component w
 import React, {Component} from 'react';
 import {StyleSheet, Text, View} from 'react-native';
 
+class Intro extends Component {
+  render() {
+    return (
+      <View style={styles.container}>
+        <Text style={styles.welcome}>Welcome to React Native!</Text>
+        <Text style={styles.instructions}>
+          This is a React Native snapshot test.
+        </Text>
+      </View>
+    );
+  }
+}
+
 const styles = StyleSheet.create({
   container: {
     alignItems: 'center',
@@ -54,18 +67,7 @@ const styles = StyleSheet.create({
   },
 });
 
-export default class Intro extends Component {
-  render() {
-    return (
-      <View style={styles.container}>
-        <Text style={styles.welcome}>Welcome to React Native!</Text>
-        <Text style={styles.instructions}>
-          This is a React Native snapshot test.
-        </Text>
-      </View>
-    );
-  }
-}
+export default Intro;
 ```
 
 Now let's use React's test renderer and Jest's snapshot feature to interact with the component and capture the rendered output and create a snapshot file:

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 {
@@ -95,8 +95,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 {

packages/jest-console/src/CustomConsole.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 {clearLine, formatTime} from 'jest-util';
 import type {LogCounters, LogMessage, LogTimers, LogType} from './types';
@@ -73,8 +73,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 {

packages/jest-console/src/__tests__/CustomConsole.test.ts

@@ -187,6 +187,16 @@ describe('CustomConsole', () => {
     });
   });
 
+  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');
+      expect(_stdout).not.toMatch('depth');
+    });
+  });
+
   describe('timeLog', () => {
     test('should return the time between time() and timeEnd() on default timer', () => {
       _console.time();

packages/jest-console/src/__tests__/bufferedConsole.test.ts

@@ -147,6 +147,16 @@ describe('CustomConsole', () => {
     });
   });
 
+  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');
+      expect(stdout()).not.toMatch('depth');
+    });
+  });
+
   describe('timeLog', () => {
     test('should return the time between time() and timeEnd() on default timer', () => {
       _console.time();

website/versioned_docs/version-22.x/CLI.md

@@ -212,6 +212,10 @@ Run tests with specified reporters. Run tests with specified reporters. Example
 
 `jest --reporters="default" --reporters="jest-junit"`
 
+### `--roots`
+
+A list of paths to directories that Jest should use to search for files in.
+
 ### `--runInBand`
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.

website/versioned_docs/version-22.x/TutorialReactNative.md

@@ -36,6 +36,19 @@ Let's create a [snapshot test](SnapshotTesting.md) for a small intro component w
 import React, {Component} from 'react';
 import {StyleSheet, Text, View} from 'react-native';
 
+class Intro extends Component {
+  render() {
+    return (
+      <View style={styles.container}>
+        <Text style={styles.welcome}>Welcome to React Native!</Text>
+        <Text style={styles.instructions}>
+          This is a React Native snapshot test.
+        </Text>
+      </View>
+    );
+  }
+}
+
 const styles = StyleSheet.create({
   container: {
     alignItems: 'center',
@@ -55,18 +68,7 @@ const styles = StyleSheet.create({
   },
 });
 
-export default class Intro extends Component {
-  render() {
-    return (
-      <View style={styles.container}>
-        <Text style={styles.welcome}>Welcome to React Native!</Text>
-        <Text style={styles.instructions}>
-          This is a React Native snapshot test.
-        </Text>
-      </View>
-    );
-  }
-}
+export default Intro;
 ```
 
 Now let's use React's test renderer and Jest's snapshot feature to interact with the component and capture the rendered output and create a snapshot file:

website/versioned_docs/version-23.x/CLI.md

@@ -224,6 +224,10 @@ Run tests with specified reporters. Example with multiple reporters:
 
 `jest --reporters="default" --reporters="jest-junit"`
 
+### `--roots`
+
+A list of paths to directories that Jest should use to search for files in.
+
 ### `--runInBand`
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.

website/versioned_docs/version-24.x/CLI.md

@@ -245,6 +245,10 @@ Run tests with specified reporters. Example with multiple reporters:
 
 `jest --reporters="default" --reporters="jest-junit"`
 
+### `--roots`
+
+A list of paths to directories that Jest should use to search for files in.
+
 ### `--runInBand`
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.

website/versioned_docs/version-25.x/CLI.md

@@ -255,6 +255,10 @@ Run tests with specified reporters. [Reporter options](configuration#reporters-a
 
 `jest --reporters="default" --reporters="jest-junit"`
 
+### `--roots`
+
+A list of paths to directories that Jest should use to search for files in.
+
 ### `--runInBand`
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.

website/versioned_docs/version-25.x/TutorialReactNative.md

@@ -36,6 +36,19 @@ Let's create a [snapshot test](SnapshotTesting.md) for a small intro component w
 import React, {Component} from 'react';
 import {StyleSheet, Text, View} from 'react-native';
 
+class Intro extends Component {
+  render() {
+    return (
+      <View style={styles.container}>
+        <Text style={styles.welcome}>Welcome to React Native!</Text>
+        <Text style={styles.instructions}>
+          This is a React Native snapshot test.
+        </Text>
+      </View>
+    );
+  }
+}
+
 const styles = StyleSheet.create({
   container: {
     alignItems: 'center',
@@ -55,18 +68,7 @@ const styles = StyleSheet.create({
   },
 });
 
-export default class Intro extends Component {
-  render() {
-    return (
-      <View style={styles.container}>
-        <Text style={styles.welcome}>Welcome to React Native!</Text>
-        <Text style={styles.instructions}>
-          This is a React Native snapshot test.
-        </Text>
-      </View>
-    );
-  }
-}
+export default Intro;
 ```
 
 Now let's use React's test renderer and Jest's snapshot feature to interact with the component and capture the rendered output and create a snapshot file:

website/versioned_docs/version-26.0/CLI.md

@@ -251,6 +251,10 @@ Run tests with specified reporters. [Reporter options](configuration#reporters-a
 
 `jest --reporters="default" --reporters="jest-junit"`
 
+### `--roots`
+
+A list of paths to directories that Jest should use to search for files in.
+
 ### `--runInBand`
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.

website/versioned_docs/version-26.2/CLI.md

@@ -251,6 +251,10 @@ Run tests with specified reporters. [Reporter options](configuration#reporters-a
 
 `jest --reporters="default" --reporters="jest-junit"`
 
+### `--roots`
+
+A list of paths to directories that Jest should use to search for files in.
+
 ### `--runInBand`
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.

website/versioned_docs/version-26.5/CLI.md

@@ -267,6 +267,10 @@ Run tests with specified reporters. [Reporter options](configuration#reporters-a
 
 `jest --reporters="default" --reporters="jest-junit"`
 
+### `--roots`
+
+A list of paths to directories that Jest should use to search for files in.
+
 ### `--runInBand`
 
 Alias: `-i`. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.