Bylaw.Credo.Check.Elixir.PreferBlockIf (bylaw_credo v0.4.0)

Basics

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

Explanation

Prefer block syntax for if expressions.

Block syntax keeps both branches visually grouped with the condition, which makes multi-line control flow easier to scan and extend without reformatting a keyword list.

Examples

Avoid:

if valid?,
  do: :ok,
  else: {:error, :invalid}

Prefer:

if valid? do
  :ok
else
  {:error, :invalid}
end

Notes

This check uses parser metadata to distinguish keyword-form if expressions from block-form expressions.

Options

This check has no check-specific options. Configure it with an empty option list.

Usage

Add this check to Credo's checks: list in .credo.exs:

%{
  configs: [
    %{
      name: "default",
      checks: [
        {Bylaw.Credo.Check.Elixir.PreferBlockIf, []}
      ]
    }
  ]
}

Check-Specific Parameters

There are no specific parameters for this check.

General Parameters

Like with all checks, general params can be applied.

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