KogenCredo.Check.Readability.ErrorReasonString (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 low and works with any version of Elixir.

Explanation

Return a machine-matchable reason, not prose: {:error, :not_found}, {:error, {:invalid, :email}} or an exception struct. Render human text at the edge (controller, CLI, UI).

Check-Specific Parameters

Use the following parameters to configure this check:

:included_paths

Only files under these path prefixes are checked.

This parameter defaults to ["lib/"].

:excluded_paths

Files under these path prefixes are skipped (Mix tasks by default).

This parameter defaults to ["lib/mix/"].

:flag_interpolated

Also report interpolated strings.

This parameter defaults to true.

General Parameters

Like with all checks, general params can be applied.

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