Skip to content

simplecov-ruby/simplecov-html

Repository files navigation

Default HTML formatter for SimpleCov

Note: To learn more about SimpleCov, check out the main repo at https://github.com/simplecov-ruby/simplecov

Generates a nice HTML report of your SimpleCov ruby code coverage results on Ruby 2.4+ using client-side Javascript quite extensively.

Note on Patches/Pull Requests

The formatter itself has no actual tests. Instead, it is tested in the cucumber features of simplecov itself. If you modify the formatter, please make sure the simplecov test suites still pass by doing the following:

  • Clone simplecov into the parent directory of your simplecov-html checkout
  • cd there, run bundle
  • You should end up with all dev dependencies installed and simplecov-html being used from your disk
  • Run the tests (units and features)

Please remember to add tests if you add functionality.

Important: If you modify the JS/CSS assets, you'll have to precompile them using rake assets:compile - otherwise, your changes will not be included in your coverage reports.

Copyright

Copyright (c) 2010-2013 Christoph Olszowka. See LICENSE for details.