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

Rails Best Practices

Supported VersionLanguageWebsite
1.19.1+ (default: 1.20.0)Rubyhttps://rails-bestpractices.com

Rails Best Practices (abbr. RBP) is a code metric tool to check the quality of Rails code.

Getting Started

To start using Rails Best Practices, enable it in your repository settings.

Configuration

Here is an example configuration via sider.yml:

linter:
  rails_best_practices:
    gems:
      - "slim"
    config: .rails_best_practices.yml
    vendor: false
    spec: true
    test: true
    features: true
    exclude: db/migrate,vendor
    only: app,config
NameTypeDefault
root_dirstring-
gemsstring[], hash[]-
configstring-
vendorbooleantrue
specbooleanfalse
testbooleanfalse
featuresbooleanfalse
excludestring-
onlystring-

config

This option allows you to specify a configuration file path you want.

If the option is omitted and the config/rails_best_practices.yml file (RBP's default) in your repository does not exist, Sider uses the default configuration.

vendor

This option allows you to include vendor/ directory or not.

spec

This option allows you to include spec/ directory or not.

test

This option allows you to include test/ directory or not.

features

This option allows you to include features/ directory or not.

exclude

This option allows you to exclude files or directories from the analysis. The value should be a comma-separated list.

only

This option allows you to limit only to files or directories you want. The value should be a comma-separated list.

Analyzing View Templates

Rails Best Practices supports some template engines. When Sider finds the following gems in your Gemfile.lock, it installs them automatically for backward compatibility:

  • slim
  • haml
  • sass
  • sassc

Note that these gems are not be installed when the gems option is specified.

← QuerlyBrakeman →
  • Getting Started
  • Configuration
    • config
    • vendor
    • spec
    • test
    • features
    • exclude
    • only
  • Analyzing View Templates
Sider Documentation
Docs
Getting StartedAnalysis ToolsEnterprise
Sider
Sider TopTerms of ServicePrivacy
Social
BlogGitHubStar
Copyright © 2021 Sider, Inc.