tartrazine/.ameba.yml

# This configuration file was generated by `ameba --gen-config`
# on 2024-08-12 22:00:49 UTC using Ameba version 1.6.1.
# The point is for the user to remove these configuration records
# one by one as the reported problems are removed from the code base.

# Problems found: 2
# Run `ameba --only Documentation/DocumentationAdmonition` for details
Documentation/DocumentationAdmonition:
  Description: Reports documentation admonitions
  Timezone: UTC
  Excluded:
  - src/lexer.cr
  - src/actions.cr
  Admonitions:
  - TODO
  - FIXME
  - BUG
  Enabled: true
  Severity: Warning

# Problems found: 22
# Run `ameba --only Lint/MissingBlockArgument` for details
Lint/MissingBlockArgument:
  Description: Disallows yielding method definitions without block argument
  Excluded:
  - pygments/tests/examplefiles/cr/test.cr
  Enabled: true
  Severity: Warning

# Problems found: 1
# Run `ameba --only Lint/NotNil` for details
Lint/NotNil:
  Description: Identifies usage of `not_nil!` calls
  Excluded:
  - pygments/tests/examplefiles/cr/test.cr
  Enabled: true
  Severity: Warning

# Problems found: 34
# Run `ameba --only Lint/ShadowingOuterLocalVar` for details
Lint/ShadowingOuterLocalVar:
  Description: Disallows the usage of the same name as outer local variables for block
    or proc arguments
  Excluded:
  - pygments/tests/examplefiles/cr/test.cr
  Enabled: true
  Severity: Warning

# Problems found: 1
# Run `ameba --only Lint/UnreachableCode` for details
Lint/UnreachableCode:
  Description: Reports unreachable code
  Excluded:
  - pygments/tests/examplefiles/cr/test.cr
  Enabled: true
  Severity: Warning

# Problems found: 6
# Run `ameba --only Lint/UselessAssign` for details
Lint/UselessAssign:
  Description: Disallows useless variable assignments
  ExcludeTypeDeclarations: false
  Excluded:
  - pygments/tests/examplefiles/cr/test.cr
  Enabled: true
  Severity: Warning

# Problems found: 3
# Run `ameba --only Naming/BlockParameterName` for details
Naming/BlockParameterName:
  Description: Disallows non-descriptive block parameter names
  MinNameLength: 3
  AllowNamesEndingInNumbers: true
  Excluded:
  - pygments/tests/examplefiles/cr/test.cr
  AllowedNames:
  - _
  - e
  - i
  - j
  - k
  - v
  - x
  - y
  - ex
  - io
  - ws
  - op
  - tx
  - id
  - ip
  - k1
  - k2
  - v1
  - v2
  ForbiddenNames: []
  Enabled: true
  Severity: Convention

# Problems found: 1
# Run `ameba --only Naming/RescuedExceptionsVariableName` for details
Naming/RescuedExceptionsVariableName:
  Description: Makes sure that rescued exceptions variables are named as expected
  Excluded:
  - pygments/tests/examplefiles/cr/test.cr
  AllowedNames:
  - e
  - ex
  - exception
  - error
  Enabled: true
  Severity: Convention

# Problems found: 6
# Run `ameba --only Naming/TypeNames` for details
Naming/TypeNames:
  Description: Enforces type names in camelcase manner
  Excluded:
  - pygments/tests/examplefiles/cr/test.cr
  Enabled: true
  Severity: Convention