Use doc formatter when running a single spec file #1309
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
By default, rspec uses the "progress formatter" to output the status of running our test suite -- this is the one that outputs a single character for each executed test: ./F/*. This is the correct default to avoid a deluge of text whenever we run the test suite. But when developing some specific component, it's common that you run rspec only for a single spec file. In that case, there's not a lot of tests so it's nice to switch to the documentation formatter that prints a nice looking description for each test. So there's a nice trick that rspec itself adds to the `spec_helper.rb` when you initialize it on a new project with `rspec --init`, which is to switch to the documentation formatter only when there's a single spec file to run. I claim this gives us the best of both worlds :)
Codecov Report
@@ Coverage Diff @@
## master #1309 +/- ##
=======================================
Coverage 98.13% 98.13%
=======================================
Files 752 752
Lines 35783 35783
=======================================
Hits 35117 35117
Misses 666 666
Continue to review full report at Codecov.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
By default, rspec uses the "progress formatter" to output the status
of running our test suite -- this is the one that outputs a single
character for each executed test: ./F/*. This is the correct default
to avoid a deluge of text whenever we run the test suite.
But when developing some specific component, it's common that you run
rspec only for a single spec file. In that case, there's not a lot of
tests so it's nice to switch to the documentation formatter that
prints a nice looking description for each test.
So there's a nice trick that rspec itself adds to the
spec_helper.rbwhen you initialize it on a new project with
rspec --init, which isto switch to the documentation formatter only when there's a single
spec file to run.
I claim this gives us the best of both worlds :)