Edit

Rails Best Practices

Supported Version	Language	Website
1.19.1+ (default: 1.20.0)	Ruby 2.7.2	https://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

Name	Type	Default
root_dir	string	-
gems	string[], hash[]	-
config	string	-
vendor	boolean	true
spec	boolean	false
test	boolean	false
features	boolean	false
exclude	string	-
only	string	-

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.