docs/Configuration-Files.md in reek-2.2.1 vs docs/Configuration-Files.md in reek-3.0.0

- old
+ new

@@ -12,11 +12,11 @@ The order in which `reek` tries to find such a configuration file is exactly like above: First `reek` checks if we have given it a configuration file explicitly via CLI. Then it checks the current working directory for a file and if it can't find one, it traverses up the directories until it hits the root directory. And lastly, it checks your HOME directory. As soon as `reek` detects a configuration file it stops searching immediately, meaning that from `reek`'s point of view there exists one configuration file and one configuration only regardless of how many ".reek" files you might have on your filesystem. -## Configuration options +## Configuration options for smells The first thing you probably want to check out are the [Basic Smell Options](Basic-Smell-Options.md) which are supported by every smell type. Certain smell types offer a configuration that goes beyond that of the basic smell options - for instance [Data Clump](Data-Clump.md). All options that go beyond the [Basic Smell Options](Basic-Smell-Options.md) should be documented in the corresponding smell type wiki page but if you want to get a quick and full overview over all possible configurations you can always check out [the default.reek file in this repository](https://github.com/troessner/reek/blob/master/config/defaults.reek). @@ -33,6 +33,17 @@ - "BookingRequestsController#vehicle_options" # respond_to block - "Content::Base#self.expose_fields" # unavoidable due to metaprogramming DataClump: max_copies: 3 min_clump_size: 3 +``` + +## Excluding directories from scans + +You can exclude whole directories from scans using `exclude_paths` in your configuration file: + +```yaml +--- +exclude_paths: + - app/views + - app/controllers ```