# Common configuration.

AllCops:

RubyInterpreters:

- ruby

- macruby

- rake

- jruby

- rbx

# Include common Ruby source files.

Include:

- '**/*.rb'

- '**/*.arb'

- '**/*.axlsx'

- '**/*.builder'

- '**/*.fcgi'

- '**/*.gemfile'

- '**/*.gemspec'

- '**/*.god'

- '**/*.jb'

- '**/*.jbuilder'

- '**/*.mspec'

- '**/*.opal'

- '**/*.pluginspec'

- '**/*.podspec'

- '**/*.rabl'

- '**/*.rake'

- '**/*.rbuild'

- '**/*.rbw'

- '**/*.rbx'

- '**/*.ru'

- '**/*.ruby'

- '**/*.schema'

- '**/*.spec'

- '**/*.thor'

- '**/*.watchr'

- '**/.irbrc'

- '**/.pryrc'

- '**/.simplecov'

- '**/buildfile'

- '**/Appraisals'

- '**/Berksfile'

- '**/Brewfile'

- '**/Buildfile'

- '**/Capfile'

- '**/Cheffile'

- '**/Dangerfile'

- '**/Deliverfile'

- '**/Fastfile'

- '**/*Fastfile'

- '**/Gemfile'

- '**/Guardfile'

- '**/Jarfile'

- '**/Mavenfile'

- '**/Podfile'

- '**/Puppetfile'

- '**/Rakefile'

- '**/rakefile'

- '**/Schemafile'

- '**/Snapfile'

- '**/Steepfile'

- '**/Thorfile'

- '**/Vagabondfile'

- '**/Vagrantfile'

Exclude:

- 'node_modules/**/*'

- 'tmp/**/*'

- 'vendor/**/*'

- '.git/**/*'

# Default formatter will be used if no `-f/--format` option is given.

DefaultFormatter: progress

# Cop names are displayed in offense messages by default. Change behavior

# by overriding DisplayCopNames, or by giving the `--no-display-cop-names`

# option.

DisplayCopNames: true

# Style guide URLs are not displayed in offense messages by default. Change

# behavior by overriding `DisplayStyleGuide`, or by giving the

# `-S/--display-style-guide` option.

DisplayStyleGuide: false

# When specifying style guide URLs, any paths and/or fragments will be

# evaluated relative to the base URL.

StyleGuideBaseURL: https://rubystyle.guide

# Documentation URLs will be constructed using the base URL.

DocumentationBaseURL: https://docs.rubocop.org/rubocop

# Extra details are not displayed in offense messages by default. Change

# behavior by overriding ExtraDetails, or by giving the

# `-E/--extra-details` option.

ExtraDetails: false

# Additional cops that do not reference a style guide rule may be enabled by

# default. Change behavior by overriding `StyleGuideCopsOnly`, or by giving

# the `--only-guide-cops` option.

StyleGuideCopsOnly: false

# All cops except the ones configured `Enabled: false` in this file are enabled by default.

# Change this behavior by overriding either `DisabledByDefault` or `EnabledByDefault`.

# When `DisabledByDefault` is `true`, all cops in the default configuration

# are disabled, and only cops in user configuration are enabled. This makes

# cops opt-in instead of opt-out. Note that when `DisabledByDefault` is `true`,

# cops in user configuration will be enabled even if they don't set the

# Enabled parameter.

# When `EnabledByDefault` is `true`, all cops, even those configured `Enabled: false`

# in this file are enabled by default. Cops can still be disabled in user configuration.

# Note that it is invalid to set both EnabledByDefault and DisabledByDefault

# to true in the same configuration.

EnabledByDefault: false

DisabledByDefault: false

# New cops introduced between major versions are set to a special pending status

# and are not enabled by default with warning message.

# Change this behavior by overriding either `NewCops: enable` or `NewCops: disable`.

# When `NewCops` is `enable`, pending cops are enabled in bulk. Can be overridden by

# the `--enable-pending-cops` command-line option.

# When `NewCops` is `disable`, pending cops are disabled in bulk. Can be overridden by

