Bylaw.Credo.Check.Elixir.UseMaybeInFunctionName (bylaw_credo v0.1.0-alpha.1)

Basics

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

Explanation

Use maybe_ in function names that only perform work conditionally.

Examples

Avoid:

  def complete_run_if_needed(run), do: ...

Prefer:

  def maybe_complete_run(run), do: ...

A leading maybe_ keeps the conditional intent visible without coupling the naming convention to a specific suffix like _if_needed.

Notes

This check uses static AST analysis, so it favors clear source-level patterns over runtime behavior.

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

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.