From 5cdf46b740c2274e1085407ea7c8f9eee59cef66 Mon Sep 17 00:00:00 2001 From: Kanad Gupta Date: Fri, 22 Nov 2024 10:35:43 -0600 Subject: [PATCH] docs: enhance note around console output suppression --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b5e3fbd..ef3e1fa 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,11 @@ See the [V4 Migration Guide](./MIGRATION.md) if you are migrating from v3 or old `@oclif/test` provides a handful of utilities that make it easy to test your [oclif](https://oclif.io) CLI. -**NOTE for jest users** - in order for these utilities to capture all output to the terminal, you must set `verbose: true` in your jest config to prevent jest from supressing any output. See https://jestjs.io/docs/configuration#verbose-boolean for more +> [!NOTE] +> In order for these utilities to capture all output to the terminal, you must disable any console output interception/suppression features in your test framework. +> +> - For Jest users, enable [the `verbose` flag](https://jestjs.io/docs/configuration#verbose-boolean) in your Jest config. +> - For Vitest users, enable [the `disableConsoleIntercept` flag](https://vitest.dev/guide/cli.html#disableconsoleintercept) in your Vitest config. ### `captureOutput`