mirror of
https://github.com/openfoodfoundation/openfoodnetwork
synced 2026-01-11 18:26:50 +00:00
4c6d894bc0
There were a few changes needed: * Plugins are now specified through `plugin:` config keyword. * All plugin gems need to be specified explicitly in Gemfile since they are no longer dependencies of plugins already specified explicitly. * All plugin gems need to be updated in other to use the new APIs. * One cop was renamed. * New offenses safe to correct were corrected directly with `bundle exec rubocop -a`. * New offenses unsafe to correct were added to the TODO configuration with `bundle exec rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 1400 --no-auto-gen-timestamp`.
168 lines
3.4 KiB
YAML
168 lines
3.4 KiB
YAML
# Our Open Food Network style guide.
|
|
#
|
|
# These are the rules we agreed upon and we work towards.
|
|
AllCops:
|
|
NewCops: enable
|
|
MigratedSchemaVersion: "20250111000000"
|
|
Exclude:
|
|
- bin/**/*
|
|
- config/**/*
|
|
- db/bad_migrations/*
|
|
- db/migrate/201*
|
|
- db/migrate/202[0-4]*
|
|
- db/schema.rb
|
|
- script/**/*
|
|
- vendor/**/*
|
|
- node_modules/**/*
|
|
# Excluding: inadequate Naming/FileName rule rejects GemFile name with camelcase
|
|
- engines/web/Gemfile
|
|
- .undercover
|
|
|
|
Bundler/DuplicatedGem:
|
|
Enabled: false
|
|
|
|
Layout/LineLength:
|
|
Enabled: true
|
|
Max: 100
|
|
|
|
Layout/MultilineMethodCallIndentation:
|
|
Enabled: true
|
|
EnforcedStyle: indented
|
|
|
|
# Don't think this is a big issue, mostly picking up RPSEC scope definitions
|
|
# with lamdas and RSpec '.to change{}' blocks
|
|
Lint/AmbiguousBlockAssociation:
|
|
Enabled: false
|
|
|
|
Lint/MissingSuper:
|
|
Exclude:
|
|
- app/components/**/*
|
|
|
|
Lint/RaiseException:
|
|
Enabled: true
|
|
|
|
Lint/StructNewOverride:
|
|
Enabled: true
|
|
|
|
# Heaps of offences (> 100) in specs, mostly in situations where two or more
|
|
# instances of a model are required, but only one is referenced. Difficult to
|
|
# fix without making the spec look messy or rewriting it.
|
|
# Should definitely fix at some point.
|
|
Lint/UselessAssignment:
|
|
Exclude:
|
|
- spec/**/*
|
|
|
|
Metrics:
|
|
Enabled: true
|
|
|
|
Metrics/AbcSize:
|
|
Max: 30 # default 17
|
|
|
|
Metrics/BlockLength:
|
|
AllowedMethods: [
|
|
"class_eval",
|
|
"collection",
|
|
"configure",
|
|
"context",
|
|
"delete",
|
|
"describe",
|
|
"feature",
|
|
"get",
|
|
"it",
|
|
"member",
|
|
"namespace",
|
|
"path",
|
|
"post",
|
|
"put",
|
|
"resource",
|
|
"resources",
|
|
"response",
|
|
"scenario",
|
|
"shared_examples",
|
|
"shared_examples_for",
|
|
"xdescribe",
|
|
]
|
|
|
|
Metrics/MethodLength:
|
|
Enabled: true
|
|
Max: 25 # default 10
|
|
|
|
Metrics/ParameterLists:
|
|
CountKeywordArgs: false
|
|
|
|
Metrics/PerceivedComplexity:
|
|
Enabled: true
|
|
Max: 14 # default 8
|
|
|
|
Naming/PredicatePrefix:
|
|
Enabled: false
|
|
|
|
Naming/VariableNumber:
|
|
AllowedIdentifiers:
|
|
- street_address_1
|
|
- street_address_2
|
|
AllowedPatterns:
|
|
- _v[\d]+
|
|
# Cf. conversation https://github.com/openfoodfoundation/openfoodnetwork/pull/13306#pullrequestreview-2831644286
|
|
- menu_[\d]
|
|
|
|
Rails/ApplicationRecord:
|
|
Exclude:
|
|
# Migrations should not contain application code:
|
|
- db/migrate/*.rb
|
|
|
|
# Allow many-to-many associations without explicit model.
|
|
# - It avoids the additional code of a model class.
|
|
# - It simplifies the declaration of the association.
|
|
# - Rails may know that there are no callbacks associated.
|
|
Rails/HasAndBelongsToMany:
|
|
Enabled: false
|
|
|
|
# Cf. conversation https://github.com/openfoodfoundation/openfoodnetwork/pull/13251
|
|
Rails/LexicallyScopedActionFilter:
|
|
Enabled: false
|
|
|
|
Rails/OutputSafety:
|
|
Exclude:
|
|
- spec/**/*
|
|
|
|
Rails/RedundantActiveRecordAllMethod:
|
|
AllowedReceivers:
|
|
- ActionMailer::Preview
|
|
- ActiveSupport::TimeZone
|
|
|
|
Rails/SkipsModelValidations:
|
|
AllowedMethods:
|
|
- touch
|
|
- touch_all
|
|
- update_all
|
|
- update_attribute
|
|
- update_column
|
|
- update_columns
|
|
|
|
Rails/UnknownEnv:
|
|
Environments:
|
|
- development
|
|
- production
|
|
- staging
|
|
- test
|
|
|
|
Rails/WhereExists:
|
|
EnforcedStyle: where # Cf. conversion https://github.com/openfoodfoundation/openfoodnetwork/pull/12363
|
|
|
|
Style/Documentation:
|
|
Enabled: false
|
|
|
|
Style/FormatStringToken:
|
|
Enabled: false
|
|
|
|
Style/HashSyntax:
|
|
Enabled: true
|
|
EnforcedStyle: ruby19_no_mixed_keys
|
|
|
|
Style/Send:
|
|
Enabled: true
|
|
|
|
Style/StringLiterals:
|
|
Enabled: false
|