Skip to content

RSpec-style documentation output - fewer changes#1670

Open
woodie wants to merge 6 commits into
onsi:masterfrom
woodie:add_fd_flag_v2
Open

RSpec-style documentation output - fewer changes#1670
woodie wants to merge 6 commits into
onsi:masterfrom
woodie:add_fd_flag_v2

Conversation

@woodie

@woodie woodie commented Jun 5, 2026

Copy link
Copy Markdown

The goal is better integration without bolting on. The issue is here.

You can opt into documentation format output with ginkgo -fd. This emits a hierarchical tree of spec descriptions, with each spec's name colored green for passing, red for failing, yellow for pending, and cyan for skipped, along with a summary of failures at the end of the suite. This mode will be familiar to Rspec users and has more concise output for very large test suites.

This attempts to integrate with minimal changes and should work better with future refactoring.

@onsi

onsi commented Jun 5, 2026

Copy link
Copy Markdown
Owner

thanks @woodie - i think i see you’ve got two PRs going? Let me know when the dust settles and you’d like me to take a look.

@woodie

woodie commented Jun 5, 2026

Copy link
Copy Markdown
Author

thanks @woodie - i think i see you’ve got two PRs going? Let me know when the dust settles and you’d like me to take a look.

Both PRs are almost identical with slight changes to reporters/default_reporter.go:
1669 may feel bolted on with several methods starting with a short cirtuit.if r.conf.FdOutput { return }
1670 attempts to integrate with minimal changes and should work better with future refactoring.

I've renamed the PRs. I like the 2nd approach as only so many things can be bolted on without creating a mess.

@woodie woodie changed the title Another approach to RSpec-style documentation output RSpec-style documentation output - fewer changes Jun 5, 2026
@woodie

woodie commented Jun 6, 2026

Copy link
Copy Markdown
Author

OK, I like this PR @onsi. I did post a couple questions in the Issue. The dust has settled for me.

@woodie

woodie commented Jun 18, 2026

Copy link
Copy Markdown
Author

Hey @onsi, are we ready to merge this?

@onsi

onsi commented Jun 18, 2026

Copy link
Copy Markdown
Owner

hey sorry - i'd missed your earlier reply on the issue.

I think this will work great if the user simply runs ginkgo -fd. but if they run ginkgo -p -fd or ginkgo -randomize-all -fd it will generate interleaved output that won't make sense. I think that's fine (changing the behavior is likely too complex - and doesn't match the use-case), but I think what we'd want is to have Ginkgo emit an error and refuse to run if you mix -fd with -p, -numProcs=N (with N>1), or -randomize-all. Are you up for adding that guard?

Alternatively, if you've tried it with -p and -randomize-all and think the output is fine, lemme know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants