Edit

Reek

Supported VersionLanguageWebsite
4.4.0+ (default: 6.0.2)Ruby 2.7.2https://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:
    gems:
      - name: "reek"
        version: "5.2.0"
    target:
      - lib/
      - test/
    config: config/.reek.yml

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

NameTypeDefault
root_dirstring-
gemsstring[], hash[]-
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 in your repository.

Default Configuration

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

← RuboCopQuerly →