# simplecov-console A simple console output formatter for SimpleCov ## Usage ```bash $ gem install simplecov-console ``` ```ruby SimpleCov.formatter = SimpleCov::Formatter::Console # or SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([ SimpleCov::Formatter::HTMLFormatter, SimpleCov::Formatter::Console, ]) ``` Example output: ```text COVERAGE: 82.34% -- 2345/2848 lines in 111 files showing bottom (worst) 15 of 69 files +----------+--------------------------------------------+-------+--------+---------------------------------------------+ | coverage | file | lines | missed | missing | +----------+--------------------------------------------+-------+--------+---------------------------------------------+ | 22.73% | lib/bixby/api/websocket_server.rb | 22 | 17 | 11, 14, 17-18, 20-22, 24, 28-30, 32, 36-... | | 30.77% | app/models/role.rb | 13 | 9 | 28-34, 36-37 | | 32.14% | lib/bixby/modules/metrics/rescan.rb | 28 | 19 | 19-23, 27-31, 33-37, 39-41, 43 | | 42.86% | lib/archie/mail.rb | 14 | 8 | 6-8, 12-15, 22 | | 44.00% | lib/archie/controller.rb | 50 | 28 | 18-21, 23, 27-30, 32, 38-40, 44-45, 48-4... | | 44.44% | app/models/metric_info.rb | 9 | 5 | 38-40, 42, 44 | | 46.15% | lib/bixby/modules/notifier.rb | 13 | 7 | 13-14, 27-28, 38-40 | | 46.15% | lib/archie/otp/controller.rb | 26 | 14 | 15-18, 21, 26-27, 31, 33-34, 36-38, 41 | | 46.88% | app/controllers/rest/models/hosts_contr... | 32 | 17 | 7, 19-22, 24, 28-30, 32, 36-38, 42-44, 48 | | 47.83% | lib/bixby/hooks.rb | 46 | 24 | 54, 68-70, 72-74, 84-86, 88-90, 104, 111... | | 48.28% | app/controllers/rest/models/checks_cont... | 29 | 15 | 5, 7-8, 10, 13, 34, 38-40, 44-45, 47, 49... | | 48.44% | app/controllers/application_controller.rb | 64 | 33 | 19, 35-37, 57, 59-64, 67, 88, 92, 107, 1... | | 50.00% | app/views/models/repo.rb | 12 | 6 | 10, 12-13, 16-17, 20 | | 54.55% | lib/ext/sidekiq_logging.rb | 11 | 5 | 9, 15-17, 19 | | 60.00% | app/views/models/check_template.rb | 10 | 4 | 10-13 | +----------+--------------------------------------------+-------+--------+---------------------------------------------+ 42 file(s) with 100% coverage not shown ``` ## Configuration simplecov-console is configurable through environment variables and/or via Ruby code, generally in your test helper or setup file. ### Options ```ruby SimpleCov::Formatter::Console.sort = 'path' # sort by file path SimpleCov::Formatter::Console.show_covered = true # show all files in coverage report SimpleCov::Formatter::Console.max_rows = 15 # integer SimpleCov::Formatter::Console.max_lines = 5 # integer SimpleCov::Formatter::Console.missing_len = 20 # integer SimpleCov::Formatter::Console.output_style = 'block' # 'table' (default) or 'block' SimpleCov::Formatter::Console.table_options = {:style => {:width => 200}} ``` Note that all options except `table_options` can also be set via env var using the uppercase name, e.g., `MAX_ROWS`. #### Disabling colorized output Color support is active by default. To disable, export `NO_COLOR=1`: ```sh NO_COLOR=1 rake test ``` #### Sorting the output By default the coverage report sorts by coverage % in descending order. To sort alphabetically by path: ```ruby SimpleCov::Formatter::Console.sort = 'path' # sort by file path ``` #### Showing covered files By default, fully covered files are excluded from the report. To include them: ```ruby SimpleCov::Formatter::Console.show_covered = true # show all files in coverage report ``` #### Maximum rows displayed By default, a maximum of 15 files with the worst coverage are displayed in the report. To override this limit: ```ruby SimpleCov::Formatter::Console.max_rows = 20 # integer ``` Setting a value of `-1` or `nil` (in Ruby) will show all files. #### Maximum lines displayed By default, all missing lines will be included for each displayed file. For large source files with poor coverage, this may become unwieldy. To show fewer groups of lines: ```ruby SimpleCov::Formatter::Console.max_lines = 5 # integer ``` #### Maximum length of missing lines As an alternative to the above `max_lines` option, you may limit the missing lines output by number of characters: ```ruby SimpleCov::Formatter::Console.missing_len = 20 # integer ``` #### Table options In some cases, you may need to pass some options to `TerminalTable.new`. For example, if the filenames truncate so much that you can't read them, try increasing the table width: ```ruby SimpleCov::Formatter::Console.table_options = {:style => {:width => 200}} ``` #### Block output style As an alternative to the default table output format, a simpler block format is also available: ```ruby SimpleCov::Formatter::Console.output_style = 'block' ``` Example output: ```text COVERAGE: 82.34% -- 2345/2848 lines in 111 files showing bottom (worst) 5 of 69 files file: lib/bixby/api/websocket_server.rb coverage: 22.73% (17/22 lines) missed: 11, 14, 17-18, 20-22, 24, 28-30, 32, 36-... file: app/models/role.rb coverage: 30.77% (9/13 lines) missed: 28-34, 36-37 file: lib/bixby/modules/metrics/rescan.rb coverage: 32.14% (19/28 lines) missed: 19-23, 27-31, 33-37, 39-41, 43 file: lib/archie/mail.rb coverage: 42.86% (8/14 lines) missed: 6-8, 12-15, 22 file: lib/archie/controller.rb coverage: 44.00% (28/50 lines) missed: 18-21, 23, 27-30, 32, 38-40, 44-45, 48-4... 42 file(s) with 100% coverage not shown ``` ### Branch Coverage Support When branch coverage is [enabled in simplecov](https://github.com/simplecov-ruby/simplecov/tree/818bc2547842a90c607b4fec834320766a8686de#branch-coverage-ruby--25), branch info will automatically be displayed in the output: ```text COVERAGE: 78.26% -- 18/23 lines in 2 files BRANCH COVERAGE: 83.33% -- 5/6 branches in 2 branches +----------+-------------------------------+-------+--------+---------------+-----------------+----------+-----------------+------------------+ | coverage | file | lines | missed | missing | branch coverage | branches | branches missed | branches missing | +----------+-------------------------------+-------+--------+---------------+-----------------+----------+-----------------+------------------+ | 72.22% | lib/simplecov-console-test.rb | 18 | 5 | 10-12, 16, 25 | 83.33% | 6 | 1 | 25[then] | +----------+-------------------------------+-------+--------+---------------+-----------------+----------+-----------------+------------------+ ``` ## History ### 0.9.2 (2024.09.17) - Fix: typo in output ([#24](https://github.com/chetan/simplecov-console/pull/24)) ### 0.9.1 (2021.02.01) - Fix: Don't add ellipsis if line groups are not truncated - thanks [@lbraun](https://github.com/lbraun)! ([#21](https://github.com/chetan/simplecov-console/pull/21)) ### 0.9 (2021.01.21) - Added support for limiting number of lines shown ### 0.8 (2020.11.11) - Added support for branch coverage - thanks [@robotdana](https://github.com/robotdana)! ([#19](https://github.com/chetan/simplecov-console/pull/19)) ### 0.7.2 (2020.03.05) - Fix: table output include ([#17](https://github.com/chetan/simplecov-console/issues/17)) ### 0.7.1 (2020.03.05) - Fix: block output doesn't work with frozen string literal ([#16](https://github.com/chetan/simplecov-console/issues/16)) ### 0.7 (2020.03.04) - Added new 'block' style output option - thanks [@hpainter](https://github.com/hpainter)! ([#15](https://github.com/chetan/simplecov-console/issues/15)) ### 0.6 (2019.11.08) - Added new config options: `sort`, `show_covered`, and `max_rows` ### 0.5 (2019.05.24) - Replaced `hirb` gem with `terminal-table` due to multiple warnings thrown ([#11](https://github.com/chetan/simplecov-console/issues/11)) - Support [disabling colorized](https://no-color.org/) output via `NO_COLOR` env var ## Contributing * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet. * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it. * Fork the project. * Start a feature/bugfix branch. * Commit and push until you are happy with your contribution. * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally. * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it. ### Copyright Copyright (c) 2020 Chetan Sarva. See LICENSE.txt for further details.