# the `--disable-pending-cops` command-line option.

NewCops: pending

# Enables the result cache if `true`. Can be overridden by the `--cache` command

# line option.

UseCache: true

# Threshold for how many files can be stored in the result cache before some

# of the files are automatically removed.

MaxFilesInCache: 20000

# The cache will be stored in "rubocop_cache" under this directory. If

# CacheRootDirectory is ~ (nil), which it is by default, the root will be

# taken from the environment variable `$XDG_CACHE_HOME` if it is set, or if

# `$XDG_CACHE_HOME` is not set, it will be `$HOME/.cache/`.

# The CacheRootDirectory can be overwritten by passing the `--cache-root` command

# line option or by setting `$RUBOCOP_CACHE_ROOT` environment variable.

CacheRootDirectory: ~

# It is possible for a malicious user to know the location of RuboCop's cache

# directory by looking at CacheRootDirectory, and create a symlink in its

# place that could cause RuboCop to overwrite unintended files, or read

# malicious input. If you are certain that your cache location is secure from

# this kind of attack, and wish to use a symlinked cache location, set this

# value to "true".

AllowSymlinksInCacheRootDirectory: false

# What MRI version of the Ruby interpreter is the inspected code intended to

# run on? (If there is more than one, set this to the lowest version.)

# If a value is specified for TargetRubyVersion then it is used. Acceptable

# values are specified as a float (i.e. 3.0); the teeny version of Ruby

# should not be included. If the project specifies a Ruby version in the

# .tool-versions or .ruby-version files, Gemfile or gems.rb file, RuboCop will

# try to determine the desired version of Ruby by inspecting the

# .tool-versions file first, then .ruby-version, followed by the Gemfile.lock

# or gems.locked file. (Although the Ruby version is specified in the Gemfile

# or gems.rb file, RuboCop reads the final value from the lock file.) If the

# Ruby version is still unresolved, RuboCop will use the oldest officially

# supported Ruby version (currently Ruby 2.7).

TargetRubyVersion: ~

# You can specify the parser engine. There are two options available:

# - `parser_whitequark` ... https://github.com/whitequark/parser

# - `parser_prism` ... https://github.com/ruby/prism (`Prism::Translation::Parser`)

# By default, `parser` is used. For the `TargetRubyVersion` value, `parser` can be specified for versions `2.0` and above.

# `parser_prism` can be specified for versions `3.3` and above. `parser_prism` is faster but still considered experimental.

ParserEngine: parser_whitequark

# Determines if a notification for extension libraries should be shown when

# rubocop is run. Keys are the name of the extension, and values are an array

# of gems in the Gemfile that the extension is suggested for, if not already

# included.

SuggestExtensions:

rubocop-rails: [rails]

rubocop-rspec: [rspec, rspec-rails]

rubocop-minitest: [minitest]

rubocop-sequel: [sequel]

rubocop-rake: [rake]

rubocop-graphql: [graphql]

rubocop-capybara: [capybara]

rubocop-factory_bot: [factory_bot, factory_bot_rails]

rubocop-rspec_rails: [rspec-rails]

# Enable/Disable checking the methods extended by Active Support.

ActiveSupportExtensionsEnabled: false

#################### Bundler ###############################

Bundler/DuplicatedGem:

Description: 'Checks for duplicate gem entries in Gemfile.'

Enabled: true

Severity: warning

VersionAdded: '0.46'

VersionChanged: '1.40'

Include:

- '**/*.gemfile'

- '**/Gemfile'

- '**/gems.rb'

Bundler/DuplicatedGroup:

Description: 'Checks for duplicate group entries in Gemfile.'

Enabled: true

Severity: warning

VersionAdded: '1.56'

Include:

- '**/*.gemfile'

- '**/Gemfile'

- '**/gems.rb'

Bundler/GemComment:

Description: 'Add a comment describing each gem.'

Enabled: false

VersionAdded: '0.59'

VersionChanged: '0.85'

Include:

- '**/*.gemfile'

- '**/Gemfile'

- '**/gems.rb'

IgnoredGems: []

OnlyFor: []

