Path: | lib/rspec/core/formatters.rb |
Last Update: | Tue Feb 26 14:30:03 +0100 2013 |
## Built-in Formatters
The progress formatter is the default, but you can choose any one or more of the other formatters by passing with the `—format` (or `-f` for short) command-line option, e.g.
rspec --format documentation
You can also send the output of multiple formatters to different streams, e.g.
rspec --format documentation --format html --out results.html
This example sends the output of the documentation formatter to `STDOUT`, and the output of the html formatter to results.html.
## Custom Formatters
You can tell RSpec to use a custom formatter by passing its path and name to the `rspec` commmand. For example, if you define MyCustomFormatter in path/to/my_custom_formatter.rb, you would type this command:
rspec --require path/to/my_custom_formatter.rb --format MyCustomFormatter
The reporter calls every formatter with this protocol:
You can either implement all of those methods or subclass `RSpec::Core::Formatters::BaseTextFormatter` and override the methods you want to enhance.
@see RSpec::Core::Formatters::BaseTextFormatter @see RSpec::Core::Reporter