Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add UnnecessaryAliasExpansion check #640

Merged
merged 1 commit into from Mar 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .credo.exs
Expand Up @@ -93,6 +93,7 @@
{Credo.Check.Readability.StringSigils, []},
{Credo.Check.Readability.TrailingBlankLine, []},
{Credo.Check.Readability.TrailingWhiteSpace, []},
{Credo.Check.Readability.UnnecessaryAliasExpansion, []},
{Credo.Check.Readability.VariableNames, []},

#
Expand Down
48 changes: 48 additions & 0 deletions lib/credo/check/readability/unnecessary_alias_expansion.ex
@@ -0,0 +1,48 @@
defmodule Credo.Check.Readability.UnnecessaryAliasExpansion do
@moduledoc false

@checkdoc """
Alias expansion is useful but when aliasing a single module,
it can be harder to read with unnecessary braces.

# preferred

alias ModuleA.Foo
alias ModuleA.{Foo, Bar}

# NOT preferred

alias ModuleA.{Foo}

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, [child]}]}]} = ast, issues, issue_meta) do
{ast, issues ++ [issue_for(issue_meta, Keyword.get(opts, :line), child)]}
end

defp traverse(ast, issues, _issue_meta), do: {ast, issues}

defp issue_for(issue_meta, line_no, trigger) do
format_issue(
issue_meta,
message: "Unnecessary alias expansion for #{trigger}, consider removing braces.",
trigger: trigger,
line_no: line_no
)
end
end
46 changes: 46 additions & 0 deletions test/credo/check/readability/unnecessary_alias_expansion_test.exs
@@ -0,0 +1,46 @@
defmodule Credo.Check.Readability.UnnecessaryAliasExpansionTest do
use Credo.TestHelper

@described_check Credo.Check.Readability.UnnecessaryAliasExpansion

#
# cases NOT raising issues
#

test "it should NOT report violation" do
"""
defmodule Test do
alias App.Module1
alias App.{Module2, Module3}
end
"""
|> to_source_file
|> refute_issues(@described_check)
end

#
# cases raising issues
#

test "it should report a violation" do
"""
defmodule CredoSampleModule do
alias App.Module1
alias App.Module2.{Module3}
end
"""
|> to_source_file
|> assert_issue(@described_check)
end

test "it should report a violation for double expansion" do
"""
defmodule CredoSampleModule do
alias App.Module1
alias App.{Module2}.{Module3}
end
"""
|> to_source_file
|> assert_issue(@described_check)
end
end