Customize ameba configuration

Author: straight-shoota

.ameba.yml

@@ -1,105 +1,106 @@
 # This configuration file was generated by `ameba --gen-config`
-# on 2025-05-27 13:38:25 UTC using Ameba version 1.7.0-dev.
+# 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`.
 
 Version: "1.7.0-dev"
 
-Documentation/DocumentationAdmonition:
-  Enabled: false
+# Documentation
+# =========================
 
-Layout/TrailingBlankLines:
+# Disabled: What's the point in alerting about existing TODOs in code?
+Documentation/DocumentationAdmonition:
   Enabled: false
 
-Layout/TrailingWhitespace:
-  Enabled: false
+# Lint
+# =========================
 
 Lint/DebugCalls:
-  Enabled: false
+  Excluded:
+  # Samples may legitimately use DebugCalls
+  - samples/**/*
+  # Explicit tests
+  - spec/std/pp_spec.cr
 
 Lint/DebuggerStatement:
-  Enabled: false
+  Excluded:
+  # Explicit tests
+  - spec/debug/**/*
 
+# Disabled: `else nil` can be useful to explicitly show the consequence of the else branch
 Lint/ElseNil:
   Enabled: false
 
-Lint/EmptyLoop:
-  Enabled: false
-
-Lint/HashDuplicatedKey:
-  Enabled: false
-
 Lint/LiteralInCondition:
-  Enabled: false
+  Excluded:
+  # Samples may legitimately use literals in conditions
+  - samples/**/*
 
 Lint/LiteralInInterpolation:
-  Enabled: false
+  Excluded:
+  - spec/std/random_spec.cr # BUG: https://github.com/crystal-ameba/ameba/issues/611
 
 Lint/LiteralsComparison:
-  Enabled: false
+  Excluded:
+  # Explicit tests for case equality on tuple literals
+  - spec/std/tuple_spec.cr
 
+# TODO: Investigate if some `not_nil!` calls can be avoided.
 Lint/NotNil:
   Enabled: false
 
-Lint/NotNilAfterNoBang:
-  Enabled: false
-
 Lint/RandZero:
-  Enabled: false
-
-Lint/ShadowedArgument:
-  Enabled: false
+  Excluded:
+  # Explicit tests
+  - spec/std/random_spec.cr
 
+# FIXME: Resolve shadowing.
 Lint/ShadowingOuterLocalVar:
   Enabled: false
 
-Lint/SignalTrap:
-  Enabled: false
-
-Lint/SpecEqWithBoolOrNilLiteral:
-  Enabled: false
-
+# TODO: Investigate file names and move to data directories.
 Lint/SpecFilename:
   Enabled: false
 
+# BUG: https://github.com/crystal-ameba/ameba/issues/612
 Lint/TopLevelOperatorDefinition:
   Enabled: false
 
+# Disabled: We're running typos explicitly in CI, no need for this rule.
 Lint/Typos:
   Enabled: false
 
-Lint/UnreachableCode:
+# 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/UnusedComparison:
-  Enabled: false
-
-Lint/UnusedInstanceVariableAccess:
-  Enabled: false
-
-Lint/UnusedLiteral:
-  Enabled: false
-
-Lint/UnusedLocalVariableAccess:
-  Enabled: false
-
-Lint/UnusedSelfAccess:
-  Enabled: false
-
+# FIXME: Investigate useless assigns.
 Lint/UselessAssign:
   Enabled: false
 
+# 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
 
@@ -109,6 +110,8 @@ Naming/BinaryOperatorParameterName:
 Naming/BlockParameterName:
   Enabled: false
 
+# Disabled: All violations follow the spelling of identifiers in upstream
+# projects, e.g. for lib bindings.
 Naming/ConstantNames:
   Enabled: false
 
@@ -130,36 +133,36 @@ Naming/TypeNames:
 Naming/VariableNames:
   Enabled: false
 
-Performance/AnyInsteadOfEmpty:
-  Enabled: false
+# Performance
+# =========================
 
-Performance/ChainedCallWithNoBang:
-  Enabled: false
+Performance/AnyInsteadOfEmpty:
+  Excluded:
+  # These specs explicitly test `#any?` implementations
+  - spec/std/bit_array_spec.cr
+  - spec/std/enumerable_spec.cr
+  - spec/std/hash_spec.cr
 
-Performance/FlattenAfterMap:
-  Enabled: false
-
-Performance/MinMaxAfterMap:
-  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/IsAFilter:
-  Enabled: false
-
-Style/IsANil:
-  Enabled: false
-
 Style/MultilineCurlyBlock:
   Enabled: false
 
