2023-03-31 10:08:53 -04:00
|
|
|
# Can be removed once all rules are addressed or moved to this file as documented overrides
|
2023-02-16 01:33:50 -05:00
|
|
|
inherit_from: .rubocop_todo.yml
|
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Used for merging with exclude lists with .rubocop_todo.yml
|
2023-02-16 01:33:50 -05:00
|
|
|
inherit_mode:
|
|
|
|
merge:
|
|
|
|
- Exclude
|
|
|
|
|
2019-06-06 06:31:48 -04:00
|
|
|
require:
|
|
|
|
- rubocop-rails
|
linting: RuboCop update, config fixes (#20574)
* fix(rubocop): update gems and add performance and rspec
fix(rubocop): update gems and add performance and rspec
- update present rubocop gems
- add rubocop-rspec and rubocop-performance gems
- move rubocop gems to gem group :development, :test in order to
make linting in a github action that runs with RAILS_ENV=test possible
* feat(rubocop): disable some annoyance RSpec cops
To mee these prooved to be more annoying than helpful.
If not agreed, they can be enabled any time.
* fix(rubocop): do not ignore spec/**/*
Because rubocop-rspec should lint the specs as well, and they
deserve to be readable in general. It is relevant code, after all.
* fix(rubocop): change ignore db/**/* to db/schema.rb
because rails cops do some lints for migrations.
E.g. reversable migrations linting and more.
* fix(rubocop): tune rules configs
Bunch of commits squashed:
fix(rubocop): enable Layout/LineLength cop
Because this project has code with line lenghts > 500 chars.
This is not good practice at all, so I strongly suggest to
change the practice in the future.
But allow heredoc, URI and comments to still be long lines
and make the default Max: 120 explicit, by repeating it in the
config. To me this max length seems reasonable. Perhaps
a bit more could be ok for some. But > 500 chars in one line
Seems to be way too long IMHO.
fix(rubocop): Metrics/CyclomaticComplexity Max to 12
The default is 7, perhaps quite strict. But 25 is too loose,
the rule becomes pointless like that.
fix(rubocop): AllCops ruby version, cacheing and more info
- fix the target ruby version from 2.5 to 3.0
- have the cop error messages to be more informative and helpful
- enable cacheing in /tmp
fix(rubocop): Metrics/AbcSize to 34 from 115
Rubocops default is 17. If the rule is at 115 is becomes
pointless.
fix(rubocop): Metrics/BlockLength improvements
- instead of ignoring tasks completely, ignore only the
long blocks that are specific to tasks (task, namespace)
- ignore also concern specific block methods (included, class_methods)
fix(rubocop): Metrics/ClassLength count heredoc array as one line
fix(rubocop): Metrics/MethodLength Max to 25
- the default is 10, but 65 is too loose, so perhaps 25?
fix(rubocop): Metrics/ModuleLength array and heredoc count as one
fix(rubocop): Metrics/PerceivedComplexity to 16 from 25
Rubocops default is 8, so how about only doubling that, instead
of > than tripple it?
fix(rubocop): enable Style/RedundantAssignment
Because I think that this rule would never really hurt,
but improve code quality and readability.
fix(rubocop): enable Style/RescueStandardError
I think everyone that ever had to debug what this can bring
will hopefully agree that this rule totally makes sense.
In the super rare exeptions where this is totally needed,
it can be excluded by disabling comment in that place.
fix(rubocop): Metrics/ParameterLists add explicit defaults and some excludes
2022-12-15 10:39:59 -05:00
|
|
|
- rubocop-rspec
|
|
|
|
- rubocop-performance
|
2023-03-17 05:13:28 -04:00
|
|
|
- rubocop-capybara
|
2023-06-02 13:58:18 -04:00
|
|
|
- ./lib/linter/rubocop_middle_dot
|
2019-06-06 06:31:48 -04:00
|
|
|
|
2017-06-01 11:24:30 -04:00
|
|
|
AllCops:
|
2023-04-26 19:46:18 -04:00
|
|
|
TargetRubyVersion: 3.0 # Set to minimum supported version of CI
|
linting: RuboCop update, config fixes (#20574)
* fix(rubocop): update gems and add performance and rspec
fix(rubocop): update gems and add performance and rspec
- update present rubocop gems
- add rubocop-rspec and rubocop-performance gems
- move rubocop gems to gem group :development, :test in order to
make linting in a github action that runs with RAILS_ENV=test possible
* feat(rubocop): disable some annoyance RSpec cops
To mee these prooved to be more annoying than helpful.
If not agreed, they can be enabled any time.
* fix(rubocop): do not ignore spec/**/*
Because rubocop-rspec should lint the specs as well, and they
deserve to be readable in general. It is relevant code, after all.
* fix(rubocop): change ignore db/**/* to db/schema.rb
because rails cops do some lints for migrations.
E.g. reversable migrations linting and more.
* fix(rubocop): tune rules configs
Bunch of commits squashed:
fix(rubocop): enable Layout/LineLength cop
Because this project has code with line lenghts > 500 chars.
This is not good practice at all, so I strongly suggest to
change the practice in the future.
But allow heredoc, URI and comments to still be long lines
and make the default Max: 120 explicit, by repeating it in the
config. To me this max length seems reasonable. Perhaps
a bit more could be ok for some. But > 500 chars in one line
Seems to be way too long IMHO.
fix(rubocop): Metrics/CyclomaticComplexity Max to 12
The default is 7, perhaps quite strict. But 25 is too loose,
the rule becomes pointless like that.
fix(rubocop): AllCops ruby version, cacheing and more info
- fix the target ruby version from 2.5 to 3.0
- have the cop error messages to be more informative and helpful
- enable cacheing in /tmp
fix(rubocop): Metrics/AbcSize to 34 from 115
Rubocops default is 17. If the rule is at 115 is becomes
pointless.
fix(rubocop): Metrics/BlockLength improvements
- instead of ignoring tasks completely, ignore only the
long blocks that are specific to tasks (task, namespace)
- ignore also concern specific block methods (included, class_methods)
fix(rubocop): Metrics/ClassLength count heredoc array as one line
fix(rubocop): Metrics/MethodLength Max to 25
- the default is 10, but 65 is too loose, so perhaps 25?
fix(rubocop): Metrics/ModuleLength array and heredoc count as one
fix(rubocop): Metrics/PerceivedComplexity to 16 from 25
Rubocops default is 8, so how about only doubling that, instead
of > than tripple it?
fix(rubocop): enable Style/RedundantAssignment
Because I think that this rule would never really hurt,
but improve code quality and readability.
fix(rubocop): enable Style/RescueStandardError
I think everyone that ever had to debug what this can bring
will hopefully agree that this rule totally makes sense.
In the super rare exeptions where this is totally needed,
it can be excluded by disabling comment in that place.
fix(rubocop): Metrics/ParameterLists add explicit defaults and some excludes
2022-12-15 10:39:59 -05:00
|
|
|
DisplayCopNames: true
|
|
|
|
DisplayStyleGuide: true
|
|
|
|
ExtraDetails: true
|
|
|
|
UseCache: true
|
|
|
|
CacheRootDirectory: tmp
|
2023-03-31 10:08:53 -04:00
|
|
|
NewCops: enable # Opt-in to newly added rules
|
2017-06-01 11:24:30 -04:00
|
|
|
Exclude:
|
linting: RuboCop update, config fixes (#20574)
* fix(rubocop): update gems and add performance and rspec
fix(rubocop): update gems and add performance and rspec
- update present rubocop gems
- add rubocop-rspec and rubocop-performance gems
- move rubocop gems to gem group :development, :test in order to
make linting in a github action that runs with RAILS_ENV=test possible
* feat(rubocop): disable some annoyance RSpec cops
To mee these prooved to be more annoying than helpful.
If not agreed, they can be enabled any time.
* fix(rubocop): do not ignore spec/**/*
Because rubocop-rspec should lint the specs as well, and they
deserve to be readable in general. It is relevant code, after all.
* fix(rubocop): change ignore db/**/* to db/schema.rb
because rails cops do some lints for migrations.
E.g. reversable migrations linting and more.
* fix(rubocop): tune rules configs
Bunch of commits squashed:
fix(rubocop): enable Layout/LineLength cop
Because this project has code with line lenghts > 500 chars.
This is not good practice at all, so I strongly suggest to
change the practice in the future.
But allow heredoc, URI and comments to still be long lines
and make the default Max: 120 explicit, by repeating it in the
config. To me this max length seems reasonable. Perhaps
a bit more could be ok for some. But > 500 chars in one line
Seems to be way too long IMHO.
fix(rubocop): Metrics/CyclomaticComplexity Max to 12
The default is 7, perhaps quite strict. But 25 is too loose,
the rule becomes pointless like that.
fix(rubocop): AllCops ruby version, cacheing and more info
- fix the target ruby version from 2.5 to 3.0
- have the cop error messages to be more informative and helpful
- enable cacheing in /tmp
fix(rubocop): Metrics/AbcSize to 34 from 115
Rubocops default is 17. If the rule is at 115 is becomes
pointless.
fix(rubocop): Metrics/BlockLength improvements
- instead of ignoring tasks completely, ignore only the
long blocks that are specific to tasks (task, namespace)
- ignore also concern specific block methods (included, class_methods)
fix(rubocop): Metrics/ClassLength count heredoc array as one line
fix(rubocop): Metrics/MethodLength Max to 25
- the default is 10, but 65 is too loose, so perhaps 25?
fix(rubocop): Metrics/ModuleLength array and heredoc count as one
fix(rubocop): Metrics/PerceivedComplexity to 16 from 25
Rubocops default is 8, so how about only doubling that, instead
of > than tripple it?
fix(rubocop): enable Style/RedundantAssignment
Because I think that this rule would never really hurt,
but improve code quality and readability.
fix(rubocop): enable Style/RescueStandardError
I think everyone that ever had to debug what this can bring
will hopefully agree that this rule totally makes sense.
In the super rare exeptions where this is totally needed,
it can be excluded by disabling comment in that place.
fix(rubocop): Metrics/ParameterLists add explicit defaults and some excludes
2022-12-15 10:39:59 -05:00
|
|
|
- db/schema.rb
|
2022-03-20 23:46:11 -04:00
|
|
|
- 'bin/*'
|
|
|
|
- 'node_modules/**/*'
|
|
|
|
- 'Vagrantfile'
|
|
|
|
- 'vendor/**/*'
|
2023-10-31 11:21:23 -04:00
|
|
|
- 'config/initializers/json_ld*' # Generated files
|
2023-10-03 08:58:40 -04:00
|
|
|
- 'lib/mastodon/migration_helpers.rb' # Vendored from GitLab
|
2022-03-20 23:46:11 -04:00
|
|
|
- 'lib/templates/**/*'
|
2016-09-29 15:28:21 -04:00
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason: Prefer Hashes without extreme indentation
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutfirsthashelementindentation
|
2022-02-24 18:34:14 -05:00
|
|
|
Layout/FirstHashElementIndentation:
|
|
|
|
EnforcedStyle: consistent
|
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason: Currently disabled in .rubocop_todo.yml
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_layout.html#layoutlinelength
|
2023-02-16 01:33:50 -05:00
|
|
|
Layout/LineLength:
|
2023-07-28 17:11:45 -04:00
|
|
|
Max: 320 # Default of 120 causes a duplicate entry in generated todo file
|
2020-08-31 21:04:00 -04:00
|
|
|
|
2023-05-31 17:33:10 -04:00
|
|
|
## Disable most Metrics/*Length cops
|
|
|
|
# Reason: those are often triggered and force significant refactors when this happend
|
|
|
|
# but the team feel they are not really improving the code quality.
|
|
|
|
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsblocklength
|
|
|
|
Metrics/BlockLength:
|
|
|
|
Enabled: false
|
|
|
|
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsclasslength
|
|
|
|
Metrics/ClassLength:
|
|
|
|
Enabled: false
|
|
|
|
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsmethodlength
|
|
|
|
Metrics/MethodLength:
|
|
|
|
Enabled: false
|
|
|
|
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsmodulelength
|
|
|
|
Metrics/ModuleLength:
|
|
|
|
Enabled: false
|
|
|
|
|
|
|
|
## End Disable Metrics/*Length cops
|
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason: Currently disabled in .rubocop_todo.yml
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsabcsize
|
2016-11-15 10:56:29 -05:00
|
|
|
Metrics/AbcSize:
|
2020-08-31 21:04:00 -04:00
|
|
|
Exclude:
|
2023-05-23 10:08:26 -04:00
|
|
|
- 'lib/mastodon/cli/*.rb'
|
2016-10-22 13:38:47 -04:00
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason: Currently disabled in .rubocop_todo.yml
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_metrics.html#metricscyclomaticcomplexity
|
2016-11-15 10:56:29 -05:00
|
|
|
Metrics/CyclomaticComplexity:
|
2020-08-31 21:04:00 -04:00
|
|
|
Exclude:
|
2023-05-23 10:08:26 -04:00
|
|
|
- lib/mastodon/cli/*.rb
|
2017-06-01 11:24:30 -04:00
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason:
|
2023-05-31 17:33:10 -04:00
|
|
|
# https://docs.rubocop.org/rubocop/cops_metrics.html#metricsparameterlists
|
|
|
|
Metrics/ParameterLists:
|
|
|
|
CountKeywordArgs: false
|
2016-11-15 10:56:29 -05:00
|
|
|
|
2023-05-03 23:50:40 -04:00
|
|
|
# Reason: Prevailing style is argument file paths
|
|
|
|
# https://docs.rubocop.org/rubocop-rails/cops_rails.html#railsfilepath
|
|
|
|
Rails/FilePath:
|
|
|
|
EnforcedStyle: arguments
|
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason: Prevailing style uses numeric status codes, matches RSpec/Rails/HttpStatus
|
|
|
|
# https://docs.rubocop.org/rubocop-rails/cops_rails.html#railshttpstatus
|
2023-02-19 21:16:40 -05:00
|
|
|
Rails/HttpStatus:
|
|
|
|
EnforcedStyle: numeric
|
|
|
|
|
2024-01-12 08:10:14 -05:00
|
|
|
# Reason: Conflicts with `Lint/UselessMethodDefinition` for inherited controller actions
|
|
|
|
# https://docs.rubocop.org/rubocop-rails/cops_rails.html#railslexicallyscopedactionfilter
|
|
|
|
Rails/LexicallyScopedActionFilter:
|
|
|
|
Exclude:
|
|
|
|
- 'app/controllers/auth/*'
|
|
|
|
|
2024-01-17 11:33:17 -05:00
|
|
|
# Reason: These tasks are doing local work which do not need full env loaded
|
|
|
|
# https://docs.rubocop.org/rubocop-rails/cops_rails.html#railsrakeenvironment
|
|
|
|
Rails/RakeEnvironment:
|
|
|
|
Exclude:
|
|
|
|
- 'lib/tasks/auto_annotate_models.rake'
|
|
|
|
- 'lib/tasks/emojis.rake'
|
|
|
|
- 'lib/tasks/mastodon.rake'
|
|
|
|
- 'lib/tasks/repo.rake'
|
|
|
|
- 'lib/tasks/statistics.rake'
|
|
|
|
|
2024-01-15 08:46:47 -05:00
|
|
|
# Reason: There are appropriate times to use these features
|
|
|
|
# https://docs.rubocop.org/rubocop-rails/cops_rails.html#railsskipsmodelvalidations
|
2023-12-15 09:38:12 -05:00
|
|
|
Rails/SkipsModelValidations:
|
2024-01-15 08:46:47 -05:00
|
|
|
Enabled: false
|
2023-12-15 09:38:12 -05:00
|
|
|
|
2023-12-18 04:58:53 -05:00
|
|
|
# Reason: We want to preserve the ability to migrate from arbitrary old versions,
|
|
|
|
# and cannot guarantee that every installation has run every migration as they upgrade.
|
|
|
|
# https://docs.rubocop.org/rubocop-rails/cops_rails.html#railsunusedignoredcolumns
|
|
|
|
Rails/UnusedIgnoredColumns:
|
|
|
|
Enabled: false
|
|
|
|
|
2023-12-18 07:21:45 -05:00
|
|
|
# Reason: Prevailing style choice
|
|
|
|
# https://docs.rubocop.org/rubocop-rails/cops_rails.html#railsnegateinclude
|
|
|
|
Rails/NegateInclude:
|
|
|
|
Enabled: false
|
|
|
|
|
2024-02-07 09:54:40 -05:00
|
|
|
# Reason: Enforce default limit, but allow some elements to span lines
|
|
|
|
# https://docs.rubocop.org/rubocop-rspec/cops_rspec.html#rspecexamplelength
|
|
|
|
RSpec/ExampleLength:
|
|
|
|
CountAsOne: ['array', 'heredoc', 'method_call']
|
|
|
|
|
2024-01-05 07:31:18 -05:00
|
|
|
# Reason: Deprecated cop, will be removed in 3.0, replaced by SpecFilePathFormat
|
2023-03-10 10:32:37 -05:00
|
|
|
# https://docs.rubocop.org/rubocop-rspec/cops_rspec.html#rspecfilepath
|
2023-03-03 15:06:31 -05:00
|
|
|
RSpec/FilePath:
|
2024-01-05 07:31:18 -05:00
|
|
|
Enabled: false
|
2023-03-03 15:06:31 -05:00
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason:
|
|
|
|
# https://docs.rubocop.org/rubocop-rspec/cops_rspec.html#rspecnamedsubject
|
|
|
|
RSpec/NamedSubject:
|
|
|
|
EnforcedStyle: named_only
|
|
|
|
|
|
|
|
# Reason: Prevailing style choice
|
|
|
|
# https://docs.rubocop.org/rubocop-rspec/cops_rspec.html#rspecnottonot
|
2023-02-19 20:33:27 -05:00
|
|
|
RSpec/NotToNot:
|
|
|
|
EnforcedStyle: to_not
|
|
|
|
|
2023-11-06 11:25:40 -05:00
|
|
|
# Reason: Match overrides from Rspec/FilePath rule above
|
|
|
|
# https://docs.rubocop.org/rubocop-rspec/cops_rspec.html#rspecspecfilepathformat
|
|
|
|
RSpec/SpecFilePathFormat:
|
|
|
|
CustomTransform:
|
|
|
|
ActivityPub: activitypub
|
|
|
|
DeepL: deepl
|
|
|
|
FetchOEmbedService: fetch_oembed_service
|
|
|
|
OEmbedController: oembed_controller
|
|
|
|
OStatus: ostatus
|
|
|
|
|
2024-04-02 05:34:44 -04:00
|
|
|
# Reason: Prevailing style uses numeric status codes, matches Rails/HttpStatus
|
|
|
|
# https://docs.rubocop.org/rubocop-rspec/cops_rspec_rails.html#rspecrailshttpstatus
|
|
|
|
RSpecRails/HttpStatus:
|
|
|
|
EnforcedStyle: numeric
|
|
|
|
|
2023-03-16 17:24:01 -04:00
|
|
|
# Reason:
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_style.html#styleclassandmodulechildren
|
|
|
|
Style/ClassAndModuleChildren:
|
|
|
|
Enabled: false
|
|
|
|
|
|
|
|
# Reason: Classes mostly self-document with their names
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_style.html#styledocumentation
|
|
|
|
Style/Documentation:
|
|
|
|
Enabled: false
|
|
|
|
|
2024-01-30 10:39:01 -05:00
|
|
|
# Reason: Route redirects are not token-formatted and must be skipped
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_style.html#styleformatstringtoken
|
|
|
|
Style/FormatStringToken:
|
|
|
|
inherit_mode:
|
|
|
|
merge:
|
|
|
|
- AllowedMethods # The rubocop-rails config adds `redirect`
|
|
|
|
AllowedMethods:
|
|
|
|
- redirect_with_vary
|
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason: Enforce modern Ruby style
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_style.html#stylehashsyntax
|
2022-11-17 05:05:39 -05:00
|
|
|
Style/HashSyntax:
|
|
|
|
EnforcedStyle: ruby19_no_mixed_keys
|
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason:
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_style.html#stylenumericliterals
|
2023-02-17 21:05:57 -05:00
|
|
|
Style/NumericLiterals:
|
|
|
|
AllowedPatterns:
|
|
|
|
- \d{4}_\d{2}_\d{2}_\d{6} # For DB migration date version number readability
|
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason:
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_style.html#stylepercentliteraldelimiters
|
2017-06-08 07:24:28 -04:00
|
|
|
Style/PercentLiteralDelimiters:
|
|
|
|
PreferredDelimiters:
|
|
|
|
'%i': '()'
|
|
|
|
'%w': '()'
|
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason: Prefer less indentation in conditional assignments
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_style.html#styleredundantbegin
|
|
|
|
Style/RedundantBegin:
|
|
|
|
Enabled: false
|
|
|
|
|
|
|
|
# Reason: Overridden to reduce implicit StandardError rescues
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_style.html#stylerescuestandarderror
|
2023-02-20 05:01:20 -05:00
|
|
|
Style/RescueStandardError:
|
|
|
|
EnforcedStyle: implicit
|
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason: Originally disabled for CodeClimate, and no config consensus has been found
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_style.html#stylesymbolarray
|
|
|
|
Style/SymbolArray:
|
|
|
|
Enabled: false
|
|
|
|
|
|
|
|
# Reason:
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_style.html#styletrailingcommainarrayliteral
|
2018-06-04 08:49:10 -04:00
|
|
|
Style/TrailingCommaInArrayLiteral:
|
|
|
|
EnforcedStyleForMultiline: 'comma'
|
|
|
|
|
2023-03-31 10:08:53 -04:00
|
|
|
# Reason:
|
|
|
|
# https://docs.rubocop.org/rubocop/cops_style.html#styletrailingcommainhashliteral
|
2018-06-04 08:49:10 -04:00
|
|
|
Style/TrailingCommaInHashLiteral:
|
2017-06-01 11:24:30 -04:00
|
|
|
EnforcedStyleForMultiline: 'comma'
|
2023-06-02 13:58:18 -04:00
|
|
|
|
|
|
|
Style/MiddleDot:
|
|
|
|
Enabled: true
|