minitest-rg

= minitest-rg

home :: https://github.com/minitest/minitest-rg bugs :: https://github.com/minitest/minitest-rg/issues

{rdoc-image:https://github.com/minitest/minitest-rg/actions/workflows/ci.yml/badge.svg}[https://github.com/minitest/minitest-rg/actions/workflows/ci.yml] {rdoc-image:https://github.com/minitest/minitest-rg/actions/workflows/github-code-scanning/codeql/badge.svg}[https://github.com/minitest/minitest-rg/actions/workflows/github-code-scanning/codeql]

Adds red/green color to your Minitest output.

== Install

gem install minitest-rg

== Configure

Add the following to your test helper:

require "minitest/rg"

Or you can run your tests with the --rg flag:

$ ruby test/test_the_thing.rb --rg

Or if you are using a rake task to run your tests you can set the --rg flag in the TESTOPTS environment variable.

$ rake test TESTOPTS="--rg"

== Get Involved

Join the Github discussions to get help or offer suggestions:

https://github.com/minitest/minitest-rg/discussions

Report bugs by opening an issue:

https://github.com/minitest/minitest-rg/issues

Contribute changes by creating a pull request:

https://github.com/minitest/minitest-rg/pulls

== License

Copyright (c) 2023 Mike Moore

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.