README.md in quality-27.0.0 vs README.md in quality-27.1.0
- old
+ new
@@ -1,12 +1,11 @@
[](https://travis-ci.org/apiology/quality)
[](https://coveralls.io/r/apiology/quality?branch=master)
-
# Quality -- code quality ratchet for Ruby
-##Overview
+## Overview
Quality is a tool that runs quality checks on code in git repos using
different analysis tools and makes sure your numbers don't get any
worse over time.
@@ -47,11 +46,10 @@
docker run -v `pwd`:/usr/app -v `pwd`/Rakefile.quality:/usr/quality/Rakefile apiology/quality:latest
```
The default 'latest' tag contains the Ruby tools in a relatively small image. You can also get additional tools (see `Dockerfile.jumbo` in this directory) by using the tag `jumbo-`(version) (e.g., jumbo-latest, jumbo-x.y.z, etc)
-
## How to use - as part of a Ruby-based Rakefile
```bash
$ pip install pep8 flake8
$ brew install cmake icu4c shellcheck scalastyle # OS X
@@ -121,12 +119,12 @@
t.output_dir = 'metrics'
# Pipe-separated regexp string describing what to look for in
# files as 'todo'-like 'punchlist' comments.
#
- # Defaults to 'XXX|TODO'
- t.punchlist_regexp = 'XXX|TODO'
+ # Defaults to 'XXX|TODO|FIXME|OPTIMIZE|HACK|REVIEW|LATER|FIXIT'
+ t.punchlist_regexp = 'XXX|TODO|FIXME|OPTIMIZE|HACK|REVIEW|LATER|FIXIT'
# Exclude the specified list of files--defaults to ['db/schema.rb']
t.exclude_files = ['lib/whatever/imported_file.rb',
'lib/vendor/someone_else_fault.rb']
@@ -145,10 +143,9 @@
## Vendored files
Quality uses GitHub's [linguist](https://github.com/github/linguist) gem to find and classify source files to analyze. In addition to the `exclude_files` and `source_files_exclude_glob` options in Quality, you can refer to Linguists's documentation on [overrides](https://github.com/github/linguist#overrides) to use the `gitattributes` file to mark files as vendored, at which point Quality will not try to analyze them.
-
## Code coverage
You can pull a similar trick with code coverage using SimpleCov in Ruby--put 'simplecov' in your Gemfile, and add the code below into your test_helper.rb or spec_helper.rb.
```