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?

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.

Nevermind, the styleguide is pretty explicit about this: GitHub - christopheradams/elixir_style_guide: A community driven style guide for Elixir · GitHub List module attributes and directives in the following order: @moduledoc @behaviour use import alias require defstruct @type @module_attribute …

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. Recode.Task.AliasOrder — Recode v0.8.0

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 …

Sound decision, makes total sense. I wish it would reorder still :laughing: 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

I wonder if anyone is using the following: alias import require use So you can just sort the whole thing alphabetically, without empty lines. An only after that module attributes, including @moduledoc, as in the doc I found quite often useful to be able to reuse another attribute, or even call a…

At my place we do not have a strict order, as long as they are grouped accordingly. Though due to the way our set up is structured, we often have calls to use/2 in a certain kind of modules that set up “dependencies” to other modules of the same kind input and output events. Those uses were really …

Depending on what they are and the “type” of module, I put them close to where they are first used. If there is a single errant function that needs a macro, I require or import it right in that function.

Folks who would like a more aggressive tool for this might want to look into Styler . It is opinionated and explicitly doesn’t promise that it’ll never break your code , but IME it usually doesn’t and I really do value the automated fix-ups. As a simple example, sometimes I start writing a pipeline a…

Elixir Programming Language Forum

Ordering Use, Import, Alias, Require?

Questions & Help Questions

cmo December 23, 2022, 9:40pm 8

Sorry, I meant recode, not the formatter, when I said “it”.