OeditusCredo.Check.Warning.SilentErrorCase (OeditusCredo v0.5.0)

Basics

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

Explanation

Case statements that only handle the success case can lead to unhandled errors.

When a case statement only matches on {:ok, _} without handling {:error, _} or providing a catch-all clause, errors will not be properly handled.

Bad:

case Accounts.get_user(id) do
  {:ok, user} -> user
end

Good:

case Accounts.get_user(id) do
  {:ok, user} -> user
  {:error, reason} -> handle_error(reason)
end

Or with catch-all:

case Accounts.get_user(id) do
  {:ok, user} -> user
  _ -> nil
end

Check-Specific Parameters

Use the following parameters to configure this check:

:exclude_test_files

Set to true to skip test files (default: false)

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.