Packages
credo
0.6.1
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
alias Credo.CLI.Output.UI
alias Credo.Config
alias Credo.SourceFile
alias Credo.Service.SourceFileIssues
@doc false
def run(source_files, config) when is_list(source_files) do
{_time_run_on_all, source_files_after_run_on_all} =
:timer.tc fn ->
run_checks_that_run_on_all(source_files, config)
end
{_time_run, source_files} =
:timer.tc fn ->
source_files_after_run_on_all
|> Enum.map(&Task.async(fn -> run(&1, config) end))
|> Enum.map(&Task.await(&1, :infinity))
end
{source_files, config}
end
def run(%SourceFile{} = source_file, config) do
checks =
config
|> Config.checks
|> Enum.reject(&run_on_all_check?/1)
issues = run_checks(source_file, checks, config)
%SourceFile{source_file | issues: source_file.issues ++ issues}
end
@doc """
Prepares the Config struct based on a given list of `source_files`.
"""
def prepare_config(source_files, config) do
config
|> set_lint_attributes(source_files)
|> exclude_low_priority_checks(config.min_priority - 9)
|> exclude_checks_based_on_elixir_version
end
defp set_lint_attributes(config, source_files) do
lint_attribute_map =
source_files
|> run_linter_attribute_reader(config)
|> Enum.reduce(%{}, fn(source_file, memo) ->
# TODO: we should modify the config "directly" instead of going
# through the SourceFile
Map.put(memo, source_file.filename, source_file.lint_attributes)
end)
%Config{config | lint_attribute_map: lint_attribute_map}
end
defp run_linter_attribute_reader(source_files, config) do
checks = [{Credo.Check.FindLintAttributes}]
Enum.reduce(checks, source_files, fn(check_tuple, source_files) ->
run_check(check_tuple, source_files, config)
end)
end
defp exclude_low_priority_checks(config, below_priority) do
checks =
Enum.reject(config.checks, fn
({check}) -> check.base_priority < below_priority
({_check, false}) -> true
({check, opts}) ->
(opts[:priority] || check.base_priority) < below_priority
end)
%Config{config | checks: checks}
end
defp exclude_checks_based_on_elixir_version(config) do
version = System.version()
skipped_checks = Enum.reject(config.checks, &matches_requirement?(&1, version))
checks = Enum.filter(config.checks, &matches_requirement?(&1, version))
%Config{config | checks: checks, skipped_checks: skipped_checks}
end
defp matches_requirement?({check, _}, version) do
matches_requirement?({check}, version)
end
defp matches_requirement?({check}, version) do
Version.match?(version, check.elixir_version)
end
defp run_checks_that_run_on_all(source_files, config) do
checks =
config
|> Config.checks
|> Enum.filter(&run_on_all_check?/1)
checks
|> Enum.map(&Task.async(fn ->
run_check(&1, source_files, config)
end))
|> Enum.each(&Task.await(&1, :infinity))
SourceFileIssues.update_in_source_files(source_files)
end
defp run_checks(%SourceFile{} = source_file, checks, config) when is_list(checks) do
Enum.flat_map(checks, &run_check(&1, source_file, config))
end
defp run_check({_check, false}, source_files, _config) when is_list(source_files) do
source_files
end
defp run_check({_check, false}, _source_file, _config) do
[]
end
defp run_check({check}, source_file, config) do
run_check({check, []}, source_file, config)
end
defp run_check({check, params}, source_file, config) do
try do
check.run(source_file, params)
rescue
error ->
warn_about_failed_run(check, source_file)
if config.crash_on_error do
reraise error, System.stacktrace()
else
[]
end
end
end
defp warn_about_failed_run(check, %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 run_on_all_check?({check}), do: check.run_on_all?
defp run_on_all_check?({check, _params}), do: check.run_on_all?
end