.rubocop.yml 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. # Can be removed once all rules are addressed or moved to this file as documented overrides
  2. inherit_from: .rubocop_todo.yml
  3. # Used for merging with exclude lists with .rubocop_todo.yml
  4. inherit_mode:
  5. merge:
  6. - Exclude
  7. require:
  8. - rubocop-rails
  9. - rubocop-rspec
  10. - rubocop-performance
  11. - rubocop-capybara
  12. - ./lib/linter/rubocop_middle_dot
  13. AllCops:
  14. TargetRubyVersion: 3.0 # Set to minimum supported version of CI
  15. DisplayCopNames: true
  16. DisplayStyleGuide: true
  17. ExtraDetails: true
  18. UseCache: true
  19. CacheRootDirectory: tmp
  20. NewCops: enable # Opt-in to newly added rules
  21. Exclude:
  22. - db/schema.rb
  23. - 'bin/*'
  24. - 'node_modules/**/*'
  25. - 'Vagrantfile'
  26. - 'vendor/**/*'
  27. - 'config/initializers/json_ld*' # Generated files
  28. - 'lib/mastodon/migration_helpers.rb' # Vendored from GitLab
  29. - 'lib/templates/**/*'
  30. # Reason: Prefer Hashes without extreme indentation
  31. # https://docs.rubocop.org/rubocop/cops_layout.html#layoutfirsthashelementindentation
  32. Layout/FirstHashElementIndentation:
  33. EnforcedStyle: consistent
  34. # Reason: Currently disabled in .rubocop_todo.yml
  35. # https://docs.rubocop.org/rubocop/cops_layout.html#layoutlinelength
  36. Layout/LineLength:
  37. Max: 320 # Default of 120 causes a duplicate entry in generated todo file
  38. # Reason:
  39. # https://docs.rubocop.org/rubocop/cops_lint.html#lintuselessaccessmodifier
  40. Lint/UselessAccessModifier:
  41. ContextCreatingMethods:
  42. - class_methods
  43. ## Disable most Metrics/*Length cops
  44. # Reason: those are often triggered and force significant refactors when this happend
  45. # but the team feel they are not really improving the code quality.
  46. # https://docs.rubocop.org/rubocop/cops_metrics.html#metricsblocklength
  47. Metrics/BlockLength:
  48. Enabled: false
  49. # https://docs.rubocop.org/rubocop/cops_metrics.html#metricsclasslength
  50. Metrics/ClassLength:
  51. Enabled: false
  52. # https://docs.rubocop.org/rubocop/cops_metrics.html#metricsmethodlength
  53. Metrics/MethodLength:
  54. Enabled: false
  55. # https://docs.rubocop.org/rubocop/cops_metrics.html#metricsmodulelength
  56. Metrics/ModuleLength:
  57. Enabled: false
  58. ## End Disable Metrics/*Length cops
  59. # Reason: Currently disabled in .rubocop_todo.yml
  60. # https://docs.rubocop.org/rubocop/cops_metrics.html#metricsabcsize
  61. Metrics/AbcSize:
  62. Exclude:
  63. - 'lib/mastodon/cli/*.rb'
  64. - db/*migrate/**/*
  65. # Reason: Currently disabled in .rubocop_todo.yml
  66. # https://docs.rubocop.org/rubocop/cops_metrics.html#metricscyclomaticcomplexity
  67. Metrics/CyclomaticComplexity:
  68. Exclude:
  69. - lib/mastodon/cli/*.rb
  70. - db/*migrate/**/*
  71. # Reason:
  72. # https://docs.rubocop.org/rubocop/cops_metrics.html#metricsparameterlists
  73. Metrics/ParameterLists:
  74. CountKeywordArgs: false
  75. # Reason: Prevailing style is argument file paths
  76. # https://docs.rubocop.org/rubocop-rails/cops_rails.html#railsfilepath
  77. Rails/FilePath:
  78. EnforcedStyle: arguments
  79. # Reason: Prevailing style uses numeric status codes, matches RSpec/Rails/HttpStatus
  80. # https://docs.rubocop.org/rubocop-rails/cops_rails.html#railshttpstatus
  81. Rails/HttpStatus:
  82. EnforcedStyle: numeric
  83. # Reason: Allowed in `tootctl` CLI code and in boot ENV checker
  84. # https://docs.rubocop.org/rubocop-rails/cops_rails.html#railsexit
  85. Rails/Exit:
  86. Exclude:
  87. - 'config/boot.rb'
  88. - 'lib/mastodon/cli/*.rb'
  89. Rails/SkipsModelValidations:
  90. Exclude:
  91. - 'db/*migrate/**/*'
  92. # Reason: We want to preserve the ability to migrate from arbitrary old versions,
  93. # and cannot guarantee that every installation has run every migration as they upgrade.
  94. # https://docs.rubocop.org/rubocop-rails/cops_rails.html#railsunusedignoredcolumns
  95. Rails/UnusedIgnoredColumns:
  96. Enabled: false
  97. # Reason: Some single letter camel case files shouldn't be split
  98. # https://docs.rubocop.org/rubocop-rspec/cops_rspec.html#rspecfilepath
  99. RSpec/FilePath:
  100. CustomTransform:
  101. ActivityPub: activitypub
  102. DeepL: deepl
  103. FetchOEmbedService: fetch_oembed_service
  104. OEmbedController: oembed_controller
  105. OStatus: ostatus
  106. # Reason:
  107. # https://docs.rubocop.org/rubocop-rspec/cops_rspec.html#rspecnamedsubject
  108. RSpec/NamedSubject:
  109. EnforcedStyle: named_only
  110. # Reason: Prevailing style choice
  111. # https://docs.rubocop.org/rubocop-rspec/cops_rspec.html#rspecnottonot
  112. RSpec/NotToNot:
  113. EnforcedStyle: to_not
  114. # Reason: Prevailing style uses numeric status codes, matches Rails/HttpStatus
  115. # https://docs.rubocop.org/rubocop-rspec/cops_rspec_rails.html#rspecrailshttpstatus
  116. RSpec/Rails/HttpStatus:
  117. EnforcedStyle: numeric
  118. # Reason: Match overrides from Rspec/FilePath rule above
  119. # https://docs.rubocop.org/rubocop-rspec/cops_rspec.html#rspecspecfilepathformat
  120. RSpec/SpecFilePathFormat:
  121. CustomTransform:
  122. ActivityPub: activitypub
  123. DeepL: deepl
  124. FetchOEmbedService: fetch_oembed_service
  125. OEmbedController: oembed_controller
  126. OStatus: ostatus
  127. # Reason:
  128. # https://docs.rubocop.org/rubocop/cops_style.html#styleclassandmodulechildren
  129. Style/ClassAndModuleChildren:
  130. Enabled: false
  131. # Reason: Classes mostly self-document with their names
  132. # https://docs.rubocop.org/rubocop/cops_style.html#styledocumentation
  133. Style/Documentation:
  134. Enabled: false
  135. # Reason: Enforce modern Ruby style
  136. # https://docs.rubocop.org/rubocop/cops_style.html#stylehashsyntax
  137. Style/HashSyntax:
  138. EnforcedStyle: ruby19_no_mixed_keys
  139. # Reason:
  140. # https://docs.rubocop.org/rubocop/cops_style.html#stylenumericliterals
  141. Style/NumericLiterals:
  142. AllowedPatterns:
  143. - \d{4}_\d{2}_\d{2}_\d{6} # For DB migration date version number readability
  144. # Reason:
  145. # https://docs.rubocop.org/rubocop/cops_style.html#stylepercentliteraldelimiters
  146. Style/PercentLiteralDelimiters:
  147. PreferredDelimiters:
  148. '%i': '()'
  149. '%w': '()'
  150. # Reason: Prefer less indentation in conditional assignments
  151. # https://docs.rubocop.org/rubocop/cops_style.html#styleredundantbegin
  152. Style/RedundantBegin:
  153. Enabled: false
  154. # Reason: Overridden to reduce implicit StandardError rescues
  155. # https://docs.rubocop.org/rubocop/cops_style.html#stylerescuestandarderror
  156. Style/RescueStandardError:
  157. EnforcedStyle: implicit
  158. # Reason: Simplify some spec layouts
  159. # https://docs.rubocop.org/rubocop/cops_style.html#stylesemicolon
  160. Style/Semicolon:
  161. AllowAsExpressionSeparator: true
  162. # Reason: Originally disabled for CodeClimate, and no config consensus has been found
  163. # https://docs.rubocop.org/rubocop/cops_style.html#stylesymbolarray
  164. Style/SymbolArray:
  165. Enabled: false
  166. # Reason:
  167. # https://docs.rubocop.org/rubocop/cops_style.html#styletrailingcommainarrayliteral
  168. Style/TrailingCommaInArrayLiteral:
  169. EnforcedStyleForMultiline: 'comma'
  170. # Reason:
  171. # https://docs.rubocop.org/rubocop/cops_style.html#styletrailingcommainhashliteral
  172. Style/TrailingCommaInHashLiteral:
  173. EnforcedStyleForMultiline: 'comma'
  174. Style/MiddleDot:
  175. Enabled: true