rubocop: Revert PR 15312, unset EnabledByDefault

- This proved sufficiently controversial in the comments of https://github.com/Homebrew/brew/issues/15297.
- There are too many cops in this list that _don't_ make sense for us.
- For the few that do (with many thanks to Bo for going in depth to
  figure them out!), we can selectively enable them without using
  EnabledByDefault` and a whole load of `Enabled: false`.
This commit is contained in:
Issy Long 2023-05-29 15:07:08 +01:00
parent 89dfe4fc5b
commit a1f855bb1b
No known key found for this signature in database
GPG Key ID: 8247C390DADC67D4

View File

@ -14,7 +14,6 @@ inherit_mode:
AllCops:
TargetRubyVersion: 2.6
ActiveSupportExtensionsEnabled: true
EnabledByDefault: true
NewCops: enable
Include:
- "**/*.rbi"
@ -26,23 +25,30 @@ AllCops:
- "Homebrew/vendor/**/*"
- "Taps/*/*/vendor/**/*"
# TODO: This group of cops comes from `EnabledByDefault: true`. We should maybe enable the ones with < 100 offenses.
Bundler/GemComment:
Enabled: false
Bundler/GemVersion:
Enabled: false
Cask/Desc:
Description: "Ensure that the desc stanza conforms to various content and style checks."
Enabled: true
Cask/HomepageUrlTrailingSlash:
Description: "Ensure that the homepage url has a slash after the domain name."
Enabled: true
Cask/StanzaGrouping:
Description: "Ensure that cask stanzas are grouped correctly. More info at https://docs.brew.sh/Cask-Cookbook#stanza-order"
Enabled: true
Cask/StanzaOrder:
Description: "Ensure that cask stanzas are sorted correctly. More info at https://docs.brew.sh/Cask-Cookbook#stanza-order"
Enabled: true
FormulaAudit:
Enabled: true
FormulaAuditStrict:
Enabled: true
Homebrew:
Enabled: true
# only used internally
Homebrew/MoveToExtendOS:
@ -59,34 +65,6 @@ Layout/ArgumentAlignment:
Layout/CaseIndentation:
EnforcedStyle: end
# TODO: This group of cops comes from `EnabledByDefault: true`. We should maybe enable the ones with < 100 offenses.
Layout/ClassStructure:
Enabled: false
Layout/EmptyLineAfterMultilineCondition:
Enabled: false
Layout/FirstArrayElementLineBreak:
Enabled: false
Layout/FirstHashElementLineBreak:
Enabled: false
Layout/FirstMethodArgumentLineBreak:
Enabled: false
Layout/FirstMethodParameterLineBreak:
Enabled: false
Layout/MultilineArrayLineBreaks:
Enabled: false
Layout/MultilineAssignmentLayout:
Enabled: false
Layout/MultilineHashKeyLineBreaks:
Enabled: false
Layout/MultilineMethodArgumentLineBreaks:
Enabled: false
Layout/MultilineMethodParameterLineBreaks:
Enabled: false
Layout/RedundantLineBreak:
Enabled: false
Layout/SingleLineBlockChain:
Enabled: false
# significantly less indentation involved; more consistent
Layout/FirstArrayElementIndentation:
EnforcedStyle: consistent
@ -153,12 +131,6 @@ Layout/SpaceBeforeBrackets:
Lint/AmbiguousBlockAssociation:
Enabled: false
# TODO: This group of cops comes from `EnabledByDefault: true`. We should maybe enable the ones with < 100 offenses.
Lint/ConstantResolution:
Enabled: false
Lint/NumberConversion:
Enabled: false
Lint/DuplicateBranch:
Exclude:
- "Taps/*/*/*.rb"
@ -219,41 +191,56 @@ Naming/VariableNumber:
Performance/Caller:
Enabled: false
# Does not hinder readability, so might as well enable it.
Performance/CaseWhenSplat:
Enabled: true
# Makes code less readable for minor performance increases.
Performance/MethodObjectAsBlock:
Enabled: false
# TODO: This group of cops comes from `EnabledByDefault: true`. We should maybe enable the ones with < 100 offenses.
Performance/ChainArrayAllocation:
Enabled: false
Performance/IoReadlines:
Enabled: false
Performance/OpenStruct:
Enabled: false
Rails:
# Selectively enable what we want.
Enabled: false
# Do not use ActiveSupport in RuboCops.
Exclude:
- "Homebrew/rubocops/**/*"
# These relate to ActiveSupport and not other parts of Rails.
Rails/ActiveSupportAliases:
Enabled: true
Rails/Blank:
Enabled: true
Rails/CompactBlank:
Enabled: true
Rails/Delegate:
Enabled: false # TODO
# TODO: This group of cops comes from `EnabledByDefault: true`. We should maybe enable the ones with < 100 offenses.
Rails/ArelStar:
Enabled: false
Rails/Date:
Enabled: false
Rails/RakeEnvironment:
Enabled: false
Rails/Pluck:
Enabled: false
Rails/SaveBang:
Enabled: false
Rails/SkipsModelValidations:
Enabled: false
Rails/TimeZone:
Enabled: false
Rails/DelegateAllowBlank:
Enabled: true
Rails/DurationArithmetic:
Enabled: true
Rails/ExpandedDateRange:
Enabled: true
Rails/Inquiry:
Enabled: true
Rails/NegateInclude:
Enabled: true
Rails/PluralizationGrammar:
Enabled: true
Rails/Presence:
Enabled: true
Rails/Present:
Enabled: true
Rails/RelativeDateConstant:
Enabled: true
Rails/SafeNavigation:
Enabled: true
Rails/SafeNavigationWithBlank:
Enabled: true
Rails/StripHeredoc:
Enabled: true
Rails/ToFormattedS:
Enabled: true
# Intentionally disabled as it doesn't fit with our code style.
RSpec/AnyInstance:
@ -267,16 +254,6 @@ RSpec/StubbedMock:
RSpec/SubjectStub:
Enabled: false
# TODO: These cops come from `EnabledByDefault: true`. We should maybe enable the ones with < 100 offenses.
RSpec/AlignLeftLetBrace:
Enabled: false
RSpec/AlignRightLetBrace:
Enabled: false
RSpec/MessageExpectation:
Enabled: false
RSpec/Pending:
Enabled: false
# We use `allow(:foo).to receive(:bar)` everywhere.
RSpec/MessageSpies:
EnforcedStyle: receive
@ -303,21 +280,12 @@ Sorbet/ConstantsFromStrings:
Sorbet/FalseSigil:
Enabled: false
# TODO: These cops come from `EnabledByDefault: true`. We should maybe enable the ones with < 100 offenses.
Sorbet/EnforceSignatures:
Enabled: false
Sorbet/ForbidTUnsafe:
Enabled: false
Sorbet/ForbidTUntyped:
Enabled: false
Sorbet/HasSigil:
Enabled: false
Sorbet/IgnoreSigil:
Enabled: false
Sorbet/StrongSigil:
Enabled: false
# T::Sig is monkey-patched into Module
Sorbet/RedundantExtendTSig:
Enabled: true
Sorbet/StrictSigil:
Enabled: true
inherit_mode:
override:
- Include
@ -325,6 +293,7 @@ Sorbet/StrictSigil:
- "**/*.rbi"
Sorbet/TrueSigil:
Enabled: true
Exclude:
- "Taps/**/*"
- "/**/{Formula,Casks}/**/*.rb"
@ -335,6 +304,10 @@ Sorbet/TrueSigil:
Style/AndOr:
EnforcedStyle: always
# Avoid leaking resources.
Style/AutoResourceCleanup:
Enabled: true
# This makes these a little more obvious.
Style/BarePercentLiterals:
EnforcedStyle: percent_q
@ -343,56 +316,13 @@ Style/BlockDelimiters:
BracesRequiredMethods:
- "sig"
# TODO: This group of cops comes from `EnabledByDefault: true`. We should maybe enable the ones with < 100 offenses.
Style/ArrayCoercion:
Enabled: false
Style/AsciiComments:
Enabled: false
Style/ClassMethodsDefinitions:
Enabled: false
Style/ConstantVisibility:
Enabled: false
Style/Copyright:
Enabled: false
Style/DateTime:
Enabled: false
Style/DocumentationMethod:
Enabled: false
Style/ImplicitRuntimeError:
Enabled: false
Style/InlineComment:
Enabled: false
Style/IpAddresses:
Enabled: false
Style/MethodCallWithArgsParentheses:
Enabled: false
Style/MethodCalledOnDoEndBlock:
Enabled: false
Style/MissingElse:
Enabled: false
Style/MultilineMethodSignature:
Enabled: false
Style/OptionHash:
Enabled: false
Style/RequireOrder:
Enabled: false
Style/Send:
Enabled: false
Style/SingleLineBlockParams:
Enabled: false
Style/StaticClass:
Enabled: false
Style/StringHashKeys:
Enabled: false
Style/TopLevelMethodDefinition:
Enabled: false
Style/TrailingCommaInBlockArgs:
Enabled: false
Style/YodaExpression:
Enabled: false
# Use consistent style for better readability.
Style/CollectionMethods:
Enabled: true
# Don't allow cops to be disabled in casks and formulae.
Style/DisableCopsWithinSourceCodeDirective:
Enabled: true
Include:
- "Taps/*/*/*.rb"
- "/**/{Formula,Casks}/**/*.rb"
@ -440,6 +370,7 @@ Style/HashAsLastArrayItem:
- "**/Formula/**/*.rb"
Style/InvertibleUnlessCondition:
Enabled: true
InverseMethods:
# Favor `if a != b` over `unless a == b`
:==: :!=
@ -472,6 +403,10 @@ Style/OpenStructUse:
Style/RescueStandardError:
EnforcedStyle: implicit
# Returning `nil` is unnecessary.
Style/ReturnNil:
Enabled: true
# We have no use for using `warn` because we
# are calling Ruby with warnings disabled.
Style/StderrPuts:
@ -492,6 +427,10 @@ Style/StringLiterals:
Style/StringLiteralsInInterpolation:
EnforcedStyle: double_quotes
# Use consistent method names.
Style/StringMethods:
Enabled: true
# An array of symbols is more readable than a symbol array
# and also allows for easier grepping.
Style/SymbolArray:
@ -511,6 +450,7 @@ Style/TrailingCommaInHashLiteral:
# `unless ... ||` and `unless ... &&` are hard to mentally parse
Style/UnlessLogicalOperators:
Enabled: true
EnforcedStyle: forbid_logical_operators
# a bit confusing to non-Rubyists but useful for longer arrays