Sider Documentation

Sider Documentation

  • Enterprise
  • News
  • Sider Top

›Ruby

Getting Started

  • Home
  • Intro Videos
  • Setting up Sider
  • Dashboard Overview
  • Repository Settings
  • Custom Analysis Configuration
  • Recommended Ruleset
  • Working with Issues
  • Permissions
  • Skip Analyzing

Analysis Tools

    Ruby

    • RuboCop
    • Reek
    • Querly
    • Rails Best Practices
    • Brakeman
    • HAML-Lint
    • Slim-Lint (beta)

    Java

    • Checkstyle
    • PMD
    • JavaSee

    Kotlin

    • ktlint (beta)
    • detekt (beta)

    JavaScript and Flavors

    • ESLint
    • JSHint
    • TyScan
    • CoffeeLint
    • TSLint (deprecated)

    CSS

    • stylelint
    • SCSS-Lint (deprecated)

    PHP

    • PHP_CodeSniffer
    • PHPMD
    • Phinder

    Python

    • Flake8
    • Pylint (beta)

    Swift

    • SwiftLint

    Go

    • GolangCI-Lint

    C/C++

    • Cppcheck
    • cpplint
    • Clang-Tidy (beta)

    C#

    • FxCop (beta)

    Shell script

    • ShellCheck

    Dockerfile

    • hadolint

    Markdown

    • remark-lint

    Others

    • Goodcheck
    • Misspell
    • LanguageTool (beta)
    • PMD CPD (beta)

Custom Rules

  • Intro to Custom Rules
  • Goodcheck
  • Tips & Tricks

Advanced Settings

  • Inline Comments
  • Private Dependencies
  • Restricting access to Close button
  • Transferring a repository

Billing and Plans

  • Billing and Plans

Troubleshooting

  • Troubleshooting

Enterprise

  • Outline
  • System Overview
  • Installation
  • Configuration
  • Operation
  • Update
  • Load Balancer
  • MySQL
  • Redis
  • MinIO
  • Amazon S3
  • GitHub Enterprise Server
  • Clustering
  • Example Deployments

    • Single Node with Docker Compose

    Releases

    • Overview
    • February 2021
    • January 2021
    • December 2020
    • October 2020
    • September 2020
    • August 2020
    • July 2020
    • June 2020
    • May 2020
    • April 2020
    • February 2020
    • January 2020
    • November 2019
    • Older releases

News

  • 2021
  • 2020
  • 2019
Edit

Reek

Supported VersionLanguageWebsite
4.4.0+ (default: 6.0.3)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:
    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 (.reek.yml) in your repository.

Default Configuration

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

  • For the Reek v4
  • For the Reek v5
← RuboCopQuerly →
  • Getting Started
  • Configuration
    • target
    • config
  • Default Configuration
Sider Documentation
Docs
Getting StartedAnalysis ToolsEnterprise
Sider
Sider TopTerms of ServicePrivacy
Social
BlogGitHubStar
Copyright © 2021 Sider, Inc.