.rubocop.yml 5.02 KB
Newer Older
Jonne Haß's avatar
Jonne Haß committed
1
AllCops:
2
  Exclude:
Benjamin Neff's avatar
Benjamin Neff committed
3 4
    - "bin/**/*"
    - "db/schema.rb"
Jonne Haß's avatar
Jonne Haß committed
5

Dennis Schubert's avatar
Dennis Schubert committed
6 7 8
Rails:
  Enabled: true

9 10 11 12
# Disable for rails 4
Rails/HttpPositionalArguments:
  Enabled: false

Jonne Haß's avatar
Jonne Haß committed
13 14 15 16 17 18 19 20 21 22 23 24
# Commonly used screens these days easily fit more than 80 characters.
Metrics/LineLength:
  Max: 120

# Too short methods lead to extraction of single-use methods, which can make
# the code easier to read (by naming things), but can also clutter the class
Metrics/MethodLength: 
  Max: 20

# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
Metrics/ClassLength:
  Max: 1500
Benjamin Neff's avatar
Benjamin Neff committed
25 26
Metrics/ModuleLength:
  Max: 1500
27 28 29 30
  
# Raise AbcSize from 15 to 20
Metrics/AbcSize:
  Max: 20
Jonne Haß's avatar
Jonne Haß committed
31

Benjamin Neff's avatar
Benjamin Neff committed
32 33 34 35 36 37 38 39 40
# Some blocks are longer.
Metrics/BlockLength:
  ExcludedMethods:
    - "namespace"
    - "create_table"
  Exclude:
    - "config/**/*.rb"
    - "spec/**/*.rb"

Jonne Haß's avatar
Jonne Haß committed
41 42
# No space makes the method definition shorter and differentiates
# from a regular assignment.
Benjamin Neff's avatar
Benjamin Neff committed
43
Layout/SpaceAroundEqualsInParameterDefault:
Jonne Haß's avatar
Jonne Haß committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57
  EnforcedStyle: no_space

# Single quotes being faster is hardly measurable and only affects parse time.
# Enforcing double quotes reduces the times where you need to change them
# when introducing an interpolation. Use single quotes only if their semantics
# are needed.
Style/StringLiterals:
  EnforcedStyle: double_quotes

# We do not need to support Ruby 1.9, so this is good to use.
Style/SymbolArray:
  Enabled: true

# Most readable form.
Benjamin Neff's avatar
Benjamin Neff committed
58
Layout/AlignHash:
Jonne Haß's avatar
Jonne Haß committed
59 60 61 62
  EnforcedHashRocketStyle: table
  EnforcedColonStyle: table

# Mixing the styles looks just silly.
Jonne Haß's avatar
Jonne Haß committed
63 64
Style/HashSyntax:
 EnforcedStyle: ruby19_no_mixed_keys
Jonne Haß's avatar
Jonne Haß committed
65 66

# has_key? and has_value? are far more readable than key? and value?
Benjamin Neff's avatar
Benjamin Neff committed
67
Style/PreferredHashMethods:
Jonne Haß's avatar
Jonne Haß committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
  Enabled: false

# String#% is by far the least verbose and only object oriented variant.
Style/FormatString:
  EnforcedStyle: percent

Style/CollectionMethods:
  Enabled: true
  PreferredMethods:
    # inject seems more common in the community.
    reduce: "inject"


# Either allow this style or don't. Marking it as safe with parenthesis
# is silly. Let's try to live without them for now.
Style/ParenthesesAroundCondition:
  AllowSafeAssignment: false
Lint/AssignmentInCondition:
  AllowSafeAssignment: false

# A specialized exception class will take one or more arguments and construct the message from it.
# So both variants make sense. 
Style/RaiseArgs:
  Enabled: false

93 94
# Indenting the chained dots beneath each other is not supported by this cop,
# see https://github.com/bbatsov/rubocop/issues/1633
Benjamin Neff's avatar
Benjamin Neff committed
95
Layout/MultilineOperationIndentation:
96 97
  Enabled: false

Jonne Haß's avatar
Jonne Haß committed
98 99 100 101 102 103 104 105 106 107 108 109
# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
# The argument that fail should be used to abort the program is wrong too,
# there's Kernel#abort for that.
Style/SignalException:
  EnforcedStyle: only_raise

# Suppressing exceptions can be perfectly fine, and be it to avoid to
# explicitly type nil into the rescue since that's what you want to return,
# or suppressing LoadError for optional dependencies
Lint/HandleExceptions:
  Enabled: false

Benjamin Neff's avatar
Benjamin Neff committed
110
Layout/SpaceInsideBlockBraces:
Jonne Haß's avatar
Jonne Haß committed
111 112 113 114 115 116 117
  # The space here provides no real gain in readability while consuming
  # horizontal space that could be used for a better parameter name.
  # Also {| differentiates better from a hash than { | does.
  SpaceBeforeBlockParameters: false

# No trailing space differentiates better from the block:
# foo} means hash, foo } means block.
Benjamin Neff's avatar
Benjamin Neff committed
118
Layout/SpaceInsideHashLiteralBraces:
Jonne Haß's avatar
Jonne Haß committed
119 120 121 122
  EnforcedStyle: no_space

# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
Jonne Haß's avatar
Jonne Haß committed
123
Style/BlockDelimiters:
Jonne Haß's avatar
Jonne Haß committed
124 125
  Enabled: false

126 127 128 129 130
# Enforcing -> would be nice, but not at the cost of enforcing lambda { } for
# multiline lambdas.
Style/Lambda:
  Enabled: false

Jonne Haß's avatar
Jonne Haß committed
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
# do / end blocks should be used for side effects,
# methods that run a block for side effects and have
# a useful return value are rare, assign the return
# value to a local variable for those cases.
Style/MethodCalledOnDoEndBlock:
  Enabled: true

# Enforcing the names of variables? To single letter ones? Just no.
Style/SingleLineBlockParams:
  Enabled: false

# Shadowing outer local variables with block parameters is often useful
# to not reinvent a new name for the same thing, it highlights the relation
# between the outer variable and the parameter. The cases where it's actually
# confusing are rare, and usually bad for other reasons already, for example
# because the method is too long.
Lint/ShadowingOuterLocalVariable:
  Enabled: false

# Check with yard instead.
Style/Documentation:
  Enabled: false 

# This is just silly. Calling the argument `other` in all cases makes no sense.
Style/OpMethod:
  Enabled: false 

# There are valid cases, for example debugging Cucumber steps,
# also they'll fail CI anyway
Lint/Debugger:
  Enabled: false

Benjamin Neff's avatar
Benjamin Neff committed
163 164 165
# We used comparison everywhere.
Style/NumericPredicate:
  EnforcedStyle: comparison
166 167

# Reset some HoundCI changes back to Rubocop defaults
Benjamin Neff's avatar
Benjamin Neff committed
168
Layout/DotPosition:
169
  EnforcedStyle: leading
Benjamin Neff's avatar
Benjamin Neff committed
170 171 172 173 174 175

### backward compatibility

# only with ruby >= 2.4
Performance/RegexpMatch:
  Enabled: false