Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

.rubocop: tweak rules. #4797

Merged
merged 1 commit into from
Sep 2, 2018
Merged

.rubocop: tweak rules. #4797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
200 changes: 92 additions & 108 deletions Library/.rubocop.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,146 +7,148 @@ AllCops:

require: ./Homebrew/rubocops.rb

# enable all formulae audits
FormulaAudit:
Enabled: true

# enable all formulae strict audits
FormulaAuditStrict:
Enabled: true

# disable all formulae strict audits by default
NewFormulaAudit:
Enabled: false

# `system` is a special case and aligns on second argument
Layout/AlignParameters:
Enabled: false

# favour parens-less DSL-style arguments
Lint/AmbiguousOperator:
Enabled: false

# this is a bit less "floaty"
Layout/CaseIndentation:
EnforcedStyle: end

Layout/EmptyLineBetweenDefs:
AllowAdjacentOneLineDefs: true

# this is a bit less "floaty"
Layout/EndAlignment:
EnforcedStyleAlignWith: variable

Layout/IndentArray:
EnforcedStyle: special_inside_parentheses
EnforcedStyleAlignWith: start_of_line

# enforce use of <<~EOS
Layout/IndentHeredoc:
EnforcedStyle: squiggly

# conflicts with DSL-style path concatenation with `/`
Layout/SpaceAroundOperators:
Enabled: false

# favor parens-less DSL-style arguments
Lint/AmbiguousOperator:
# use spaces for indentation; detect tabs
Layout/Tab:
Enabled: true

# favour parens-less DSL-style arguments
Lint/AmbiguousBlockAssociation:
Enabled: false


# so many of these in formulae and can't be autocorrected
# TODO: fix these as `ruby -w` complains about them.
Lint/AmbiguousRegexpLiteral:
Enabled: false

# favor parens-less DSL-style arguments
Lint/AmbiguousBlockAssociation:
Enabled: false

# assignment in conditions are useful sometimes
# TODO: add parentheses for these and remove
Lint/AssignmentInCondition:
Enabled: false

# we output how to use interpolated strings too often
Lint/InterpolationCheck:
Enabled: false

# so many of these in formulae and can't be autocorrected
Lint/ParenthesesAsGroupedExpression:
Enabled: false

# most metrics don't make sense to apply for formulae/taps
Metrics/AbcSize:
Enabled: false

Metrics/BlockLength:
Enabled: false

Metrics/ClassLength:
Enabled: false

Metrics/CyclomaticComplexity:
Enabled: false
Metrics/MethodLength:
Enabled: false
# Metrics/ModuleLength:
# Enabled: false
Metrics/PerceivedComplexity:
Enabled: false

# keyword arguments don't have the same readability problems
Metrics/ParameterLists:
CountKeywordArgs: false

# GitHub diff UI wraps beyond 118 characters (so that's the goal)
Metrics/LineLength:
# 118 is the goal as GitHub diff UI wraps beyond that
Max: 189
# ignore manpage comments and long single-line strings
IgnoredPatterns: ['#: ', ' url "', ' mirror "', ' plist_options :']

Metrics/MethodLength:
Enabled: false

Metrics/ModuleLength:
Enabled: false
# dashes in filenames are typical
Naming/FileName:
Regex: !ruby/regexp /^[\w\@\-\+\.]+(\.rb)?$/

Metrics/ParameterLists:
CountKeywordArgs: false
# implicitly allow EOS as we use it everywhere
Naming/HeredocDelimiterNaming:
Blacklist:
- END, EOD, EOF

Metrics/PerceivedComplexity:
# we have too many variables like sha256 where this harms readability
Naming/VariableNumber:
Enabled: false

# makes code less readable for minor performance increases
Performance/Caller:
Enabled: false

Style/Alias:
EnforcedStyle: prefer_alias

Style/AsciiComments:
Enabled: false
# we're doing this already so why not
Performance/CaseWhenSplat:
Enabled: true

# enable to avoid leaking resources
Style/AutoResourceCleanup:
Enabled: true

# this is a little more obvious what's going on
Style/BarePercentLiterals:
EnforcedStyle: percent_q

Style/BlockDelimiters:
EnforcedStyle: line_count_based

Style/ClassAndModuleChildren:
EnforcedStyle: nested
# consistency helps readability and helps people who don't know Ruby
Style/CollectionMethods:
Enabled: true

