Logo: Relish

  1. Sign in

Project: RSpec Core 2.6

Publisher: RSpec

--format option

Use the --format option to tell RSpec how to format the output.

RSpec ships with a few formatters built in. By default, it uses the progress
formatter, which generates output like this:

....F.....*.....

A '.' represents a passing example, 'F' is failing, and '*' is pending.

To see the documentation strings passed to each describe(), context(), and it()
method, use the documentation formatter:

$ rspec spec --format documentation

You can also specify an output target (STDOUT by default) by appending a
filename to the argument:

$ rspec spec --format documentation:rspec.output.txt

Background
Given
a file named "example_spec.rb" with: 
describe "something" do
  it "does something that passes" do
    5.should eq(5)
  end

  it "does something that fails" do
    5.should eq(4)
  end

  it "does something that is pending", :pending => true do
    5.should be > 3
  end
end
Scenarios
  1. progress bar format (default)
  2. documentation format
  3. documentation format saved to a file
  4. multiple formats
progress bar format (default)
When
I run rspec example_spec.rb
Then
the output should contain ".F*"
documentation format
When
I run rspec example_spec.rb --format documentation
Then
the output should contain: 
something
  does something that passes
  does something that fails (FAILED - 1)
  does something that is pending (PENDING: Not Yet Implemented)
documentation format saved to a file
When
I run rspec example_spec.rb --format documentation --out rspec.txt
Then
the file "rspec.txt" should contain: 
something
  does something that passes
  does something that fails (FAILED - 1)
  does something that is pending (PENDING: Not Yet Implemented)
multiple formats
When
I run rspec example_spec.rb --format progress --format documentation --out rspec.txt
Then
the output should contain ".F*"
And
the file "rspec.txt" should contain: 
something
  does something that passes
  does something that fails (FAILED - 1)
  does something that is pending (PENDING: Not Yet Implemented)

Last published about 6 years ago by dchelimsky.