.rubocop.yml

   1 # This file (.rubocop.yml) encodes consciously chosen deviation from Rubocop's
   2 # default configuration. The jury is still out regarding other checks, which are
   3 # disabled or tweaked in .rubocop_todo.yml.
   4
   5 inherit_from: .rubocop_todo.yml
   6
   7 AllCops:
   8   Exclude:
   9     # Let's ignore this script until we start using it and maintaining
  10     # the corresponding doc-source-relationships.yml
  11     - 'bin/doc-impacted-by'
  12   TargetRubyVersion: 2.5
  13
  14 Layout/HashAlignment:
  15   EnforcedHashRocketStyle: table
  16   EnforcedColonStyle: table
  17
  18 Lint/SuppressedException:
  19   AllowComments: true
  20
  21 Metrics/AbcSize:
  22   Max: 30
  23
  24 Metrics/BlockLength:
  25   Max: 27
  26   ExcludedMethods:
  27     # Rake
  28     - 'namespace'
  29     - 'task'
  30     # Vagrant
  31     - 'Vagrant.configure'
  32
  33 Metrics/ClassLength:
  34   Max: 200
  35
  36 Metrics/CyclomaticComplexity:
  37   Max: 9
  38
  39 Metrics/MethodLength:
  40   Max: 30
  41
  42 Metrics/ParameterLists:
  43   CountKeywordArgs: false
  44
  45 Metrics/PerceivedComplexity:
  46   Max: 10
  47
  48 Naming/BlockParameterName:
  49   AllowedNames:
  50     - expected_patterns_MiB
  51     - size_MiB
  52     - size_in_MiB_of_destination_disk
  53
  54 Naming/MethodName:
  55   IgnoredPatterns:
  56     # Cucumber
  57     - \A(After|Before)Feature\z
  58     # Case matters: bit vs. byte
  59     - _(kB|MiB)\z
  60     # Stay close to Dogtail's API
  61     - \A(pressKey|roleName|typeText)\z
  62     # Stay close to OpenCV's API
  63     - \AmatchTemplate\z
  64
  65 Naming/MethodParameterName:
  66   AllowedNames:
  67     - h
  68     - to
  69     - vm
  70     - w
  71     - x
  72     - y
  73
  74 Style/AccessModifierDeclarations:
  75   EnforcedStyle: inline
  76
  77 Style/AsciiComments:
  78   Enabled: false
  79
  80 Style/AutoResourceCleanup:
  81   Enabled: true
  82
  83 Style/ClassAndModuleChildren:
  84   EnforcedStyle: compact
  85
  86 Style/ClassVars:
  87   Exclude:
  88     - 'features/support/helpers/dogtail.rb'
  89     - 'features/support/helpers/remote_shell.rb'
  90
  91 Style/CollectionMethods:
  92   Enabled: true
  93
  94 Style/ConstantVisibility:
  95   Enabled: true
  96
  97 Style/FrozenStringLiteralComment:
  98   Enabled: false
  99
 100 Style/GlobalVars:
 101   Exclude:
 102     - 'Rakefile'
 103
 104 Style/GuardClause:
 105   MinBodyLength: 3
 106
 107 Style/HashEachMethods:
 108   Enabled: true
 109
 110 Style/HashTransformKeys:
 111   Enabled: true
 112
 113 Style/HashTransformValues:
 114   Enabled: true
 115
 116 Style/HashSyntax:
 117   EnforcedStyle: ruby19_no_mixed_keys
 118
 119 Style/MethodCallWithArgsParentheses:
 120   Enabled: true
 121   IgnoredMethods:
 122     - abort
 123     - assert
 124     - basename
 125     - chdir
 126     - debug_log
 127     - define
 128     - delete
 129     - desc
 130     - exist?
 131     - exit
 132     - fatal_system
 133     - include
 134     - include?
 135     - mkdir
 136     - mktmpdir
 137     - puts
 138     - raise
 139     - remove_entry_secure
 140     - require
 141     - require_relative
 142     - returncode
 143     - separator
 144     - should
 145     - should_not
 146     - sleep
 147     - start_with?
 148     - step
 149     - task
 150     - wait
 151     - warn
 152     - write
 153     - yield
 154
 155 Style/MethodCalledOnDoEndBlock:
 156   Enabled: true
 157
 158 Style/NumericLiterals:
 159   MinDigits: 6
 160
 161 Style/OptionHash:
 162   Enabled: true
 163
 164 Style/ReturnNil:
 165   Enabled: true
 166
 167 Style/Send:
 168   Enabled: true
 169
 170 Style/SingleLineBlockParams:
 171   Enabled: true
 172
 173 Style/StringMethods:
 174   Enabled: true
 175
 176 Style/SymbolArray:
 177   EnforcedStyle: brackets
 178
 179 Style/TrailingCommaInArguments:
 180   EnforcedStyleForMultiline: no_comma
 181
 182 Style/TrailingCommaInArrayLiteral:
 183   EnforcedStyleForMultiline: consistent_comma
 184
 185 Style/TrailingCommaInHashLiteral:
 186   EnforcedStyleForMultiline: consistent_comma
 187
 188 Style/WordArray:
 189   EnforcedStyle: brackets