Bundler/GemFilename:

Description: 'Enforces the filename for managing gems.'

Enabled: true

VersionAdded: '1.20'

EnforcedStyle: 'Gemfile'

SupportedStyles:

- 'Gemfile'

- 'gems.rb'

Include:

- '**/Gemfile'

- '**/gems.rb'

- '**/Gemfile.lock'

- '**/gems.locked'

Bundler/GemVersion:

Description: 'Requires or forbids specifying gem versions.'

Enabled: false

VersionAdded: '1.14'

EnforcedStyle: 'required'

SupportedStyles:

- 'required'

- 'forbidden'

Include:

- '**/*.gemfile'

- '**/Gemfile'

- '**/gems.rb'

AllowedGems: []

Bundler/InsecureProtocolSource:

Description: >-

The source `:gemcutter`, `:rubygems` and `:rubyforge` are deprecated

because HTTP requests are insecure. Please change your source to

'https://rubygems.org' if possible, or 'http://rubygems.org' if not.

Enabled: true

Severity: warning

VersionAdded: '0.50'

VersionChanged: '1.40'

AllowHttpProtocol: true

Include:

- '**/*.gemfile'

- '**/Gemfile'

- '**/gems.rb'

Bundler/OrderedGems:

Description: >-

Gems within groups in the Gemfile should be alphabetically sorted.

Enabled: true

VersionAdded: '0.46'

VersionChanged: '0.47'

TreatCommentsAsGroupSeparators: true

# By default, "-" and "_" are ignored for order purposes.

# This can be overridden by setting this parameter to true.

ConsiderPunctuation: false

Include:

- '**/*.gemfile'

- '**/Gemfile'

- '**/gems.rb'

#################### Gemspec ###############################

Gemspec/DependencyVersion:

Description: 'Requires or forbids specifying gem dependency versions.'

Enabled: false

VersionAdded: '1.29'

EnforcedStyle: 'required'

SupportedStyles:

- 'required'

- 'forbidden'

Include:

- '**/*.gemspec'

AllowedGems: []

Gemspec/DeprecatedAttributeAssignment:

Description: Checks that deprecated attribute assignments are not set in a gemspec file.

Enabled: pending

Severity: warning

VersionAdded: '1.30'

VersionChanged: '1.40'

Include:

- '**/*.gemspec'

Gemspec/DevelopmentDependencies:

Description: Checks that development dependencies are specified in Gemfile rather than gemspec.

Enabled: pending

VersionAdded: '1.44'

EnforcedStyle: Gemfile

SupportedStyles:

- Gemfile

- gems.rb

- gemspec

AllowedGems: []

Include:

- '**/*.gemspec'

- '**/Gemfile'

- '**/gems.rb'

Gemspec/DuplicatedAssignment:

Description: 'An attribute assignment method calls should be listed only once in a gemspec.'

Enabled: true

Severity: warning

VersionAdded: '0.52'

VersionChanged: '1.40'

Include:

- '**/*.gemspec'

Gemspec/OrderedDependencies:

Description: >-

Dependencies in the gemspec should be alphabetically sorted.

Enabled: true

VersionAdded: '0.51'

TreatCommentsAsGroupSeparators: true

# By default, "-" and "_" are ignored for order purposes.

# This can be overridden by setting this parameter to true.

ConsiderPunctuation: false

Include:

- '**/*.gemspec'

Gemspec/RequireMFA:

Description: 'Checks that the gemspec has metadata to require Multi-Factor Authentication from RubyGems.'

Enabled: pending

Severity: warning

VersionAdded: '1.23'

VersionChanged: '1.40'

Reference:

- https://guides.rubygems.org/mfa-requirement-opt-in/

Include:

- '**/*.gemspec'

Gemspec/RequiredRubyVersion:

Description: 'Checks that `required_ruby_version` of gemspec is specified and equal to `TargetRubyVersion` of .rubocop.yml.'

Enabled: true

Severity: warning

VersionAdded: '0.52'

VersionChanged: '1.40'

Include:

- '**/*.gemspec'

Gemspec/RubyVersionGlobalsUsage:

