From 57cece8e788068117a6785dfa30105a2010dd650 Mon Sep 17 00:00:00 2001 From: Fredrik Averpil Date: Sun, 8 Dec 2024 15:27:22 +0100 Subject: [PATCH] docs: improve gotestsum docs --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7f51557b..3b223789 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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