Skip to main content

Reek

Supported VersionLanguageWebsite
4.4.0+ (default: 6.0.4)Rubyhttps://github.com/troessner/reek

Reek is a static analysis tool to detect any "Code Smells" in Ruby classes, modules and methods.

Getting Started#

To start using Reek, enable it in your repository settings.

Configuration#

Here is an example configuration via sider.yml:

linter:  reek:    target:      - lib/      - test/    config: config/.reek.yml

You can use the following options to make analysis fitter for your project.

NameTypeDefault
root_dirstring-
dependenciesstring[], map[]-
targetstring, string[].
configstring-

target#

This option allows you to specify files or directories to analyze.

config#

This option allows you to specify your configuration file. If omitted, Reek tries to automatically find a configuration file (.reek.yml) in your repository.

Default Configuration#

When there are no configuration files in your repository, Sider uses the following configuration by default: