free_mutant/config/rubocop.yml
2013-12-31 13:10:13 +01:00

114 lines
2.7 KiB
YAML

# General note about rubocop.
# It does NOT allow to silence a specific rule violation.
# For that reason I sometimes have to disable a whole cop where
# I just tried to whitelist a specific occurence.
AllCops:
Includes:
- '../**/*.rake'
- 'Gemfile'
- 'Gemfile.triage'
- 'mutant.gemspec'
Excludes:
- '**/vendor/**'
- '**/benchmarks/**'
# Avoid parameter lists longer than five parameters.
ParameterLists:
Max: 3
CountKeywordArgs: true
# Avoid more than `Max` levels of nesting.
BlockNesting:
Max: 3
# Align with the style guide.
CollectionMethods:
PreferredMethods:
collect: 'map'
inject: 'reduce'
find: 'detect'
find_all: 'select'
# Do not force public/protected/private keyword to be indented at the same
# level as the def keyword. My personal preference is to outdent these keywords
# because I think when scanning code it makes it easier to identify the
# sections of code and visually separate them. When the keyword is at the same
# level I think it sort of blends in with the def keywords and makes it harder
# to scan the code and see where the sections are.
AccessControl:
Enabled: false
MethodLength:
CountComments: false
Max: 17 # TODO: Bring down to 10
RegexpLiteral: # I do not agree %r(\A) is more readable than /\A/
Enabled: false
Eval:
Enabled: false # Mutant must use Kernel#eval to inject mutated source
# Limit line length
LineLength:
Max: 124 # TODO: lower to 79
# Disable documentation checking until a class needs to be documented once
Documentation:
Enabled: false
# Do not favor modifier if/unless usage when you have a single-line body
IfUnlessModifier:
Enabled: false
# Mutant needs to define methods like def bar; end in specs
Semicolon:
Enabled: false
# Mutant needs to define multiple methods on same line in specs
EmptyLineBetweenDefs:
Enabled: false
# Mutant needs to define singleton methods like Foo.bar in specs
ClassMethods:
Enabled: false
# Allow case equality operator (in limited use within the specs)
CaseEquality:
Enabled: false
# Constants do not always have to use SCREAMING_SNAKE_CASE
ConstantName:
Enabled: false
# Not all trivial readers/writers can be defined with attr_* methods
TrivialAccessors:
Enabled: false
# And also have a differend opinion here
AndOr:
Enabled: false
# I like my raise
SignalException:
Enabled: false
# I need to chain optparse builder, else it is more ugly
MultilineBlockChain:
Enabled: false
ClassLength:
Max: 105
# I align private keywords with class body
IndentationWidth:
Enabled: false
# I like to have an empty line before closing the currently opened body
EmptyLinesAroundBody:
Enabled: false
# I like my style more
AccessModifierIndentation:
Enabled: false