+# Disabled: This rule seems too strict when any negation inside a complex condition is
+# considered a violation. Not sure if this is expected behaviour.
 Style/NegatedConditionsInUnless:
   Enabled: false
 
+# BUG: https://github.com/crystal-ameba/ameba/issues/614
 Style/ParenthesesAroundCondition:
   Enabled: false
 

.github/workflows/linux.yml

@@ -31,7 +31,7 @@ jobs:
           # libffi is only available starting from the 1.2.2 build images
           - crystal_bootstrap_version: 1.0.0
             flags: "FLAGS=-Dwithout_ffi USE_PCRE1=true"
-          - crystal_bootstrap_version: 1.16.3 # LATEST RELEASE
+          - crystal_bootstrap_version: 1.15.1 # LATEST RELEASE
     steps:
       - name: Download Crystal source
         uses: actions/checkout@v4
@@ -101,3 +101,12 @@ jobs:
 
       - name: Check Format
         run: bin/ci format
+
+  lint_ameba:
+    runs-on: ubuntu-latest
+    container: ghcr.io/crystal-ameba/ameba:sha-d861f4ed0f904e0ecdad11c26f98e968f7d95afa # 1.7.0-dev
+    steps:
+      - name: Download Crystal source
+        uses: actions/checkout@v4
+
+      - run: ameba

scripts/generate_windows_zone_names.cr

@@ -45,7 +45,7 @@ windows_zone_names_items = entries.compact_map do |tzdata_name, territory, windo
 
   {windows_name, zone1.name, zone2.name, location.name}
 rescue err : Time::Location::InvalidLocationNameError
-  pp err
+  puts err
   nil
 end
 

spec/llvm-ir/pass-closure-to-c-debug-loc.cr

@@ -3,7 +3,7 @@ lib Foo
 end
 
 def raise(msg)
-  while true
+  while true # ameba:disable Lint/EmptyLoop
   end
 end
 

spec/std/iterator_spec.cr

@@ -663,7 +663,7 @@ describe Iterator do
 
   describe "uniq" do
     it "without block" do
-      iter = (1..8).each.map { |x| x % 3 }.uniq
+      iter = (1..8).each.map { |x| x % 3 }.uniq # ameba:disable Performance/ChainedCallWithNoBang
       iter.next.should eq(1)
       iter.next.should eq(2)
       iter.next.should eq(0)
@@ -806,7 +806,7 @@ describe Iterator do
     end
 
     it "flattens nested struct iterators with internal state being value types" do
-      iter = (1..2).each.map { |i| StructIter.new(10 * i + 1, 10 * i + 3) }.flatten
+      iter = (1..2).each.map { |i| StructIter.new(10 * i + 1, 10 * i + 3) }.flatten # ameba:disable Performance/FlattenAfterMap
 
       iter.next.should eq(11)
       iter.next.should eq(12)

spec/std/string_spec.cr

@@ -2266,14 +2266,14 @@ describe "String" do
     end
 
     it "compares with == when different strings same contents" do
-      s1 = "foo#{1}"
-      s2 = "foo#{1}"
+      s1 = "foo#{1}" # ameba:disable Lint/LiteralInInterpolation
+      s2 = "foo#{1}" # ameba:disable Lint/LiteralInInterpolation
       s1.should eq(s2)
     end
 
     it "compares with == when different contents" do
-      s1 = "foo#{1}"
-      s2 = "foo#{2}"
+      s1 = "foo#{1}" # ameba:disable Lint/LiteralInInterpolation
+      s2 = "foo#{2}" # ameba:disable Lint/LiteralInInterpolation
       s1.should_not eq(s2)
     end
 

src/kernel.cr

@@ -468,7 +468,7 @@ end
 # See also: `Object#inspect(io)`.
 def p(*objects)
   objects.each do |obj|
-    p obj
+    p obj # ameba:disable Lint/DebugCalls
   end
   objects
 end
@@ -482,7 +482,7 @@ end
 #
 # See `Object#inspect(io)`
 def p(**objects)
-  p(objects) unless objects.empty?
+  p(objects) unless objects.empty? # ameba:disable Lint/DebugCalls
 end
 
 # Pretty prints *object* to `STDOUT` followed
@@ -501,7 +501,7 @@ end
 # See also: `Object#pretty_print(pp)`.
 def pp(*objects)
   objects.each do |obj|
-    pp obj
+    pp obj # ameba:disable Lint/DebugCalls
   end
   objects
 end
@@ -515,7 +515,7 @@ end
 #
 # See `Object#pretty_print(pp)`
 def pp(**objects)
-  pp(objects) unless objects.empty?
+  pp(objects) unless objects.empty? # ameba:disable Lint/DebugCalls
 end
 
 # Registers the given `Proc` for execution when the program exits regularly.