Edit

Rails Best Practices

Supported Version	Language	Website
1.19.1+ (default to 1.19.4)	Ruby 2.6.5	https://rails-bestpractices.com

Configuration via sider.yml

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

linter:
  rails_best_practices:
    gems:
      - "slim"
    vendor: false
    spec: true
    test: true
    features: true
    exclude: examples
    config: .rails_best_practices.yml

Options

Name	Type	Default	Description
root_dir	string	-	A root directory.
gems	string[], hash[]	-	Gems to install.
vendor	boolean	false	Add --vendor flag.
spec	boolean	false	Add --spec flag
test	boolean	false	Add --test flag
features	boolean	false	Add --features flag
exclude	string	-	Patterns passed as --exclude option.
only	string	-	Patterns passed as --only option.
config	string	-	Configuration file location passed as --config.

Analyzing view templates

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

• slim
• haml
• sass
• sassc

These gems will not be installed when the gems option is specified. We encourage you to explicitly specify gems in the gems option in sider.yml as follows:

linter:
  rails_best_practices:
    gems:
      - "slim"
      - "sassc"

Default Configuration

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

# AddModelVirtualAttributeCheck: {}
AlwaysAddDbIndexCheck: {}
# CheckSaveReturnValueCheck: {}
# CheckDestroyReturnValueCheck: {}
DefaultScopeIsEvilCheck: {}
DryBundlerInCapistranoCheck: {}
# HashSyntaxCheck: {}
# IsolateSeedDataCheck: {}
# KeepFindersOnTheirOwnModelCheck: {}
# LawOfDemeterCheck: {}
# LongLineCheck: { max_line_length: 80 }
MoveCodeIntoControllerCheck: {}
MoveCodeIntoHelperCheck: { array_count: 3 }
MoveCodeIntoModelCheck: { use_count: 2 }
# MoveFinderToNamedScopeCheck: {}
# MoveModelLogicIntoModelCheck: { use_count: 4 }
# NeedlessDeepNestingCheck: { nested_count: 2 }
NotRescueExceptionCheck: {}
NotUseDefaultRouteCheck: {}
# NotUseTimeAgoInWordsCheck: {}
OveruseRouteCustomizationsCheck: { customize_count: 3 }
ProtectMassAssignmentCheck: {}
RemoveEmptyHelpersCheck: {}
# RemoveTabCheck: {}
# RemoveTrailingWhitespaceCheck: {}
# RemoveUnusedMethodsInControllersCheck: { except_methods: [] }
# RemoveUnusedMethodsInHelpersCheck: { except_methods: [] }
# RemoveUnusedMethodsInModelsCheck: { except_methods: [] }
ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
# ReplaceInstanceVariableWithLocalVariableCheck: {}
RestrictAutoGeneratedRoutesCheck: {}
# SimplifyRenderInControllersCheck: {}
# SimplifyRenderInViewsCheck: {}
# UseBeforeFilterCheck: { customize_count: 2 }
UseModelAssociationCheck: {}
UseMultipartAlternativeAsContentTypeOfEmailCheck: {}
# UseParenthesesInMethodDefCheck: {}
UseObserverCheck: {}
# UseQueryAttributeCheck: {}
# UseSayWithTimeInMigrationsCheck: {}
UseScopeAccessCheck: {}
UseTurboSprocketsRails3Check: {}