OptimumCredo.Check.Readability.ModuleOrganization (OptimumCredo v0.5.0)

Basics

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

Explanation

Module organization should follow Phoenix conventions with proper blank line separation between different statement types (use, import, alias, require).

Examples

Bad:

defmodule MyModule do
  use Supervisor
  import Telemetry.Metrics
  alias MyApp.SomeModule
end

Good:

defmodule MyModule do
  use Supervisor
  
  import Telemetry.Metrics
  
  alias MyApp.SomeModule
end

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.