Make support/rspec.rb closer to RSpec default #20
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
Having this file be completely devoid of comments makes it harder for people to understand, particularly when many of the RSpec configuration options have significant impact on the features available when using the tool. `rspec —init`, on the other hand, creates a spec_helper.rb with *lots* of comments. Probably a little too much. As a compromise, copy the most helpful aspects of the comments from the default spec_helper.rb to our support/rspec.rb, condensing the text wherever possible. In addition, enable the one feature from the `rspec —init` output that was missing in our file: `config.example_status_persistence_file_path`. This is a very helpful feature and it would be good for our users to have access to this by default. Leave this configured with the default “spec/examples.txt”, and in our `hanami install` hook, update the `.gitignore` file to ignore it.
Even when running tests for the getting started guide, this was resulting in some warnings being output (for e.g. the debug gem). To reduce noisy and give people greater confidence with their first tests, disable this by default. Leave a comment recommending that the user turn it on if they choose.
jodosha
approved these changes
Nov 6, 2023
“Hanami app” was too generic. By using “Rack::Test” here, we make it clearer that this shared context is specific for Rack::Test specs only.
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.
Having this file be completely devoid of comments makes it harder for people to understand, particularly when many of the RSpec configuration options have significant impact on the features available when using the tool.
rspec --init, on the other hand, creates a spec_helper.rb with lots of comments. Probably a little too much.As a compromise, copy the most helpful aspects of the comments from the default
spec_helper.rbto oursupport/rspec.rb, condensing the text wherever possible.In addition, enable the one feature from the
rspec --initoutput that was missing in our file:config.example_status_persistence_file_path. This is a very helpful feature and it would be good for our users to have access to this by default. Leave this configured with the default"spec/examples.txt", and in ourhanami installhook, update the.gitignorefile to ignore it.