Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 1.73 KB

README.md

File metadata and controls

62 lines (45 loc) · 1.73 KB
Raw

Rspec Stats

Installation

To use this segment, you need to activate it by adding rspec_stats to your P9K_LEFT_PROMPT_ELEMENTS or P9K_RIGHT_PROMPT_ELEMENTS array, depending where you want to show this segment.

States

This segment can have different states. You can customize the different states as you wish. Here is a quick overview:

Configuration

See Unit Test Ratios, below.

Color Customization

You can change the foreground and background color of this segment by setting

# Tests Coverage Good
P9K_RSPEC_STATS_TEST_STATS_GOOD_FOREGROUND='red'
P9K_RSPEC_STATS_TEST_STATS_GOOD_BACKGROUND='blue'

# Tests Coverage Average
P9K_RSPEC_STATS_TEST_STATS_AVG_FOREGROUND='red'
P9K_RSPEC_STATS_TEST_STATS_AVG_BACKGROUND='blue'

# Tests Coverage Bad
P9K_RSPEC_STATS_TEST_STATS_BAD_FOREGROUND='red'
P9K_RSPEC_STATS_TEST_STATS_BAD_BACKGROUND='blue'

Customize Icon

The main Icon of this segment depends on its state. It can be changed by setting:

P9K_RSPEC_STATS_TEST_STATS_GOOD_ICON="my_icon"
P9K_RSPEC_STATS_TEST_STATS_AVG_ICON="my_icon"
P9K_RSPEC_STATS_TEST_STATS_BAD_ICON="my_icon"

The Icon color accordingly:

P9K_RSPEC_STATS_TEST_STATS_GOOD_ICON_COLOR="red"
P9K_RSPEC_STATS_TEST_STATS_AVG_ICON_COLOR="red"
P9K_RSPEC_STATS_TEST_STATS_BAD_ICON_COLOR="red"

Quality of Test Ratios

This segment shows a ratio of "real" classes vs test classes in your source code. This is just a very simple ratio, and does not show your code coverage or any sophisticated stats. All this does is count your source files and test files, and calculate the ratio between them. Just enough to give you a quick overview about the test situation of the project you are dealing with.