OeditusCredo.Check.Warning.MissingErrorHandling (OeditusCredo v0.6.2)

Basics

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

Explanation

Pattern matching on {:ok, result} without handling the error case can lead to crashes.

When a function returns {:ok, value} | {:error, reason}, pattern matching directly with {:ok, result} = function() will raise a MatchError if an error tuple is returned.

Bad:

{:ok, user} = Accounts.get_user(id)

Good:

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

Or use with:

with {:ok, user} <- Accounts.get_user(id) do
  user
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.