Description: Checks usage of RUBY_VERSION in gemspec.

StyleGuide: '#no-ruby-version-in-the-gemspec'

Enabled: true

Severity: warning

VersionAdded: '0.72'

VersionChanged: '1.40'

Include:

- '**/*.gemspec'

#################### Layout ###########################

Layout/AccessModifierIndentation:

Description: Check indentation of private/protected visibility modifiers.

StyleGuide: '#indent-public-private-protected'

Enabled: true

VersionAdded: '0.49'

EnforcedStyle: indent

SupportedStyles:

- outdent

- indent

# By default the indentation width from `Layout/IndentationWidth` is used,

# but it can be overridden by setting this parameter.

IndentationWidth: ~

Layout/ArgumentAlignment:

Description: >-

Align the arguments of a method call if they span more

than one line.

StyleGuide: '#no-double-indent'

Enabled: true

VersionAdded: '0.68'

VersionChanged: '0.77'

# Alignment of arguments in multi-line method calls.

#

# The `with_first_argument` style aligns the following lines along the same

# column as the first parameter.

#

# method_call(a,

# b)

#

# The `with_fixed_indentation` style aligns the following lines with one

# level of indentation relative to the start of the line with the method call.

#

# method_call(a,

# b)

EnforcedStyle: with_first_argument

SupportedStyles:

- with_first_argument

- with_fixed_indentation

# By default the indentation width from `Layout/IndentationWidth` is used,

# but it can be overridden by setting this parameter.

IndentationWidth: ~

Layout/ArrayAlignment:

Description: >-

Align the elements of an array literal if they span more than

one line.

StyleGuide: '#no-double-indent'

Enabled: true

VersionAdded: '0.49'

VersionChanged: '0.77'

# Alignment of elements of a multi-line array.

#

# The `with_first_parameter` style aligns the following lines along the same

# column as the first element.

#

# array = [1, 2, 3,

# 4, 5, 6]

#

# The `with_fixed_indentation` style aligns the following lines with one

# level of indentation relative to the start of the line with start of array.

#

# array = [1, 2, 3,

# 4, 5, 6]

EnforcedStyle: with_first_element

SupportedStyles:

- with_first_element

- with_fixed_indentation

# By default the indentation width from `Layout/IndentationWidth` is used,

# but it can be overridden by setting this parameter.

IndentationWidth: ~

Layout/AssignmentIndentation:

Description: >-

Checks the indentation of the first line of the

right-hand-side of a multi-line assignment.

Enabled: true

VersionAdded: '0.49'

VersionChanged: '1.45'

# By default the indentation width from `Layout/IndentationWidth` is used,

# but it can be overridden by setting this parameter.

IndentationWidth: ~

Layout/BeginEndAlignment:

Description: 'Align ends corresponding to begins correctly.'

Enabled: true

VersionAdded: '0.91'

# The value `start_of_line` means that `end` should be aligned the start of the line

# where the `begin` keyword is.

# The value `begin` means that `end` should be aligned with the `begin` keyword.

EnforcedStyleAlignWith: start_of_line

SupportedStylesAlignWith:

- start_of_line

- begin

Severity: warning

Layout/BlockAlignment:

Description: 'Align block ends correctly.'

Enabled: true

VersionAdded: '0.53'

# The value `start_of_block` means that the `end` should be aligned with line

# where the `do` keyword appears.

# The value `start_of_line` means it should be aligned with the whole

# expression's starting line.

# The value `either` means both are allowed.

EnforcedStyleAlignWith: either

SupportedStylesAlignWith:

- either

- start_of_block

- start_of_line

Layout/BlockEndNewline:

Description: 'Put end statement of multiline block on its own line.'

Enabled: true

VersionAdded: '0.49'

Layout/CaseIndentation:

Description: 'Indentation of when in a case/(when|in)/[else/]end.'

StyleGuide: '#indent-when-to-case'

Enabled: true

VersionAdded: '0.49'

VersionChanged: '1.16'

EnforcedStyle: case

SupportedStyles:

- case

- end

IndentOneStep: false

