Basic Smell Options

Every smell detector in Reek offers at least the following configuration options:

Option	Value	Effect
`enabled`	Boolean	Determines whether the smell detector is active. Defaults to `true`
`exclude`	an array of strings or regular expressions	Ignores any context whose full description (see %c in Command-Line Options) matches any element of this array.

The file config/defaults.reek (shipped with the Reek gem) lists any default exclusions for each smell.

Example

To stop Reek reporting smells in any method called write you might create a configuration file containing this:

---
ControlCouple: 
  exclude:
  - write

or this:

---
ControlCouple: 
  exclude:
  - !ruby/regexp /write/

Last edited by kevinrutherford, Mon Jun 15 05:24:23 -0700 2009

Home | Edit | New

Versions: