Skip to content

Commit

Permalink
Merge pull request #656 from kanadgupta/main
Browse files Browse the repository at this point in the history
docs: enhance note around console output suppression
  • Loading branch information
mdonnalley authored Nov 26, 2024
2 parents ad34a57 + 5cdf46b commit e72842a
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down

0 comments on commit e72842a

Please sign in to comment.