mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
5ac6ec54a6
### Summary
This PR changes .rubocop.yml.
Regarding the code using `if ... else ... end`, I think the coding style
that Rails expects is as follows.
```ruby
var = if cond
a
else
b
end
```
However, the current .rubocop.yml setting does not offense for the
following code.
```ruby
var = if cond
a
else
b
end
```
I think that the above code expects offense to be warned.
Moreover, the layout by autocorrect is unnatural.
```ruby
var = if cond
a
else
b
end
```
This PR adds a setting to .rubocop.yml to make an offense warning and
autocorrect as expected by the coding style.
And this change also fixes `case ... when ... end` together.
Also this PR itself is an example that arranges the layout using
`rubocop -a`.
### Other Information
Autocorrect of `Lint/EndAlignment` cop is `false` by default.
https://github.com/bbatsov/rubocop/blob/v0.51.0/config/default.yml#L1443
This PR changes this value to `true`.
Also this PR has changed it together as it is necessary to enable
`Layout/ElseAlignment` cop to make this behavior.
158 lines
3.5 KiB
YAML
158 lines
3.5 KiB
YAML
AllCops:
|
|
TargetRubyVersion: 2.2
|
|
# RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
|
|
# to ignore them, so only the ones explicitly set in this file are enabled.
|
|
DisabledByDefault: true
|
|
Exclude:
|
|
- '**/templates/**/*'
|
|
- '**/vendor/**/*'
|
|
- 'actionpack/lib/action_dispatch/journey/parser.rb'
|
|
|
|
# Prefer &&/|| over and/or.
|
|
Style/AndOr:
|
|
Enabled: true
|
|
|
|
# Do not use braces for hash literals when they are the last argument of a
|
|
# method call.
|
|
Style/BracesAroundHashParameters:
|
|
Enabled: true
|
|
EnforcedStyle: context_dependent
|
|
|
|
# Align `when` with `case`.
|
|
Layout/CaseIndentation:
|
|
Enabled: true
|
|
|
|
# Align comments with method definitions.
|
|
Layout/CommentIndentation:
|
|
Enabled: true
|
|
|
|
Layout/ElseAlignment:
|
|
Enabled: true
|
|
|
|
Layout/EmptyLineAfterMagicComment:
|
|
Enabled: true
|
|
|
|
# In a regular class definition, no empty lines around the body.
|
|
Layout/EmptyLinesAroundClassBody:
|
|
Enabled: true
|
|
|
|
# In a regular method definition, no empty lines around the body.
|
|
Layout/EmptyLinesAroundMethodBody:
|
|
Enabled: true
|
|
|
|
# In a regular module definition, no empty lines around the body.
|
|
Layout/EmptyLinesAroundModuleBody:
|
|
Enabled: true
|
|
|
|
Layout/FirstParameterIndentation:
|
|
Enabled: true
|
|
|
|
# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
|
|
Style/HashSyntax:
|
|
Enabled: true
|
|
|
|
# Method definitions after `private` or `protected` isolated calls need one
|
|
# extra level of indentation.
|
|
Layout/IndentationConsistency:
|
|
Enabled: true
|
|
EnforcedStyle: rails
|
|
|
|
# Two spaces, no tabs (for indentation).
|
|
Layout/IndentationWidth:
|
|
Enabled: true
|
|
|
|
Layout/LeadingCommentSpace:
|
|
Enabled: true
|
|
|
|
Layout/SpaceAfterColon:
|
|
Enabled: true
|
|
|
|
Layout/SpaceAfterComma:
|
|
Enabled: true
|
|
|
|
Layout/SpaceAroundEqualsInParameterDefault:
|
|
Enabled: true
|
|
|
|
Layout/SpaceAroundKeyword:
|
|
Enabled: true
|
|
|
|
Layout/SpaceAroundOperators:
|
|
Enabled: true
|
|
|
|
Layout/SpaceBeforeComma:
|
|
Enabled: true
|
|
|
|
Layout/SpaceBeforeFirstArg:
|
|
Enabled: true
|
|
|
|
Style/DefWithParentheses:
|
|
Enabled: true
|
|
|
|
# Defining a method with parameters needs parentheses.
|
|
Style/MethodDefParentheses:
|
|
Enabled: true
|
|
|
|
Style/FrozenStringLiteralComment:
|
|
Enabled: true
|
|
EnforcedStyle: always
|
|
Exclude:
|
|
- 'actionview/test/**/*.builder'
|
|
- 'actionview/test/**/*.ruby'
|
|
- 'actionpack/test/**/*.builder'
|
|
- 'actionpack/test/**/*.ruby'
|
|
- 'activestorage/db/migrate/**/*.rb'
|
|
|
|
# Use `foo {}` not `foo{}`.
|
|
Layout/SpaceBeforeBlockBraces:
|
|
Enabled: true
|
|
|
|
# Use `foo { bar }` not `foo {bar}`.
|
|
Layout/SpaceInsideBlockBraces:
|
|
Enabled: true
|
|
|
|
# Use `{ a: 1 }` not `{a:1}`.
|
|
Layout/SpaceInsideHashLiteralBraces:
|
|
Enabled: true
|
|
|
|
Layout/SpaceInsideParens:
|
|
Enabled: true
|
|
|
|
# Check quotes usage according to lint rule below.
|
|
Style/StringLiterals:
|
|
Enabled: true
|
|
EnforcedStyle: double_quotes
|
|
|
|
# Detect hard tabs, no hard tabs.
|
|
Layout/Tab:
|
|
Enabled: true
|
|
|
|
# Blank lines should not have any spaces.
|
|
Layout/TrailingBlankLines:
|
|
Enabled: true
|
|
|
|
# No trailing whitespace.
|
|
Layout/TrailingWhitespace:
|
|
Enabled: true
|
|
|
|
# Use quotes for string literals when they are enough.
|
|
Style/UnneededPercentQ:
|
|
Enabled: true
|
|
|
|
# Align `end` with the matching keyword or starting expression except for
|
|
# assignments, where it should be aligned with the LHS.
|
|
Lint/EndAlignment:
|
|
Enabled: true
|
|
EnforcedStyleAlignWith: variable
|
|
AutoCorrect: true
|
|
|
|
# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
|
|
Lint/RequireParentheses:
|
|
Enabled: true
|
|
|
|
Style/RedundantReturn:
|
|
Enabled: true
|
|
AllowMultipleReturnValues: true
|
|
|
|
Style/Semicolon:
|
|
Enabled: true
|
|
AllowAsExpressionSeparator: true
|