Skip to content

Commit

Permalink
docs: improve gotestsum docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fredrikaverpil committed Dec 8, 2024
1 parent a9989f3 commit 57cece8
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,9 +338,9 @@ For a more verbose example, see the "extra everything" example config.

To improve reliability, you can choose to set
[`gotestsum`](https://github.com/gotestyourself/gotestsum) as the test runner.
This tool allows you to use one format for stdout while simultaneously writing
test output to a JSON file. `gotestsum` actually calls `go test` behind the
scenes, so your `go_test_args` configuration remains valid and will still apply.
This tool allows the adapter to write test command output directly to a JSON
file, without going through stdout.

Using `gotestsum` offers the following benefits:

- When you "attach" to a running test, you'll see clean `go test` output instead
Expand All @@ -351,6 +351,9 @@ Using `gotestsum` offers the following benefits:
decoding. Enabling `gotestsum` eliminates these issues, as the test output is
then written directly to file.

`gotestsum` calls `go test` behind the scenes, so your `go_test_args`
configuration remains valid and will still apply.

> [!NOTE]
>
> See
Expand Down

0 comments on commit 57cece8

Please sign in to comment.