Normalizaciones del representador de Elixir

El representer de Elixir aplica una serie de normalizaciones. Consulta el código o los datos de prueba para más detalles.

Eliminar comentarios y documentación

Se eliminan todos los comentarios, la documentación, los moduledocs y los typedocs.

Antes

defmodule Fake do
  @moduledoc """
  Fake module to demonstrate stuff
  """

  @doc "Not much to see here"
  def foo do
    # TODO: return bar
    nil
  end
end

Después

defmodule Fake do
  def foo do
    nil
  end
end

Ordenar las importaciones

Las instrucciones de importación al principio de los módulos o las funciones se ordenan así: alias, use, require, import.

Antes

defmodule Fake do
  import D
  alias A.U.V
  use B
  alias A.{T, S}
  require C

  def foo do
    import Z
    alias X
    use Y
  end

  import NotTouched
  alias NotTouched
end

Después

defmodule Fake do
  alias A.{S, T}
  alias A.U.V
  use B
  require C
  import D

  def foo do
    alias X
    use Y
    import Z
  end

  import NotTouched
  alias NotTouched
end

Formatear el código

El código se formatea con [mix code][mix-code], forzando los bloques do end. Todas las funciones dentro de un pipe se escriben con paréntesis. Los tipos se escriben sin ellos.

Antes

defmodule    Fake   do
        @type foo() :: integer() | atom
def foo, do:    nil |> bar
end

Después

defmodule Fake do
  @type foo() :: integer | atom
  def foo do
    nil |> bar()
  end
end

Normalizar los identificadores

Los identificadores se normalizan a un valor de marcador de posición. Algunas variables especiales y atributos de módulo (_, @spec, __MODULE__, etc.) no se sustituyen. Las claves de los mapas, las estructuras y las listas de palabras clave no se normalizan.

Antes

defmodule Fake do
  alias Fake, as: SuperFake
  @my_constant 42

  @impl true
  def foo(bar) when is_integer(bar) do
    bar + @my_constant
  end

  def foo(%{a: a} = bar) do
    %{bar | a: a + @my_constant}
  end

  def foo(_), do: nil
end

Después

defmodule Placeholder_1 do
  alias Placeholder_1, as: Placeholder_2
  @placeholder_6 42
  @impl true
  def placeholder_4(placeholder_5) when is_integer(placeholder_5) do
    placeholder_5 + @placeholder_6
  end

  def placeholder_4(%{a: placeholder_7} = placeholder_5) do
    %{placeholder_5 | a: placeholder_7 + @placeholder_6}
  end

  def placeholder_4(_) do
    nil
  end
end

Ordenar las claves de mapas y estructuras

Las claves de los mapas y las estructuras se ordenan. Las claves de las listas de palabras clave no se ordenan.

Antes

defmodule Fake do
  def foo do
    %MyStruct{z: 3, y: 2, x: 1}
    m = %{c: 3, a: 1, b: 2}
    %{m | b: 20, a: 10}
    [b: 2, a: 1]
  end
end

Después

defmodule Fake do
  def foo do
    %MyStruct{x: 1, y: 2, z: 3}
    placeholder_3 = %{a: 1, b: 2, c: 3}
    %{placeholder_3 | a: 10, b: 20}
    [b: 2, a: 1]
  end
end