Is there a recommended ordering of require
, use
, import
, and alias
? Does the style guide have anything to say about the preferred ordering of special forms?
Nevermind, the styleguide is pretty explicit about this: GitHub - christopheradams/elixir_style_guide: A community driven style guide for Elixir
List module attributes and directives in the following order:
- @moduledoc
- @behaviour
- use
- import
- alias
- require
- defstruct
- @type
- @module_attribute
- @callback
- @macrocallback
- @optional_callbacks
Add a blank line between each grouping, and sort the terms (like module names) alphabetically.
Note that the order of some items have been changed:
@moduledoc
@behaviour
use
import
require
alias
@module_attribute
defstruct
@type
@callback
@macrocallback
@optional_callbacks
-
defmacro
,defmodule
,defguard
,def
, etc.
Does anyone know if mix format
takes care of this somehow? Any config I can set to have it auto sort it for me?
I donât know if it handles ordering all of them but might be able to be extended to do so.
It wonât ever do that. One premise of the core formatter is that it wonât change the underlying AST by applying formatting. That ensures that formatting will never introduce a change in behavior of the code and therefore wonât introduce unintended bugs. Reordering expressions means changing the AST however.
Sound decision, makes total sense. I wish it would reorder still
I guess Iâll configure Credo to be extra annoying so my team doesnât commit unordered aliases. credo --strict --no-really-i-want-strict
Sorry, I meant recode
, not the formatter, when I said âitâ.