Elixir representer 的正規化

Elixir representer 會進行一些正規化處理。 詳情請參閱程式碼或測試資料。

移除註解與文件

所有註解、文件、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 陳述的順序

模組或函式頂端的 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__ 等）不會被取代。 map、struct 和關鍵字清單中的鍵不會被正規化。

修改前

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

排序 map 與 struct 中的鍵

map 和 struct 中的鍵會排序。 關鍵字清單中的鍵則不排序。

修改前

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