Edit

Rails Best Practices

Supported Version	Language	Web Site
1.19.4	Ruby 2.5.1	https://rails-bestpractices.com/

Getting Started

To start using Rails Best Practices, enable it in Repository Settings.

To customize Rails Best Practices, use the standard config file at config/rails_best_practices.yml.

Default Configuration

Sider uses the following settings for Rails Best Practices if there is no config file in your repository:

• Sider recommended settings for Rails Best Practices

Configuration via sideci.yml

Here are some example settings for Rails Best Practices in sideci.yml, under rails_best_practices:

linter:
  rails_best_practices:
    vendor: false
    spec: true
    test: true
    features: true
    exclude: foo_dir
    only: bar_dir
    config: my_rbp_settings.yml

Options

You can use several options to more comfortable analysis to your project.

Name	Type	Description
vendor	boolean	When true, files in the vendor directory will be analyzed.
spec	boolean	When true, files in the spec directory will be analyzed.
test	boolean	When true, files in the test directory will be analyzed.
features	boolean	When true, files in the features directory will be analyzed.
exclude	string	Excludes the listed files and directories from analysis. Enter multiple values as a comma-separated list.
only	string	When the only is present, Rails Best Practices will analyze only the files or directories listed, and exclude everything else. Enter multiple values as a comma-separated list.
config	string	You can use this option to specify an alternate config file for Rails Best Practices

vendor

This option controls whether to include files in vendor directory. When true, the vendor files will be inspected. The default value in Sider is true.

spec

This option controls whether to include files in spec directory. When true, the spec files will be inspected. The default value in Sider is false.

test

This option controls whether to include files in test directory. When true, the test files will be inspected. The default value in Sider is false.

features

This option controls whether to include files in features directory. When true, the features files will be inspected. The default value in Sider is false.

exclude

This option allows you to exclude files/directories from analysis. If you would like to set up multiple files/directories, write them as a comma separated list:

linter:
  rails_best_practices:
    exclude: app/controllers/foo/,app/models/bar.rb

only

This option manages files/directories to analyze. When this option is present, Sider analyzes only those files and directories that match one of the patterns included. If you would like to set up multiple files/directories, write them as a comma separated list:

linter:
  rails_best_practices:
    only: app/controllers/,app/models/,lib/foo.rb

config

You can use this option to specify an alternate config file for Rails Best Practices. If your config file is in config/rails_best_practices.yml, you don't need to use this.