# By default the indentation width from `Layout/IndentationWidth` is used,

# but it can be overridden by setting this parameter.

# This only matters if `IndentOneStep` is `true`.

IndentationWidth: ~

Layout/ClassStructure:

Description: 'Enforces a configured order of definitions within a class body.'

StyleGuide: '#consistent-classes'

Enabled: false

SafeAutoCorrect: false

VersionAdded: '0.52'

VersionChanged: '1.53'

Categories:

module_inclusion:

- include

- prepend

- extend

ExpectedOrder:

- module_inclusion

- constants

- public_class_methods

- initializer

- public_methods

- protected_methods

- private_methods

Layout/ClosingHeredocIndentation:

Description: 'Checks the indentation of here document closings.'

Enabled: true

VersionAdded: '0.57'

Layout/ClosingParenthesisIndentation:

Description: 'Checks the indentation of hanging closing parentheses.'

Enabled: true

VersionAdded: '0.49'

Layout/CommentIndentation:

Description: 'Indentation of comments.'

Enabled: true

# When true, allows comments to have extra indentation if that aligns them

# with a comment on the preceding line.

AllowForAlignment: false

VersionAdded: '0.49'

VersionChanged: '1.24'

Layout/ConditionPosition:

Description: >-

Checks for condition placed in a confusing position relative to

the keyword.

StyleGuide: '#same-line-condition'

Enabled: true

VersionAdded: '0.53'

VersionChanged: '0.83'

Layout/DefEndAlignment:

Description: 'Align ends corresponding to defs correctly.'

Enabled: true

VersionAdded: '0.53'

# The value `def` means that `end` should be aligned with the def keyword.

# The value `start_of_line` means that `end` should be aligned with method

# calls like `private`, `public`, etc, if present in front of the `def`

# keyword on the same line.

EnforcedStyleAlignWith: start_of_line

SupportedStylesAlignWith:

- start_of_line

- def

Severity: warning

Layout/DotPosition:

Description: 'Checks the position of the dot in multi-line method calls.'

StyleGuide: '#consistent-multi-line-chains'

Enabled: true

VersionAdded: '0.49'

EnforcedStyle: leading

SupportedStyles:

- leading

- trailing

Layout/ElseAlignment:

Description: 'Align elses and elsifs correctly.'

Enabled: true

VersionAdded: '0.49'

Layout/EmptyComment:

Description: 'Checks empty comment.'

Enabled: true

AutoCorrect: contextual

VersionAdded: '0.53'

VersionChanged: '1.61'

AllowBorderComment: true

AllowMarginComment: true

Layout/EmptyLineAfterGuardClause:

Description: 'Add empty line after guard clause.'

Enabled: true

VersionAdded: '0.56'

VersionChanged: '0.59'

Layout/EmptyLineAfterMagicComment:

Description: 'Add an empty line after magic comments to separate them from code.'

StyleGuide: '#separate-magic-comments-from-code'

Enabled: true

VersionAdded: '0.49'

Layout/EmptyLineAfterMultilineCondition:

Description: 'Enforces empty line after multiline condition.'

# This is disabled, because this style is not very common in practice.

Enabled: false

VersionAdded: '0.90'

Reference:

- https://github.com/airbnb/ruby#multiline-if-newline

Layout/EmptyLineBetweenDefs:

Description: 'Use empty lines between class/module/method defs.'

StyleGuide: '#empty-lines-between-methods'

Enabled: true

VersionAdded: '0.49'

VersionChanged: '1.23'

EmptyLineBetweenMethodDefs: true

EmptyLineBetweenClassDefs: true

EmptyLineBetweenModuleDefs: true

# `DefLikeMacros` takes the name of any macro that you want to treat like a def.

DefLikeMacros: []

# `AllowAdjacentOneLineDefs` means that single line method definitions don't

# need an empty line between them. `true` by default.

AllowAdjacentOneLineDefs: true

# Can be array to specify minimum and maximum number of empty lines, e.g. [1, 2]

NumberOfEmptyLines: 1

Layout/EmptyLines:

Description: "Don't use several empty lines in a row."

