Search code examples
ruby-on-railsrubyruby-on-rails-4rspecruby-on-rails-5

Can I set rspec --format documentation as the default?


Per the Rspec documentation, by default when you run rspec you get the progress formatter (looks like this: ".....").

There is another formatting option rspec --format documentation that goes through each test one by one. My question: how can I enable --format documentation by default without having to type it in the command line every time?


Solution

  • Option 1

    Add it to .rspec file (or create one in the project's root directory) - options added to it will be applied to every test run within current project:

    # .rspec
    --color
    --format documentation
    

    Option 2

    Add it to RSpec.configure block:

    RSpec.configure do |config|
      config.formatter = :documentation
    end
    

    Option 3

    Specify rspec's options globally by adding them to ~/.rspec.