README.md in reek-6.0.0 vs README.md in reek-6.0.1
- old
+ new
@@ -284,19 +284,19 @@
detectors:
# You can disable smells completely
IrresponsibleModule:
enabled: false
-
+
# You can use filters to silence Reek warnings.
# Either because you simply disagree with Reek (we are not the police) or
# because you want to fix this at a later point in time.
NestedIterators:
exclude:
- "MyWorker#self.class_method" # should be refactored
- "AnotherWorker#instance_method" # should be refactored as well
-
+
# A lot of smells allow fine tuning their configuration. You can look up all available options
# in the corresponding smell documentation in /docs. In most cases you probably can just go
# with the defaults as documented in defaults.reek.yml.
DataClump:
max_copies: 3
@@ -347,13 +347,18 @@
```yaml
---
detectors:
IrresponsibleModule:
enabled: false
-
+
TooManyStatements:
max_statements: 5
+
+directories:
+ "app/controllers":
+ TooManyStatements:
+ max_statements: 10
```
translates to:
* IrresponsibleModule is disabled everywhere
@@ -605,9 +610,10 @@
* [overcommit](https://github.com/brigade/overcommit) - a Git commit hook manager with support for
Reek
* [ruby-critic](https://github.com/whitesmith/rubycritic) - gem that wraps around static analysis gems such as Reek, [flay](https://github.com/seattlerb/flay) and [flog](https://github.com/seattlerb/flog)
* [pronto-reek](https://github.com/mmozuras/pronto-reek) - Reek integration for [pronto](https://github.com/mmozuras/pronto)
+* [action-reek](https://github.com/reviewdog/action-reek) - GitHub Action to run reek with [reviewdog](https://github.com/reviewdog/reviewdog) 🐶
### Misc
* [Colorful output for Reek](https://github.com/joenas/preek)
(also with [Guard::Preek](https://github.com/joenas/guard-preek))