StyleGuide: '#two-or-more-empty-lines'

Enabled: true

VersionAdded: '0.49'

Layout/EmptyLinesAroundAccessModifier:

Description: "Keep blank lines around access modifiers."

StyleGuide: '#empty-lines-around-access-modifier'

Enabled: true

VersionAdded: '0.49'

EnforcedStyle: around

SupportedStyles:

- around

- only_before

Reference:

# A reference to `EnforcedStyle: only_before`.

- https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#follow-the-coding-conventions

Layout/EmptyLinesAroundArguments:

Description: "Keeps track of empty lines around method arguments."

Enabled: true

VersionAdded: '0.52'

Layout/EmptyLinesAroundAttributeAccessor:

Description: "Keep blank lines around attribute accessors."

StyleGuide: '#empty-lines-around-attribute-accessor'

Enabled: true

VersionAdded: '0.83'

VersionChanged: '0.84'

AllowAliasSyntax: true

AllowedMethods:

- alias_method

- public

- protected

- private

Layout/EmptyLinesAroundBeginBody:

Description: "Keeps track of empty lines around begin-end bodies."

StyleGuide: '#empty-lines-around-bodies'

Enabled: true

VersionAdded: '0.49'

Layout/EmptyLinesAroundBlockBody:

Description: "Keeps track of empty lines around block bodies."

StyleGuide: '#empty-lines-around-bodies'

Enabled: true

VersionAdded: '0.49'

EnforcedStyle: no_empty_lines

SupportedStyles:

- empty_lines

- no_empty_lines

Layout/EmptyLinesAroundClassBody:

Description: "Keeps track of empty lines around class bodies."

StyleGuide: '#empty-lines-around-bodies'

Enabled: true

VersionAdded: '0.49'

VersionChanged: '0.53'

EnforcedStyle: no_empty_lines

SupportedStyles:

- empty_lines

- empty_lines_except_namespace

- empty_lines_special

- no_empty_lines

- beginning_only

- ending_only

Layout/EmptyLinesAroundExceptionHandlingKeywords:

Description: "Keeps track of empty lines around exception handling keywords."

StyleGuide: '#empty-lines-around-bodies'

Enabled: true

VersionAdded: '0.49'

Layout/EmptyLinesAroundMethodBody:

Description: "Keeps track of empty lines around method bodies."

StyleGuide: '#empty-lines-around-bodies'

Enabled: true

VersionAdded: '0.49'

Layout/EmptyLinesAroundModuleBody:

Description: "Keeps track of empty lines around module bodies."

StyleGuide: '#empty-lines-around-bodies'

Enabled: true

VersionAdded: '0.49'

EnforcedStyle: no_empty_lines

SupportedStyles:

- empty_lines

- empty_lines_except_namespace

- empty_lines_special

- no_empty_lines

Layout/EndAlignment:

Description: 'Align ends correctly.'

Enabled: true

VersionAdded: '0.53'

# The value `keyword` means that `end` should be aligned with the matching

# keyword (`if`, `while`, etc.).

# The value `variable` means that in assignments, `end` should be aligned

# with the start of the variable on the left hand side of `=`. In all other

# situations, `end` should still be aligned with the keyword.

# The value `start_of_line` means that `end` should be aligned with the start

# of the line which the matching keyword appears on.

EnforcedStyleAlignWith: keyword

SupportedStylesAlignWith:

- keyword

- variable

- start_of_line

Severity: warning

Layout/EndOfLine:

Description: 'Use Unix-style line endings.'

StyleGuide: '#crlf'

Enabled: true

VersionAdded: '0.49'

# The `native` style means that CR+LF (Carriage Return + Line Feed) is

# enforced on Windows, and LF is enforced on other platforms. The other styles

# mean LF and CR+LF, respectively.

EnforcedStyle: native

SupportedStyles:

- native

- lf

- crlf

Layout/ExtraSpacing:

Description: 'Do not use unnecessary spacing.'

Enabled: true

VersionAdded: '0.49'

# When true, allows most uses of extra spacing if the intent is to align

