Packages
credo
1.5.0-rc.4
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.7-rc.0
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.2-rc.4
1.7.2-rc.3
1.7.2-rc.2
1.7.2-rc.1
1.7.2-rc.0
1.7.1
1.7.0
1.7.0-rc.2
1.7.0-rc.1
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.5
1.5.0-rc.4
1.5.0-rc.3
1.5.0-rc.2
1.5.0-rc.1
1.4.1
1.4.0
1.4.0-rc.2
1.4.0-rc.1
1.3.2
1.3.1
1.3.0
1.3.0-rc3
1.3.0-rc2
1.3.0-rc1
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc4
1.2.0-rc3
1.2.0-rc2
1.2.0-rc1
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.1.0-rc3
1.1.0-rc2
1.1.0-rc1
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.1-rc1
1.0.0
1.0.0-rc1
0.10.2
0.10.1
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.9.0-rc8
0.9.0-rc7
0.9.0-rc6
0.9.0-rc5
0.9.0-rc4
0.9.0-rc3
0.9.0-rc2
0.9.0-rc1
0.8.10
0.8.9
0.8.8
0.8.7
0.8.6
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.8.0-rc7
0.8.0-rc6
0.8.0-rc5
0.8.0-rc4
0.8.0-rc3
0.8.0-rc2
0.8.0-rc1
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.1
0.6.0
0.6.0-rc2
0.6.0-rc1
0.5.3
0.5.2
0.5.1
0.5.0
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.10-dev
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-beta5
0.4.0-beta4
0.4.0-beta3
0.4.0-beta2
0.4.0-beta1
0.3.13
0.3.12
0.3.11
0.3.10
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.3.0-dev2
0.3.0-dev
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.1-dev
A static code analysis tool with a focus on code consistency and teaching.
Current section
Files
Jump to
Current section
Files
lib/credo/cli/command/explain/explain_command.ex
defmodule Credo.CLI.Command.Explain.ExplainCommand do
@moduledoc false
@shortdoc "Show code object and explain why it is/might be an issue"
use Credo.CLI.Command
alias Credo.Check
alias Credo.Execution
alias Credo.CLI.Command.Explain.ExplainOutput, as: Output
alias Credo.CLI.Filename
alias Credo.CLI.Task
alias Credo.Issue
alias Credo.SourceFile
@doc false
def call(%Execution{help: true} = exec, _opts), do: Output.print_help(exec)
def call(exec, _opts) do
filename = get_filename_from_args(exec)
cond do
Filename.contains_line_no?(filename) ->
explain_issue(exec)
Check.defined?("Elixir.#{filename}") ->
explain_check(exec, filename)
true ->
Output.print_help(exec)
end
end
defp explain_issue(exec) do
exec
|> run_task(Task.LoadAndValidateSourceFiles)
|> run_task(Task.PrepareChecksToRun)
|> run_task(Task.RunChecks)
|> run_task(Task.SetRelevantIssues)
|> print_results_and_summary()
end
defp explain_check(exec, check_name) do
check = :"Elixir.#{check_name}"
explanations = [cast_to_explanation(check)]
Output.print_after_info(explanations, exec, nil, nil)
exec
end
defp print_results_and_summary(exec) do
filename = get_filename_from_args(exec)
source_files = Execution.get_source_files(exec)
filename
|> String.split(":")
|> print_result(source_files, exec)
exec
end
def print_result([filename], source_files, exec) do
print_result([filename, nil, nil], source_files, exec)
end
def print_result([filename, line_no], source_files, exec) do
print_result([filename, line_no, nil], source_files, exec)
end
def print_result([filename, line_no, column], source_files, exec) do
source_file = Enum.find(source_files, &(&1.filename == filename))
explanations =
exec
|> Execution.get_issues(source_file.filename)
|> filter_issues(line_no, column)
|> Enum.map(&cast_to_explanation(&1, source_file))
Output.print_after_info(explanations, exec, line_no, column)
end
defp get_filename_from_args(exec) do
exec.cli_options.args
|> List.wrap()
|> List.first()
end
defp cast_to_explanation(check) do
%{
category: check.category,
check: check,
explanation_for_issue: check.explanation,
priority: check.base_priority
}
end
defp cast_to_explanation(issue, source_file) do
%{
category: issue.category,
check: issue.check,
column: issue.column,
explanation_for_issue: issue.check.explanation,
filename: issue.filename,
line_no: issue.line_no,
message: issue.message,
priority: issue.priority,
related_code: find_related_code(source_file, issue.line_no),
scope: issue.scope,
trigger: issue.trigger
}
end
defp find_related_code(source_file, line_no) do
[
get_source_line(source_file, line_no - 2),
get_source_line(source_file, line_no - 1),
get_source_line(source_file, line_no),
get_source_line(source_file, line_no + 1),
get_source_line(source_file, line_no + 2)
]
|> Enum.reject(&is_nil/1)
end
defp get_source_line(_, line_no) when line_no < 1 do
nil
end
defp get_source_line(source_file, line_no) do
line = SourceFile.line_at(source_file, line_no)
if line do
{line_no, line}
end
end
defp filter_issues(issues, line_no, nil) do
line_no = line_no |> String.to_integer()
issues |> Enum.filter(&filter_issue(&1, line_no, nil))
end
defp filter_issues(issues, line_no, column) do
line_no = line_no |> String.to_integer()
column = column |> String.to_integer()
issues |> Enum.filter(&filter_issue(&1, line_no, column))
end
defp filter_issue(%Issue{line_no: a, column: b}, a, b), do: true
defp filter_issue(%Issue{line_no: a}, a, _), do: true
defp filter_issue(_, _, _), do: false
end