Нормалізації репрезентера Elixir

Огляд нормалізацій, які репрезентер Elixir застосовує до рішень

Репрезентер Elixir застосовує низку нормалізацій. Докладніше можна знайти в коді або тестових даних.

Видалення коментарів і документації

Усі коментарі, документація, moduledocs і typedocs видаляються.

До

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

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

Після

defmodule Fake do
  def foo do
    nil
  end
end

Сортування порядку імпортів

Інструкції import на початку модулів або функцій упорядковуються так: alias, use, require, import.

До

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

Після

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

Форматування коду

Код форматується за допомогою [mix code][mix-code], із примусовим використанням блоків do end. Усі функції в конвеєрах записуються з дужками. Типи записуються без дужок.

До

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

Після

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

Нормалізація ідентифікаторів

Ідентифікатори нормалізуються до значення-заповнювача. Деякі спеціальні змінні та атрибути модуля (_, @spec, __MODULE__ тощо) не замінюються. Ключі з мап, структур і списків ключових слів не нормалізуються.

До

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

Після

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

Сортування ключів у мапах і структурах

Ключі в мапах і структурах сортуються. Ключі в списках ключових слів не сортуються.

До

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

Після

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