Skip to content

renuo/simplecov-markdown

 
 

Repository files navigation

SimpleCov Markdown Formatter

Gem Version CI

Adds a report in markdown format. This can be useful in CI context or for LLMs.

Install

gem install simplecov-markdown

Usage

require 'simplecov-markdown'
SimpleCov.formatter = SimpleCov::Formatter::MarkdownFormatter

if you want to configure multiple formatters:

SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
                                                                 SimpleCov::Formatter::HTMLFormatter,
                                                                 SimpleCov::Formatter::MarkdownFormatter
                                                               ])

Alternatives

LLMs and CI environments work well also with simplecov-console.

Changelog

1.1.0

  • Support branch coverage

1.0.0

  • Sorted results by coverage — files are now sorted ascending by coverage percentage, so the least covered files appear first
  • Missing line numbers — the report now includes a "Missing line numbers" column listing the exact line numbers not covered, instead of just a count
  • Revised table columns — columns reordered and renamed: Coverage, File, Total lines, Total missed, Missing line numbers
  • Ruby 4.0 support — tested against Ruby 3.2, 3.3, and 4.0 via GitHub Actions CI
  • Dropped legacy dependencies — removed coveralls, rspec-temp_dir, and loosened bundler/rake version constraints

0.2.0

Initial release by holyshared.

About

SimpleCov formatter to generate a markdown report

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Ruby 100.0%