Skip to content

Commit b07d076

Browse files
docs: update README to clarify usage of -fail-only flag
1 parent 4d58cce commit b07d076

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Pass | Fail
1212

1313
By default, `tparse` will always return test failures and panics, if any, followed by a package-level summary table.
1414

15-
To get additional info on passed tests run `tparse` with `-pass` flag. Tests are grouped by package and sorted by elapsed time in descending order (longest to shortest).
15+
To get additional info on passed tests run `tparse` with `-pass` flag. To display only failed tests without the summary table, use the `-fail-only` flag. Tests are grouped by package and sorted by elapsed time in descending order (longest to shortest).
1616

1717
### [But why?!](#but-why) for more info.
1818

@@ -47,7 +47,7 @@ Tip: run `tparse -h` to get usage and options.
4747

4848
`tparse` attempts to do just that; return failed tests and panics, if any, followed by a single package-level summary. No more searching for the literal string: "--- FAIL".
4949

50-
But, let's take it a bit further. With `-all` (`-pass` and `-skip` combined) you can get additional info, such as skipped tests and elapsed time of each passed test.
50+
But, let's take it a bit further. With `-all` (`-pass` and `-skip` combined) you can get additional info, such as skipped tests and elapsed time of each passed test. For the opposite use case, use `-fail-only` to display only failed tests.
5151

5252
`tparse` comes with a `-follow` flag to print raw output. Yep, go test pipes JSON, it's parsed and the output is printed back out as if you ran go test without `-json` flag. Eliminating the need for `tee /dev/tty` between pipes.
5353

0 commit comments

Comments
 (0)