How brahimdahmani/simplecov-markdown-pr works
SimpleCov Markdown Pro is a small Ruby formatter gem: SimpleCov supplies a coverage result, and the formatter returns a Markdown report while optionally writing it to the coverage directory or printing it to stdout. Its core stages are report assembly, group/file presentation, missing-line compression, and output. Configuration, table rendering, and versioning are internal modules. Relationships are based on the formatter excerpt and README; the README documents the SimpleCov API workflow and major reporting features.
Main entry points: markdown_pro_formatter.rb Markdown formatter · simplecov-markdown-pro.rb Gem entrypoint · table_builder.rb Markdown tables · configuration.rb Configuration
Components 15
SimpleCov integration
- Gem entrypoint
lib/simplecov-markdown-pro.rb - Markdown formatter
lib/simplecov/formatter/markdown_pro_formatter.rb
Report generation
- Report assembly
lib/simplecov/formatter/markdown_pro_formatter.rb - Group sections
lib/simplecov/formatter/markdown_pro_formatter.rb - File coverage tables
lib/simplecov/formatter/markdown_pro_formatter.rb - Report output
lib/simplecov/formatter/markdown_pro_formatter.rb
Formatter support
- Configuration
lib/simplecov/formatter/markdown_pro/configuration.rb - Version
lib/simplecov/formatter/markdown_pro/version.rb - Missing-line ranges
lib/simplecov/formatter/markdown_pro/line_ranges.rb - Markdown tables
lib/simplecov/formatter/markdown_pro/table_builder.rb
Other components
- Formatter user
- SimpleCov
- Coverage result
- Markdown file
- Standard output
Connections 17
- Formatter user → Gem entrypoint: requires gem
README.md - Gem entrypoint → Markdown formatter: loads
lib/simplecov-markdown-pro.rb - Formatter user → SimpleCov: configures formatter
README.md - SimpleCov → Markdown formatter: calls format
README.md - Markdown formatter → Configuration: uses settings
lib/simplecov/formatter/markdown_pro_formatter.rb - Markdown formatter → Version: requires
lib/simplecov/formatter/markdown_pro_formatter.rb - Markdown formatter → Report assembly: builds report
lib/simplecov/formatter/markdown_pro_formatter.rb - SimpleCov → Coverage result: provides result
README.md - Markdown formatter → Coverage result: reads coverage
lib/simplecov/formatter/markdown_pro_formatter.rb - Report assembly → Group sections: assembles groups
lib/simplecov/formatter/markdown_pro_formatter.rb - Report assembly → Markdown tables: builds summary table
lib/simplecov/formatter/markdown_pro_formatter.rb - Group sections → File coverage tables: builds file tables
lib/simplecov/formatter/markdown_pro_formatter.rb - File coverage tables → Missing-line ranges: compresses missing lines
lib/simplecov/formatter/markdown_pro_formatter.rb - File coverage tables → Markdown tables: renders tables
lib/simplecov/formatter/markdown_pro_formatter.rb - Markdown formatter → Report output: returns report
lib/simplecov/formatter/markdown_pro_formatter.rb - Markdown formatter → Markdown file: writes report
lib/simplecov/formatter/markdown_pro_formatter.rb - Markdown formatter → Standard output: prints report
lib/simplecov/formatter/markdown_pro_formatter.rb