Bylaw.Credo.Check.Elixir.SimpleTaggedTupleValues (bylaw_credo v0.3.1)

Basics

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

Explanation

Requires tagged tuples to contain only simple values.

Examples

Avoid:

{:ok, build_result()}
{:reply, %{status: :ready}, state}
{:cont, {:ok, %{acc | committed: [entry | acc.committed]}}}

Prefer:

result = build_result()
{:ok, result}

reply = %{status: :ready}
{:reply, reply, state}

acc = %{acc | committed: [entry | acc.committed]}
{:cont, {:ok, acc}}

Notes

Scalar literals and variables are simple values. Tagged tuples may be nested recursively when all of their leaf values are scalar literals or variables.

Maps, structs, lists, untagged tuples, field access, function calls, pipelines, string interpolation, and operators should be bound to variables before they are placed in a tagged tuple.

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.SimpleTaggedTupleValues, []}
      ]
    }
  ]
}

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.