Elixir 表示器规范化

Elixir 的 representer 会应用多项规范化。详情请参考代码或测试数据。

移除注释和文档

所有注释、文档、模块文档和类型文档都会被移除。

之前

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__ 等）不会被替换。映射、结构体和关键字列表中的键不会被规范化。

之前

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