# our current conditional style is established, clear and
# requiring users to change that now would be confusing.
# our current conditional style is established
# TODO: enable this when possible
Style/ConditionalAssignment:
Enabled: false

# most of our APIs are internal so don't require docs
Style/Documentation:
Enabled: false

# we don't need UTF-8 encoding comments
Style/Encoding:
Enabled: true

# disabled until we get the Metrics/LineLength down to 80.
Style/IfUnlessModifier:
Enabled: false

# messes with existing plist/caveats style
Style/TrailingBodyOnMethodDefinition:
Enabled: false

# use spaces for indentation; detect tabs
Layout/Tab:
Enabled: true

# We have no use for using `warn` because we are
# calling Ruby with warnings disabled ourselves.
Style/StderrPuts:
Enabled: false

# dashes in filenames are typical
Naming/FileName:
Regex: !ruby/regexp /^[\w\@\-\+\.]+(\.rb)?$/

# falsely flags e.g. curl formatting arguments as format strings
Style/FormatStringToken:
EnforcedStyle: template

# we want to add this slowly and manually
# TODO: add to more files
Style/FrozenStringLiteralComment:
Enabled: false

# so many of these in formulae and can't be autocorrected
Expand All @@ -162,33 +164,31 @@ Style/HashSyntax:
- '**/lib/**/*'
- '**/spec/**/*'

# this doesn't make sense for wide lines below maximum line length
# https://github.com/rubocop-hq/rubocop/issues/6149
Style/IfUnlessModifier:
Enabled: false

# only for numbers >= 1_000_000
Style/NumericLiterals:
MinDigits: 7

# zero-prefixed octal literals are just too widely used (and mostly understood)
# zero-prefixed octal literals are just too widely used (and understood)
Style/NumericLiteralPrefix:
EnforcedOctalStyle: zero_only

# consistency and readability when faced with string interpolation
Style/PercentLiteralDelimiters:
PreferredDelimiters:
'%': '()'
'%i': '()'
'%q': '()'
'%Q': '()'
'%r': '{}'
'%s': '()'
'%w': '[]'
'%W': '[]'
'%x': '()'

Style/RaiseArgs:
EnforcedStyle: exploded

# paths abound, easy escape
Style/RegexpLiteral:
EnforcedStyle: slashes
# rescuing StandardError is an understood default
Style/RescueStandardError:
EnforcedStyle: implicit

# return nil is unnecessary and a common mistake believing it's required
Style/ReturnNil:
Enabled: true

# We have no use for using `warn` because we are
# calling Ruby with warnings disabled ourselves (for now).
Style/StderrPuts:
Enabled: false

# ruby style guide favorite
Style/StringLiterals:
Expand All @@ -198,46 +198,30 @@ Style/StringLiterals:
Style/StringLiteralsInInterpolation:
EnforcedStyle: double_quotes

# consistency helps readability and helps people who don't know Ruby
Style/StringMethods:
Enabled: true

# less confusing to non-Rubyists
Style/SymbolArray:
EnforcedStyle: brackets

# make things a bit easier to read
Style/TernaryParentheses:
EnforcedStyle: require_parentheses_when_complex

# makes diffs nicer
# messes with existing plist/caveats style
Style/TrailingBodyOnMethodDefinition:
Enabled: false

# all trailing commas make diffs nicer
Style/TrailingCommaInArguments:
EnforcedStyleForMultiline: comma
Style/TrailingCommaInArrayLiteral:
EnforcedStyleForMultiline: comma

Style/TrailingCommaInHashLiteral:
EnforcedStyleForMultiline: comma

Style/TrailingCommaInArguments:
EnforcedStyleForMultiline: comma

# we have too many variables like sha256 where this harms readability
Naming/VariableNumber:
Enabled: false

# doesn't make sense for Homebrew/brew but does for taps
Naming/UncommunicativeMethodParamName:
Enabled: true

# a bit confusing to non-Rubyists but useful for longer arrays
Style/WordArray:
MinSize: 4

# we want to add this slowly and manually
Style/FrozenStringLiteralComment:
Enabled: false

# generally rescuing StandardError is fine
Style/RescueStandardError:
Enabled: false

# implicitly allow EOS as we use it everywhere
Naming/HeredocDelimiterNaming:
Blacklist:
- END, EOD, EOF

# we output how to use interpolated strings too often
Lint/InterpolationCheck:
Enabled: false