shards/.ameba.yml at master · crystal-lang/shards · GitHub

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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# This configuration file was generated by `ameba --gen-config`
# on 2025-06-02 13:57:07 UTC using Ameba version 1.7.0-dev.
# The point is for the user to remove these configuration records
# one by one as the reported problems are removed from the code base.
#
# For more details on any individual rule, run `ameba --only RuleName`.

# Indicators for comment annotations:
#
# * `Disabled`: The rule is disabled because it does not seem useful for this repo (or in general).
# * `BUG`: A bug in ameba prevents using this rule either entirely or for specific files.
# * `FIXME`: The rule seems useful, but requires some effort to resolve. That's deferred for later.
# * `TODO`: The rule might be useful, but we need to investigate whether we want to use it or not.

Version: "1.7.0-dev"

Excluded:
  # BUG: Workaround for https://github.com/crystal-ameba/ameba/issues/782, https://github.com/crystal-ameba/ameba/issues/786, and https://github.com/crystal-ameba/ameba/issues/781
  - spec/support/factories.cr

# Documentation
# =========================

# Disabled: What's the point in alerting about existing TODOs in code?
Documentation/DocumentationAdmonition:
  Enabled: false

# Lint
# =========================

# Disabled: `else nil` can be useful to explicitly show the consequence of the else branch
Lint/ElseNil:
  Enabled: false

# Disabled: We have an explicit CI job for testing the formatter (both latest
# and head). No reason to run it through ameba.
Lint/Formatting:
  Enabled: false

# TODO: Investigate if some `not_nil!` calls can be avoided.
Lint/NotNil:
  Enabled: false

# FIXME: Resolve shadowing.
Lint/ShadowingOuterLocalVar:
  Enabled: false

# BUG: https://github.com/crystal-ameba/ameba/issues/612
Lint/TopLevelOperatorDefinition:
  Enabled: false

# Disabled: We have an explicit CI job for `typos`. No reason to run it through
# ameba.
Lint/Typos:
  Enabled: false

# TODO: Investigate unused arguments.
Lint/UnusedArgument:
  Enabled: false

# TODO: Investigate unused block arguments.
Lint/UnusedBlockArgument:
  Enabled: false

Lint/UselessAssign:
  # BUG: https://github.com/crystal-ameba/ameba/issues/447
  # This setting is to avoid false positives from the common use of type
  # declarations in macro arguments.
  ExcludeTypeDeclarations: true

# Metrics
# =========================

# Disabled: Lot's of violations. Complexity is very individual.
Metrics/CyclomaticComplexity:
  Enabled: false

# Naming
# =========================
# All disabled. There are many violations and some of the rules are questionable.
# TODO: Consider enabling some of these rules.

Naming/AccessorMethodName:
  Enabled: false

Naming/BinaryOperatorParameterName:
  Enabled: false

Naming/BlockParameterName:
  Enabled: false

# Disabled: All violations follow the spelling of identifiers in upstream
# projects, e.g. for lib bindings.
Naming/ConstantNames:
  Enabled: false

Naming/MethodNames:
  Enabled: false

Naming/PredicateName:
  Enabled: false

Naming/QueryBoolMethods:
  Enabled: false

Naming/RescuedExceptionsVariableName:
  Enabled: false

Naming/TypeNames:
  Enabled: false

Naming/VariableNames:
  Enabled: false

# Style
# =========================
# All disabled. There are many violations and some of the rules are questionable.
# TODO: Consider enabling some of these rules.

Style/HeredocEscape:
  Enabled: false

Style/HeredocIndent:
  Enabled: false

Style/MultilineCurlyBlock:
  Enabled: false

# Disabled: This rule seems too strict when any negation inside a complex condition is
# considered a violation. https://github.com/crystal-ameba/ameba/issues/621
Style/NegatedConditionsInUnless:
  Enabled: false

# BUG: https://github.com/crystal-ameba/ameba/issues/614
Style/ParenthesesAroundCondition:
  Enabled: false

Style/PercentLiteralDelimiters:
  Enabled: false

Style/RedundantNext:
  Enabled: false

Style/RedundantReturn:
  Enabled: false

Style/RedundantSelf:
  Enabled: false

Style/VerboseBlock:
  Enabled: false

Style/WhileTrue:
  Enabled: false