Contents

# SorbetProgress

Measure your progress as you adopt [sorbet](https://sorbet.org/). I find that 
measuring progress keeps me motivated, which is crucial to finishing a project.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'sorbet-progress'
```

Then:

    bundle

Or install it yourself:

    gem install sorbet-progress

## Usage

```bash
bundle exec srb tc --metrics-file /tmp/sorbet_metrics.json
# No errors! Great job.
bundle exec sorbet_progress /tmp/sorbet_metrics.json
# Sorbet Progress

# Progress for sig coverage
# total_signatures 	7528
# total_methods    	183447
# total_classes    	112433

# Progress for file coverage
# sigil_ignore     	12	    0.20 %
# sigil_false      	5466	    91.60 %
# sigil_true       	460	    7.71 %
# sigil_strict     	12	    0.20 %
# sigil_strong     	17	    0.28 %
# ---------------------------------------
# Total: 		5967	100%
# Keep up the good work 👍
```

Not sure what the best format is. Pull requests welcome. It might be nice to
have an overall percentage, for example.

## Contributing

This project does not accept bug reports. Pull requests are welcome.

This project is intended to be a safe, welcoming space for collaboration, and
contributors are expected to adhere to the [code of conduct](/CODE_OF_CONDUCT.md)

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
sorbet-progress-0.2.5	README.md
sorbet-progress-0.2.4	README.md