Skip to content

Commit

Permalink
Fix incorrect columns for dbg and IO.inspect
Browse files Browse the repository at this point in the history
Previously, this was backfilling the column based on analyzing the
source code line, but the column is already available in the AST, so we
instead take it from there.

This allows IDE type tools to accurately create refactor "code actions".
  • Loading branch information
mhanberg committed Apr 25, 2024
1 parent c0b82e4 commit a227dfd
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 13 deletions.
17 changes: 9 additions & 8 deletions lib/credo/check/warning/dbg.ex
Expand Up @@ -32,59 +32,60 @@ defmodule Credo.Check.Warning.Dbg do
issues,
issue_meta
) do
{ast, [issue_for(issue_meta, meta[:line]) | issues]}
{ast, [issue_for(issue_meta, meta) | issues]}
end

defp traverse(
{:dbg, meta, [_single_param]} = ast,
issues,
issue_meta
) do
{ast, [issue_for(issue_meta, meta[:line]) | issues]}
{ast, [issue_for(issue_meta, meta) | issues]}
end

defp traverse(
{:dbg, meta, [_first_param, _second_param]} = ast,
issues,
issue_meta
) do
{ast, [issue_for(issue_meta, meta[:line]) | issues]}
{ast, [issue_for(issue_meta, meta) | issues]}
end

defp traverse(
{{:., _, [{:__aliases__, _, [:"Elixir", :Kernel]}, :dbg]}, meta, _args} = ast,
issues,
issue_meta
) do
{ast, [issue_for(issue_meta, meta[:line]) | issues]}
{ast, [issue_for(issue_meta, meta) | issues]}
end

defp traverse(
{{:., _, [{:__aliases__, _, [:Kernel]}, :dbg]}, meta, _args} = ast,
issues,
issue_meta
) do
{ast, [issue_for(issue_meta, meta[:line]) | issues]}
{ast, [issue_for(issue_meta, meta) | issues]}
end

defp traverse(
{:|>, _, [_, {:dbg, meta, nil}]} = ast,
issues,
issue_meta
) do
{ast, [issue_for(issue_meta, meta[:line]) | issues]}
{ast, [issue_for(issue_meta, meta) | issues]}
end

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

defp issue_for(issue_meta, line_no) do
defp issue_for(issue_meta, meta) do
format_issue(
issue_meta,
message: "There should be no calls to `dbg/1`.",
trigger: "dbg",
line_no: line_no
line_no: meta[:line],
column: meta[:column]
)
end
end
11 changes: 6 additions & 5 deletions lib/credo/check/warning/io_inspect.ex
Expand Up @@ -23,15 +23,15 @@ defmodule Credo.Check.Warning.IoInspect do
end

defp traverse(
{{:., _, [{:__aliases__, _, [:"Elixir", :IO]}, :inspect]}, meta, _arguments} = ast,
{{:., _, [{:__aliases__, meta, [:"Elixir", :IO]}, :inspect]}, _, _arguments} = ast,
issues,
issue_meta
) do
{ast, issues_for_call(meta, issues, issue_meta)}
end

defp traverse(
{{:., _, [{:__aliases__, _, [:IO]}, :inspect]}, meta, _arguments} = ast,
{{:., _, [{:__aliases__, meta, [:IO]}, :inspect]}, _meta, _arguments} = ast,
issues,
issue_meta
) do
Expand All @@ -43,15 +43,16 @@ defmodule Credo.Check.Warning.IoInspect do
end

defp issues_for_call(meta, issues, issue_meta) do
[issue_for(issue_meta, meta[:line], @call_string) | issues]
[issue_for(issue_meta, meta, @call_string) | issues]
end

defp issue_for(issue_meta, line_no, trigger) do
defp issue_for(issue_meta, meta, trigger) do
format_issue(
issue_meta,
message: "There should be no calls to `IO.inspect/1`.",
trigger: trigger,
line_no: line_no
line_no: meta[:line],
column: meta[:column]
)
end
end
18 changes: 18 additions & 0 deletions test/credo/check/warning/dbg_test.exs
Expand Up @@ -71,6 +71,24 @@ defmodule Credo.Check.Warning.DbgTest do
|> assert_issue()
end

test "it should report a violation with two on the same line" do
"""
defmodule CredoSampleModule do
def some_function(parameter1, parameter2) do
dbg(parameter1) + dbg(parameter2)
end
end
"""
|> to_source_file
|> run_check(@described_check)
|> assert_issues(fn [one, two] ->
assert one.line_no == 3
assert one.column == 23
assert two.line_no == 3
assert two.column == 5
end)
end

test "it should report a violation /2" do
"""
defmodule CredoSampleModule do
Expand Down
19 changes: 19 additions & 0 deletions test/credo/check/warning/io_inspect_test.exs
Expand Up @@ -37,6 +37,25 @@ defmodule Credo.Check.Warning.IoInspectTest do
|> assert_issue()
end

test "it should report a violation with two on the same line" do
"""
defmodule CredoSampleModule do
def some_function(parameter1, parameter2) do
foo(IO.inspect(parameter1), parameter2) |> IO.inspect()
end
end
"""
|> to_source_file
|> run_check(@described_check)
|> assert_issues(fn [first, second] ->
assert first.line_no == 3
assert first.column == 48

assert second.line_no == 3
assert second.column == 9
end)
end

test "it should report a violation /2" do
"""
defmodule CredoSampleModule do
Expand Down

0 comments on commit a227dfd

Please sign in to comment.