Reek

What Reek is

Reek is a free, open-source tool for examining Ruby classes, modules, and methods for code smells. It can inspect directories or source files and accept Ruby code through standard input. Detectors report issues such as Feature Envy, Large Class, Long Parameter List, Too Many Statements, Uncommunicative Name, and Unused Parameters. Results can be emitted as plain text, HTML, YAML, JSON, XML, or GitHub output. Configuration uses a `.reek.yml` file, while source comments can suppress selected warnings. The project describes directory-specific settings for Rails paths such as `app/controllers` and `app/models`. Listed editor integrations include Vim, TextMate, Atom, SublimeLinter, VS Code, and Emacs. Workflow projects include overcommit, ruby-critic, pronto-reek, and action-reek. Installation is through RubyGems with `gem install reek`. Official support covers CRuby 3.0 through 3.3 and JRuby 9.4. The repository uses the MIT license, and version 6.5.0 is listed in the changelog. Reek identifies higher-level smells but does not provide generic fixes, because appropriate changes depend on domain language and business logic.