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

RuboCop

Supported VersionLanguageWebsite
0.61.0+ (default: 1.10.0)Rubyhttps://rubocop.org

RuboCop is a pluggable static code analyzer and code formatter for Ruby. It has been community-driven developed and has many rules and plugins including third-party's ones.

Getting Started

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

If you want to customize RuboCop, run the following command in your project' root directory:

$ rubocop --init

See also the user guide for details.

Default Configuration for RuboCop

If a .rubocop.yml file does not exist in your repository, Sider uses the default configuration including the MeowCop gem.

Configuration

Here is an example configuration via sider.yml:

linter:
  rubocop:
    gems:
      - rubocop-rspec
    config: config/.rubocop.yml
    safe: true

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

NameTypeDefault
root_dirstring-
gemsstring[], hash[]-
configstring-
safebooleanfalse

config

This option allows you to specify your configuration file. If omitted, the RuboCop default configuration is used.

safe

This option allows you to select whether running only safe cops or not. If confirming whether a cop is safe or not, see the cops' document.

rails

DEPRECATED: The option is ignored when using the version 0.72.0 or later, and will be removed in the future. Use rubocop-rails instead.

This option allows you to select whether using Rails cops or not. If omitted, Sider automatically determines it.

← Skip AnalyzingReek →
  • Getting Started
  • Default Configuration for RuboCop
  • Configuration
    • config
    • safe
    • rails
Sider Documentation
Docs
Getting StartedAnalysis ToolsEnterprise
Sider
Sider TopTerms of ServicePrivacy
Social
BlogGitHubStar
Copyright © 2021 Sider, Inc.