Packages
credo
1.7.13
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/check/runner.ex
defmodule Credo.Check.Runner do
@moduledoc false
# This module is responsible for running checks based on the context represented
# by the current `Credo.Execution`.
alias Credo.Check.Params
alias Credo.CLI.Output.UI
alias Credo.Execution
alias Credo.Execution.ExecutionTiming
@doc """
Runs all checks on all source files (according to the config).
"""
def run(source_files, exec) when is_list(source_files) do
check_tuples =
exec
|> Execution.checks()
|> warn_about_ineffective_patterns(exec)
|> fix_deprecated_notation_for_checks_without_params()
check_tuples
|> Task.async_stream(&run_check(exec, &1), timeout: :infinity, ordered: false)
|> Stream.run()
:ok
end
defp run_check(%Execution{debug: true} = exec, {check, params}) do
ExecutionTiming.run(&do_run_check/2, [exec, {check, params}])
|> ExecutionTiming.append(exec, task: exec.current_task, check: check)
end
defp run_check(exec, {check, params}) do
do_run_check(exec, {check, params})
end
defp do_run_check(exec, {check, params}) do
rerun_files_that_changed = Params.get_rerun_files_that_changed(params)
files_included = Params.files_included(params, check)
files_excluded = Params.files_excluded(params, check)
found_relevant_files =
cond do
files_included == [] and files_excluded == [] ->
[]
exec.read_from_stdin ->
# TODO: I am unhappy with how convoluted this gets
# but it is necessary to avoid hitting the filesystem when reading from STDIN
[%Credo.SourceFile{filename: filename}] = Execution.get_source_files(exec)
file_included? =
if files_included != [] do
Credo.Sources.filename_matches?(filename, files_included)
else
true
end
file_excluded? =
if files_excluded != [] do
Credo.Sources.filename_matches?(filename, files_excluded)
else
false
end
if !file_included? || file_excluded? do
:skip_run
else
[]
end
true ->
exec
|> Execution.working_dir()
|> Credo.Sources.find_in_dir(files_included, files_excluded)
|> case do
[] -> :skip_run
files -> files
end
end
source_files =
exec
|> Execution.get_source_files()
|> filter_source_files(rerun_files_that_changed)
|> filter_source_files(found_relevant_files)
try do
check.run_on_all_source_files(exec, source_files, params)
rescue
error ->
warn_about_failed_run(check, source_files)
if exec.crash_on_error do
reraise error, __STACKTRACE__
else
[]
end
end
end
defp filter_source_files(_source_files, :skip_run) do
[]
end
defp filter_source_files(source_files, []) do
source_files
end
defp filter_source_files(source_files, files_included) do
Enum.filter(source_files, fn source_file ->
Enum.member?(files_included, Path.expand(source_file.filename))
end)
end
defp warn_about_failed_run(check, %Credo.SourceFile{} = source_file) do
UI.warn("Error while running #{check} on #{source_file.filename}")
end
defp warn_about_failed_run(check, _) do
UI.warn("Error while running #{check}")
end
defp fix_deprecated_notation_for_checks_without_params(checks) do
Enum.map(checks, fn
{check} -> {check, []}
{check, params} -> {check, params}
end)
end
defp warn_about_ineffective_patterns(
{checks, _included_checks, []},
%Execution{ignore_checks: [_ | _] = ignore_checks}
) do
UI.warn([
:red,
"A pattern was given to ignore checks, but it did not match any: ",
inspect(ignore_checks)
])
checks
end
defp warn_about_ineffective_patterns({checks, _, _}, _) do
checks
end
end