2019-06-06 05:38:19 +00:00
|
|
|
require:
|
2021-06-24 10:46:21 +00:00
|
|
|
- rubocop-minitest
|
2020-09-06 01:07:04 +00:00
|
|
|
- rubocop-packaging
|
2019-06-06 05:38:19 +00:00
|
|
|
- rubocop-performance
|
|
|
|
- rubocop-rails
|
2019-04-16 08:05:50 +00:00
|
|
|
|
2016-06-13 14:29:50 +00:00
|
|
|
AllCops:
|
2021-02-04 20:12:44 +00:00
|
|
|
TargetRubyVersion: 2.7
|
2016-08-06 15:45:37 +00:00
|
|
|
# RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
|
2016-08-07 11:06:51 +00:00
|
|
|
# to ignore them, so only the ones explicitly set in this file are enabled.
|
2016-06-13 14:29:50 +00:00
|
|
|
DisabledByDefault: true
|
2021-01-26 23:41:59 +00:00
|
|
|
SuggestExtensions: false
|
2016-08-06 15:45:37 +00:00
|
|
|
Exclude:
|
2019-10-07 00:15:32 +00:00
|
|
|
- '**/tmp/**/*'
|
2016-08-06 15:45:37 +00:00
|
|
|
- '**/templates/**/*'
|
|
|
|
- '**/vendor/**/*'
|
2016-12-24 14:33:02 +00:00
|
|
|
- 'actionpack/lib/action_dispatch/journey/parser.rb'
|
2018-12-24 20:16:22 +00:00
|
|
|
- 'actionmailbox/test/dummy/**/*'
|
2019-01-05 00:43:11 +00:00
|
|
|
- 'actiontext/test/dummy/**/*'
|
2019-04-07 11:30:14 +00:00
|
|
|
- '**/node_modules/**/*'
|
2016-06-13 14:29:50 +00:00
|
|
|
|
2018-07-26 08:33:49 +00:00
|
|
|
Performance:
|
|
|
|
Exclude:
|
|
|
|
- '**/test/**/*'
|
|
|
|
|
2018-07-03 03:11:28 +00:00
|
|
|
# Prefer assert_not over assert !
|
|
|
|
Rails/AssertNot:
|
Add custom RuboCop for `assert_not` over `refute`
Since at least cf4afc4 we have preferred `assert_not` methods over
`refute` methods. I have seen plenty of comments in PRs about this,
and we have tried to fix it a few times (5294ad8, e45f176, 8910f12,
41f50be, d4cfd54, 48a183e, and 211adb4), but the `refute` methods
keep sneaking back in.
This custom RuboCop will take care of enforcing this preference, so we
don't have to think about it again. I suspect there are other similar
stylistic preferences that could be solved with some custom RuboCops, so
I will definitely keep my eyes open. `assert_not` over `assert !` might
be a good candidate, for example.
I wasn't totally sure if `ci/custom_cops` was the best place to put
this, but nothing else seemed quite right. At one point I had it set up
as a gem, but I think custom cops like this would have limited value
in another context.
I want to see how code climate handles the new cops before
autocorrecting the existing violations. If things go as expected, I will
push another commit with those corrections.
2018-04-04 00:50:00 +00:00
|
|
|
Include:
|
2018-04-19 20:25:39 +00:00
|
|
|
- '**/test/**/*'
|
Add custom RuboCop for `assert_not` over `refute`
Since at least cf4afc4 we have preferred `assert_not` methods over
`refute` methods. I have seen plenty of comments in PRs about this,
and we have tried to fix it a few times (5294ad8, e45f176, 8910f12,
41f50be, d4cfd54, 48a183e, and 211adb4), but the `refute` methods
keep sneaking back in.
This custom RuboCop will take care of enforcing this preference, so we
don't have to think about it again. I suspect there are other similar
stylistic preferences that could be solved with some custom RuboCops, so
I will definitely keep my eyes open. `assert_not` over `assert !` might
be a good candidate, for example.
I wasn't totally sure if `ci/custom_cops` was the best place to put
this, but nothing else seemed quite right. At one point I had it set up
as a gem, but I think custom cops like this would have limited value
in another context.
I want to see how code climate handles the new cops before
autocorrecting the existing violations. If things go as expected, I will
push another commit with those corrections.
2018-04-04 00:50:00 +00:00
|
|
|
|
2018-07-03 03:11:28 +00:00
|
|
|
# Prefer assert_not_x over refute_x
|
|
|
|
Rails/RefuteMethods:
|
2018-04-17 12:37:35 +00:00
|
|
|
Include:
|
2018-04-19 20:25:39 +00:00
|
|
|
- '**/test/**/*'
|
2018-04-17 12:37:35 +00:00
|
|
|
|
2020-04-19 22:36:05 +00:00
|
|
|
Rails/IndexBy:
|
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
Rails/IndexWith:
|
|
|
|
Enabled: true
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Prefer &&/|| over and/or.
|
|
|
|
Style/AndOr:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-06-13 14:29:50 +00:00
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Align `when` with `case`.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/CaseIndentation:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-06-13 14:29:50 +00:00
|
|
|
|
2019-11-24 00:44:32 +00:00
|
|
|
Layout/ClosingHeredocIndentation:
|
|
|
|
Enabled: true
|
|
|
|
|
2021-06-04 08:35:02 +00:00
|
|
|
Layout/ClosingParenthesisIndentation:
|
|
|
|
Enabled: true
|
|
|
|
|
2016-09-14 08:57:52 +00:00
|
|
|
# Align comments with method definitions.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/CommentIndentation:
|
2016-09-14 08:57:52 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2018-01-18 03:09:16 +00:00
|
|
|
Layout/ElseAlignment:
|
|
|
|
Enabled: true
|
|
|
|
|
2018-04-21 17:13:34 +00:00
|
|
|
# Align `end` with the matching keyword or starting expression except for
|
|
|
|
# assignments, where it should be aligned with the LHS.
|
|
|
|
Layout/EndAlignment:
|
|
|
|
Enabled: true
|
|
|
|
EnforcedStyleAlignWith: variable
|
|
|
|
AutoCorrect: true
|
|
|
|
|
2021-04-24 14:59:19 +00:00
|
|
|
Layout/EndOfLine:
|
|
|
|
Enabled: true
|
|
|
|
|
2017-07-10 13:36:57 +00:00
|
|
|
Layout/EmptyLineAfterMagicComment:
|
|
|
|
Enabled: true
|
|
|
|
|
2019-06-12 12:30:49 +00:00
|
|
|
Layout/EmptyLinesAroundAccessModifier:
|
|
|
|
Enabled: true
|
|
|
|
EnforcedStyle: only_before
|
|
|
|
|
2018-07-12 12:29:48 +00:00
|
|
|
Layout/EmptyLinesAroundBlockBody:
|
|
|
|
Enabled: true
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# In a regular class definition, no empty lines around the body.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/EmptyLinesAroundClassBody:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-06-13 14:29:50 +00:00
|
|
|
|
2017-02-12 11:44:15 +00:00
|
|
|
# In a regular method definition, no empty lines around the body.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/EmptyLinesAroundMethodBody:
|
2017-02-12 11:44:15 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# In a regular module definition, no empty lines around the body.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/EmptyLinesAroundModuleBody:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-07-17 07:10:45 +00:00
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
|
|
|
|
Style/HashSyntax:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-07-17 07:10:45 +00:00
|
|
|
|
2016-07-21 11:49:13 +00:00
|
|
|
# Method definitions after `private` or `protected` isolated calls need one
|
|
|
|
# extra level of indentation.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/IndentationConsistency:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2019-08-15 12:56:18 +00:00
|
|
|
EnforcedStyle: indented_internal_methods
|
2016-07-17 07:10:45 +00:00
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Two spaces, no tabs (for indentation).
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/IndentationWidth:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
2016-07-17 07:10:45 +00:00
|
|
|
|
2017-12-14 08:30:54 +00:00
|
|
|
Layout/LeadingCommentSpace:
|
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceAfterColon:
|
2016-10-29 03:05:58 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceAfterComma:
|
2016-10-29 03:05:58 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2018-12-07 23:11:38 +00:00
|
|
|
Layout/SpaceAfterSemicolon:
|
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceAroundEqualsInParameterDefault:
|
2016-10-29 03:05:58 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceAroundKeyword:
|
2016-10-29 03:05:58 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2020-10-22 07:12:38 +00:00
|
|
|
Layout/SpaceAroundOperators:
|
|
|
|
Enabled: true
|
|
|
|
|
2017-12-12 11:00:50 +00:00
|
|
|
Layout/SpaceBeforeComma:
|
2018-12-07 23:11:38 +00:00
|
|
|
Enabled: true
|
2017-12-12 11:00:50 +00:00
|
|
|
|
2019-04-11 16:20:25 +00:00
|
|
|
Layout/SpaceBeforeComment:
|
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceBeforeFirstArg:
|
2018-12-07 23:11:38 +00:00
|
|
|
Enabled: true
|
2016-10-29 03:05:58 +00:00
|
|
|
|
2017-11-27 06:16:12 +00:00
|
|
|
Style/DefWithParentheses:
|
|
|
|
Enabled: true
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Defining a method with parameters needs parentheses.
|
|
|
|
Style/MethodDefParentheses:
|
|
|
|
Enabled: true
|
|
|
|
|
2021-09-05 14:29:32 +00:00
|
|
|
Style/ExplicitBlockArgument:
|
|
|
|
Enabled: true
|
|
|
|
|
2017-07-09 12:06:36 +00:00
|
|
|
Style/FrozenStringLiteralComment:
|
|
|
|
Enabled: true
|
|
|
|
EnforcedStyle: always
|
2017-07-23 15:36:41 +00:00
|
|
|
Exclude:
|
|
|
|
- 'actionview/test/**/*.builder'
|
|
|
|
- 'actionview/test/**/*.ruby'
|
2017-07-24 20:20:53 +00:00
|
|
|
- 'actionpack/test/**/*.builder'
|
|
|
|
- 'actionpack/test/**/*.ruby'
|
2017-08-22 05:32:27 +00:00
|
|
|
- 'activestorage/db/migrate/**/*.rb'
|
2018-07-23 00:33:25 +00:00
|
|
|
- 'activestorage/db/update_migrate/**/*.rb'
|
2018-12-24 20:16:22 +00:00
|
|
|
- 'actionmailbox/db/migrate/**/*.rb'
|
2019-01-05 00:43:11 +00:00
|
|
|
- 'actiontext/db/migrate/**/*.rb'
|
2017-07-09 12:06:36 +00:00
|
|
|
|
2018-02-28 04:33:37 +00:00
|
|
|
Style/RedundantFreeze:
|
|
|
|
Enabled: true
|
|
|
|
|
2016-08-16 07:30:11 +00:00
|
|
|
# Use `foo {}` not `foo{}`.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceBeforeBlockBraces:
|
2016-08-16 07:30:11 +00:00
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
# Use `foo { bar }` not `foo {bar}`.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceInsideBlockBraces:
|
2016-08-16 07:30:11 +00:00
|
|
|
Enabled: true
|
2018-09-25 17:18:20 +00:00
|
|
|
EnforcedStyleForEmptyBraces: space
|
2016-08-16 07:30:11 +00:00
|
|
|
|
|
|
|
# Use `{ a: 1 }` not `{a:1}`.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceInsideHashLiteralBraces:
|
2016-08-16 07:30:11 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/SpaceInsideParens:
|
2016-10-29 03:05:58 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Check quotes usage according to lint rule below.
|
|
|
|
Style/StringLiterals:
|
|
|
|
Enabled: true
|
|
|
|
EnforcedStyle: double_quotes
|
|
|
|
|
|
|
|
# Detect hard tabs, no hard tabs.
|
2020-04-17 18:24:33 +00:00
|
|
|
Layout/IndentationStyle:
|
2016-08-06 15:45:37 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2019-11-27 23:53:47 +00:00
|
|
|
# Empty lines should not have any spaces.
|
|
|
|
Layout/TrailingEmptyLines:
|
2016-08-06 15:45:37 +00:00
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
# No trailing whitespace.
|
2017-05-24 18:33:50 +00:00
|
|
|
Layout/TrailingWhitespace:
|
2016-08-06 15:45:37 +00:00
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
# Use quotes for string literals when they are enough.
|
2019-08-20 12:52:53 +00:00
|
|
|
Style/RedundantPercentQ:
|
2016-07-20 03:35:11 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2019-03-06 01:01:33 +00:00
|
|
|
Lint/AmbiguousOperator:
|
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
Lint/AmbiguousRegexpLiteral:
|
|
|
|
Enabled: true
|
|
|
|
|
2021-01-09 05:40:47 +00:00
|
|
|
Lint/DuplicateRequire:
|
|
|
|
Enabled: true
|
|
|
|
|
2019-02-01 05:16:55 +00:00
|
|
|
Lint/ErbNewArguments:
|
|
|
|
Enabled: true
|
|
|
|
|
2016-08-06 15:45:37 +00:00
|
|
|
# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
|
|
|
|
Lint/RequireParentheses:
|
|
|
|
Enabled: true
|
2017-10-28 12:15:34 +00:00
|
|
|
|
2019-11-27 23:53:47 +00:00
|
|
|
Lint/RedundantStringCoercion:
|
2018-05-21 12:04:01 +00:00
|
|
|
Enabled: true
|
|
|
|
|
2018-08-16 04:05:05 +00:00
|
|
|
Lint/UriEscapeUnescape:
|
|
|
|
Enabled: true
|
|
|
|
|
2021-09-06 14:24:37 +00:00
|
|
|
Lint/UselessAssignment:
|
|
|
|
Enabled: true
|
|
|
|
|
2019-01-09 03:00:08 +00:00
|
|
|
Lint/DeprecatedClassMethods:
|
|
|
|
Enabled: true
|
|
|
|
|
2018-08-18 23:12:05 +00:00
|
|
|
Style/ParenthesesAroundCondition:
|
|
|
|
Enabled: true
|
|
|
|
|
2020-02-20 22:37:32 +00:00
|
|
|
Style/HashTransformKeys:
|
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
Style/HashTransformValues:
|
|
|
|
Enabled: true
|
|
|
|
|
2018-12-20 17:44:01 +00:00
|
|
|
Style/RedundantBegin:
|
|
|
|
Enabled: true
|
|
|
|
|
2017-10-31 22:32:04 +00:00
|
|
|
Style/RedundantReturn:
|
|
|
|
Enabled: true
|
|
|
|
AllowMultipleReturnValues: true
|
|
|
|
|
2020-09-07 11:13:53 +00:00
|
|
|
Style/RedundantRegexpEscape:
|
|
|
|
Enabled: true
|
|
|
|
|
2017-10-28 12:15:34 +00:00
|
|
|
Style/Semicolon:
|
|
|
|
Enabled: true
|
|
|
|
AllowAsExpressionSeparator: true
|
2018-02-22 06:26:48 +00:00
|
|
|
|
|
|
|
# Prefer Foo.method over Foo::method
|
|
|
|
Style/ColonMethodCall:
|
|
|
|
Enabled: true
|
2018-03-30 02:29:55 +00:00
|
|
|
|
|
|
|
Style/TrivialAccessors:
|
|
|
|
Enabled: true
|
|
|
|
|
2021-02-08 07:57:53 +00:00
|
|
|
Performance/BindCall:
|
|
|
|
Enabled: true
|
|
|
|
|
2018-03-30 02:29:55 +00:00
|
|
|
Performance/FlatMap:
|
|
|
|
Enabled: true
|
|
|
|
|
2021-04-23 07:31:19 +00:00
|
|
|
Performance/MapCompact:
|
|
|
|
Enabled: true
|
|
|
|
|
2021-04-26 21:55:33 +00:00
|
|
|
Performance/SelectMap:
|
|
|
|
Enabled: true
|
|
|
|
|
2018-03-30 02:29:55 +00:00
|
|
|
Performance/RedundantMerge:
|
|
|
|
Enabled: true
|
2018-07-28 21:37:17 +00:00
|
|
|
|
|
|
|
Performance/StartWith:
|
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
Performance/EndWith:
|
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
Performance/RegexpMatch:
|
|
|
|
Enabled: true
|
2018-05-17 08:32:27 +00:00
|
|
|
|
2019-03-06 00:31:55 +00:00
|
|
|
Performance/ReverseEach:
|
|
|
|
Enabled: true
|
|
|
|
|
2021-04-23 07:15:32 +00:00
|
|
|
Performance/StringReplacement:
|
|
|
|
Enabled: true
|
|
|
|
|
2018-05-17 08:32:27 +00:00
|
|
|
Performance/UnfreezeString:
|
|
|
|
Enabled: true
|
2020-05-24 00:23:46 +00:00
|
|
|
|
|
|
|
Performance/DeletePrefix:
|
|
|
|
Enabled: true
|
|
|
|
|
|
|
|
Performance/DeleteSuffix:
|
|
|
|
Enabled: true
|
2021-06-24 10:46:21 +00:00
|
|
|
|
|
|
|
Minitest/UnreachableAssertion:
|
|
|
|
Enabled: true
|