View Source Credo.Check.Readability.AliasAs (Credo v1.7.5)


This check is disabled by default.

Learn how to enable it via .credo.exs.

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


Aliases can be "renamed" using the :as option, but that sometimes makes the code more difficult to read.

# preferred

def MyModule do
  alias MyApp.Module1

  def my_function(foo) do

# NOT preferred

def MyModule do
  alias MyApp.Module1, as: M1

  def my_function(foo) do
    # what the heck is `M1`?

Please note that you might want to deactivate this check for cases in which you have an alias that is used tons throughout your codebase.

If, for example, you are using a third-party module named FlupsyTopsyDataRetentionServiceServer in half your modules, it is of course reasonable to alias it to Server.

Like all Readability issues, this one is not a technical concern. But you can improve the odds of others reading and liking your code by making it easier to follow.

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.