# things with the previous or next line, not counting empty lines or comment

# lines.

AllowForAlignment: true

# When true, allows things like 'obj.meth(arg) # comment',

# rather than insisting on 'obj.meth(arg) # comment'.

# If done for alignment, either this OR AllowForAlignment will allow it.

AllowBeforeTrailingComments: false

# When true, forces the alignment of `=` in assignments on consecutive lines.

ForceEqualSignAlignment: false

Layout/FirstArgumentIndentation:

Description: 'Checks the indentation of the first argument in a method call.'

Enabled: true

VersionAdded: '0.68'

VersionChanged: '0.77'

EnforcedStyle: special_for_inner_method_call_in_parentheses

SupportedStyles:

# The first parameter should always be indented one step more than the

# preceding line.

- consistent

# The first parameter should always be indented one level relative to the

# parent that is receiving the parameter

- consistent_relative_to_receiver

# The first parameter should normally be indented one step more than the

# preceding line, but if it's a parameter for a method call that is itself

# a parameter in a method call, then the inner parameter should be indented

# relative to the inner method.

- special_for_inner_method_call

# Same as `special_for_inner_method_call` except that the special rule only

# applies if the outer method call encloses its arguments in parentheses.

- special_for_inner_method_call_in_parentheses

# By default the indentation width from `Layout/IndentationWidth` is used,

# but it can be overridden by setting this parameter.

IndentationWidth: ~

Layout/FirstArrayElementIndentation:

Description: >-

Checks the indentation of the first element in an array

literal.

Enabled: true

VersionAdded: '0.68'

VersionChanged: '0.77'

# The value `special_inside_parentheses` means that array literals with

# brackets that have their opening bracket on the same line as a surrounding

# opening round parenthesis, shall have their first element indented relative

# to the first position inside the parenthesis.

#

# The value `consistent` means that the indentation of the first element shall

# always be relative to the first position of the line where the opening

# bracket is.

#

# The value `align_brackets` means that the indentation of the first element

# shall always be relative to the position of the opening bracket.

EnforcedStyle: special_inside_parentheses

SupportedStyles:

- special_inside_parentheses

- consistent

- align_brackets

# By default the indentation width from `Layout/IndentationWidth` is used,

# but it can be overridden by setting this parameter.

IndentationWidth: ~

Layout/FirstArrayElementLineBreak:

Description: >-

Checks for a line break before the first element in a

multi-line array.

Enabled: false

VersionAdded: '0.49'

AllowMultilineFinalElement: false

Layout/FirstHashElementIndentation:

Description: 'Checks the indentation of the first key in a hash literal.'

Enabled: true

VersionAdded: '0.68'

VersionChanged: '0.77'

# The value `special_inside_parentheses` means that hash literals with braces

# that have their opening brace on the same line as a surrounding opening

# round parenthesis, shall have their first key indented relative to the

# first position inside the parenthesis.

#

# The value `consistent` means that the indentation of the first key shall

# always be relative to the first position of the line where the opening

# brace is.

#

# The value `align_braces` means that the indentation of the first key shall

# always be relative to the position of the opening brace.

EnforcedStyle: special_inside_parentheses

SupportedStyles:

- special_inside_parentheses

- consistent

- align_braces

# By default the indentation width from `Layout/IndentationWidth` is used,

# but it can be overridden by setting this parameter.

IndentationWidth: ~

Layout/FirstHashElementLineBreak:

Description: >-

Checks for a line break before the first element in a

multi-line hash.

Enabled: false

VersionAdded: '0.49'

AllowMultilineFinalElement: false

Layout/FirstMethodArgumentLineBreak:

Description: >-

Checks for a line break before the first argument in a

multi-line method call.

Enabled: false

VersionAdded: '0.49'

AllowMultilineFinalElement: false

Layout/FirstMethodParameterLineBreak:

Description: >-

Checks for a line break before the first parameter in a

multi-line method parameter definition.

Enabled: false

VersionAdded: '0.49'

AllowMultilineFinalElement: false

Layout/FirstParameterIndentation:

Description: >-

Checks the indentation of the first parameter in a

