whitesmith / whitesmith/rubycritic
Feature Request: Display Total Coverage Percentage in SimpleCov Index
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 3.5k
- Forks
- 234
- PR merge metrics
- No merged PRs in 30d
Description
Display total coverage percentage in SimpleCov index
Would be nice to show the overall project coverage percentage in the SimpleCov index page. Right now it only shows individual file coverage, but I often want to see the total coverage number (like "45.5%") at a glance.
I implemented this using SimpleCov's covered_percent method from the SimpleCov::Result object. The changes:
- Added a method to expose the
SimpleCov::Resultfrom theCoverageanalyser - Added
total_coverageto theSimpleCovIndexgenerator that displays it in the header - Reused the existing
Coverageanalyser logic (no duplication) - The result is cached when the analyser runs, so there's no performance impact
The implementation uses SimpleCov's own calculation method, so it's accurate and consistent with SimpleCov's reporting.
Screenshot of example working locally.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the Coverage analyser and the SimpleCovIndex generator, then read how the analyser currently obtains coverage data and how the index header is assembled. Reuse the existing SimpleCov::Result covered_percent calculation so the generated index displays the overall percentage alongside the file coverage information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100