Packages
credo
0.8.0-rc6
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.ex
defmodule Credo.CLI.Command.Explain do
use Credo.CLI.Command
@shortdoc "Show code object and explain why it is/might be an issue"
alias Credo.Check.Runner
alias Credo.Execution
alias Credo.CLI.Filename
alias Credo.CLI.Output.Explain
alias Credo.CLI.Output.UI
alias Credo.CLI.Output
alias Credo.Sources
# TODO: explain used exec options
@doc false
def run(%Execution{help: true} = exec), do: print_help(exec)
def run(exec) do
filename = Execution.get_path(exec)
if Filename.contains_line_no?(filename) do
exec
|> load_and_validate_source_files()
|> Runner.prepare_config
|> run_checks()
|> print_results_and_summary()
|> determine_success()
else
print_help(exec)
end
end
defp load_and_validate_source_files(exec) do
{time_load, {valid_source_files, invalid_source_files}} =
:timer.tc fn ->
exec
|> Sources.find
|> Enum.partition(&(&1.valid?))
end
Output.complain_about_invalid_source_files(invalid_source_files)
exec
|> Execution.put_source_files(valid_source_files)
|> Execution.put_assign("credo.time.source_files", time_load)
end
defp run_checks(%Execution{} = exec) do
source_files = Execution.get_source_files(exec)
{time_run, :ok} =
:timer.tc fn ->
Runner.run(source_files, exec)
end
exec
|> Execution.put_assign("credo.time.run_checks", time_run)
end
defp print_results_and_summary(exec) do
filename = Execution.get_path(exec)
source_files = Execution.get_source_files(exec)
filename
|> String.split(":")
|> print_result(source_files, exec)
exec
end
defp determine_success(exec) do
exec
end
defp output_mod(_) do
Explain
end
defp print_result([filename], source_files, exec) do
print_result([filename, nil, nil], source_files, exec)
end
defp print_result([filename, line_no], source_files, exec) do
print_result([filename, line_no, nil], source_files, exec)
end
defp print_result([filename, line_no, column], source_files, exec) do
source_files
|> Enum.find(&(&1.filename == filename))
|> print_result(exec, line_no, column)
end
def print_result(source_file, exec, line_no, column) do
output = output_mod(exec)
output.print_before_info([source_file], exec)
output.print_after_info(source_file, exec, line_no, column)
end
defp print_help(exec) do
usage = ["Usage: ", :olive, "mix credo explain path_line_no_column [options]"]
description =
"""
Explain the given issue.
"""
example = ["Example: ", :olive, :faint, "$ mix credo explain lib/foo/bar.ex:13:6"]
options =
"""
General options:
-v, --version Show version
-h, --help Show this help
"""
UI.puts(usage)
UI.puts(description)
UI.puts(example)
UI.puts(options)
exec
end
end