method definition.

Enabled: true

VersionAdded: '0.49'

VersionChanged: '0.77'

EnforcedStyle: consistent

SupportedStyles:

- consistent

- align_parentheses

# By default the indentation width from `Layout/IndentationWidth` is used,

# but it can be overridden by setting this parameter.

IndentationWidth: ~

Layout/HashAlignment:

Description: >-

Align the elements of a hash literal if they span more than

one line.

Enabled: true

AllowMultipleStyles: true

VersionAdded: '0.49'

VersionChanged: '1.16'

# Alignment of entries using hash rocket as separator. Valid values are:

#

# key - left alignment of keys

# 'a' => 2

# 'bb' => 3

# separator - alignment of hash rockets, keys are right aligned

# 'a' => 2

# 'bb' => 3

# table - left alignment of keys, hash rockets, and values

# 'a' => 2

# 'bb' => 3

EnforcedHashRocketStyle: key

SupportedHashRocketStyles:

- key

- separator

- table

# Alignment of entries using colon as separator. Valid values are:

#

# key - left alignment of keys

# a: 0

# bb: 1

# separator - alignment of colons, keys are right aligned

# a: 0

# bb: 1

# table - left alignment of keys and values

# a: 0

# bb: 1

EnforcedColonStyle: key

SupportedColonStyles:

- key

- separator

- table

# Select whether hashes that are the last argument in a method call should be

# inspected? Valid values are:

#

# always_inspect - Inspect both implicit and explicit hashes.

# Registers an offense for:

# function(a: 1,

# b: 2)

# Registers an offense for:

# function({a: 1,

# b: 2})

# always_ignore - Ignore both implicit and explicit hashes.

# Accepts:

# function(a: 1,

# b: 2)

# Accepts:

# function({a: 1,

# b: 2})

# ignore_implicit - Ignore only implicit hashes.

# Accepts:

# function(a: 1,

# b: 2)

# Registers an offense for:

# function({a: 1,

# b: 2})

# ignore_explicit - Ignore only explicit hashes.

# Accepts:

# function({a: 1,

# b: 2})

# Registers an offense for:

# function(a: 1,

# b: 2)

EnforcedLastArgumentHashStyle: always_inspect

SupportedLastArgumentHashStyles:

- always_inspect

- always_ignore

- ignore_implicit

- ignore_explicit

Layout/HeredocArgumentClosingParenthesis:

Description: >-

Checks for the placement of the closing parenthesis in a

method call that passes a HEREDOC string as an argument.

Enabled: false

StyleGuide: '#heredoc-argument-closing-parentheses'

VersionAdded: '0.68'

Layout/HeredocIndentation:

Description: 'Checks the indentation of the here document bodies.'

StyleGuide: '#squiggly-heredocs'

Enabled: true

VersionAdded: '0.49'

VersionChanged: '0.85'

Layout/IndentationConsistency:

Description: 'Keep indentation straight.'

StyleGuide: '#spaces-indentation'

Enabled: true

VersionAdded: '0.49'

# The difference between `indented` and `normal` is that the `indented_internal_methods`

# style prescribes that in classes and modules the `protected` and `private`

# modifier keywords shall be indented the same as public methods and that

# protected and private members shall be indented one step more than the

# modifiers. Other than that, both styles mean that entities on the same

# logical depth shall have the same indentation.

EnforcedStyle: normal

SupportedStyles:

- normal

- indented_internal_methods

Reference:

# A reference to `EnforcedStyle: indented_internal_methods`.

- https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#follow-the-coding-conventions

Layout/IndentationStyle:

Description: 'Consistent indentation either with tabs only or spaces only.'

StyleGuide: '#spaces-indentation'

Enabled: true

VersionAdded: '0.49'

VersionChanged: '0.82'

# By default the indentation width from `Layout/IndentationWidth` is used,

# but it can be overridden by setting this parameter.

# It is used during autocorrection to determine how many spaces should

# replace each tab.

IndentationWidth: ~

EnforcedStyle: spaces

SupportedStyles:

- spaces

- tabs

Layout/IndentationWidth: