/
multi_alias.ex
61 lines (46 loc) · 1.46 KB
/
multi_alias.ex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
defmodule Credo.Check.Readability.MultiAlias do
@moduledoc false
@checkdoc """
Multi alias expansion makes module uses harder to search for in large code bases.
# preferred
alias Module.Foo
alias Module.Bar
# NOT preferred
alias Module.{Foo, Bar}
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.
"""
@explanation [check: @checkdoc]
use Credo.Check, base_priority: :low
alias Credo.Code
@doc false
def run(source_file, params \\ []) do
issue_meta = IssueMeta.for(source_file, params)
Code.prewalk(source_file, &traverse(&1, &2, issue_meta))
end
defp traverse(
{:alias, _, [{{_, _, [{:__aliases__, opts, base_alias}, :{}]}, _, [multi_alias | _]}]} =
ast,
issues,
issue_meta
) do
{:__aliases__, _, [module | []]} = multi_alias
new_issue = issue_for(issue_meta, Keyword.get(opts, :line), base_alias, module)
{ast, [new_issue | issues]}
end
defp traverse(ast, issues, _issue_meta), do: {ast, issues}
defp issue_for(issue_meta, line_no, base_alias, trigger) do
module =
base_alias
|> Module.concat()
|> Module.concat(trigger)
|> inspect()
format_issue(
issue_meta,
message: "Avoid multi aliases to #{module}; consider removing.",
trigger: trigger,
line_no: line_no
)
end
end