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

Basics

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

Explanation

Prefer list(type) over [type] in typespecs.

Examples

Avoid:

  @type names :: [String.t()]
  @spec run([integer()]) :: [atom()]

Prefer:

  @type names :: list(String.t())
  @spec run(list(integer())) :: list(atom())

Keep [type, ...] when the intent is a non-empty list.

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

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.