aboutsummaryrefslogtreecommitdiff
path: root/.rubocop.yml
blob: ace564df583e251b9d79de2f30304824be1fa8f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
AllCops:
  TargetRubyVersion: 3.2
  TargetRailsVersion: 7.1

  DisplayCopNames: true
  DisplayStyleGuide: false
  SuggestExtensions: false

  NewCops: enable

  Exclude:
    # Files that are out of our control and that are not excluded in the
    # default config of rubocop.
    - bin/bundle
    - db/schema.rb
    - db/migrate/*
    - db/seeds.rb
    - vendor/**/*

##
# Plugins

plugins:
  - rubocop-rails
  - rubocop-performance
  - rubocop-minitest

#
# Layout
#

# The table format is more human readable.
Layout/HashAlignment:
  EnforcedHashRocketStyle: table
  EnforcedColonStyle: table

# The default is just too small. A limit of 100 looks reasonable.
Layout/LineLength:
  Max: 100

#
# Metrics
#

# The default is just too small.
Metrics/AbcSize:
  Max: 30

# We will skip it for tests.
Metrics/ClassLength:
  Max: 200
  Exclude:
    - test/**/*

# Default is just too low.
Metrics/CyclomaticComplexity:
  Max: 10

# Default is just too low.
Metrics/PerceivedComplexity:
  Max: 10

# We will skip it for Rake tasks.
Metrics/BlockLength:
  Exclude:
    - config/**/*
    - lib/tasks/**/*
    - test/**/*

# The default is just too small.
Metrics/MethodLength:
  Max: 20

#
# Style
#

# It's not needed to add documentation for obvious modules or classes. The main
# idea is that documentation will be asked during the review process if needed.
Style/Documentation:
  Enabled: false

# This forces us to create a new object for no real reason.
Style/MultipleComparison:
  Enabled: false

# There are some false positives (e.g. "module ::Module", in which we want to
# make sure there are no clashes or misunderstandings). Therefore, we just
# disable this cop.
Style/ClassAndModuleChildren:
  Enabled: false

# I do need to write non-ASCII words from time to time since, you know, this is
# a language application and latin words can have macrons.
Style/AsciiComments:
  Enabled: false

#
# Naming
#

# The default minimum length is 3, which is too long for good names like
# "js". Variables with only one letter are usually disallowed, but there are
# some names which are easy to understand (e.g. convention).
Naming/MethodParameterName:
  MinNameLength: 2
  AllowedNames: [_, n]

#
# Minitest
#

Minitest/MultipleAssertions:
  Max: 5