KogenCredo.Check.Readability.JustifiedCoverageIgnore (KogenCredo v0.1.0)

View Source

Basics

This check is disabled by default.

Learn how to enable it via .credo.exs.

This check has a base priority of high and works with any version of Elixir.

Explanation

Coverage ignores must document their reason so future audits can justify or remove them.

Use format: # coveralls-ignore-next-line: <reason> or # coveralls-ignore-start: <reason>

Valid reasons:

  • Shell git not-found branch (covered by FakeShell in Phase 3.1)
  • OS subprocess glue, exercised by make llm integration
  • Mix-task entrypoint, no test-loop coverage
  • GenServer init/terminate, hostile to ExUnit lifecycle
  • Logger.warning side effect with no return contract
  • Mailgun/Stripe/Bunny webhook crash branch, fail-safe-only

Check-Specific Parameters

Use the following parameters to configure this check:

:allow_bare_until

ISO 8601 date string (e.g. "2026-05-26"). Bare markers are allowed until this date. Default: nil — bare markers always fail.

This parameter defaults to nil.

General Parameters

Like with all checks, general params can be applied.

Parameters can be configured via the .credo.exs config file.