Packages
credo
1.7.2
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/suggest/suggest_command.ex
defmodule Credo.CLI.Command.Suggest.SuggestCommand do
@moduledoc false
alias Credo.Check.Params
alias Credo.CLI.Command.Suggest.SuggestOutput
alias Credo.CLI.Switch
alias Credo.CLI.Task
alias Credo.Execution
use Credo.CLI.Command,
short_description: "Suggest code objects to look at next (default)",
treat_unknown_args_as_files: true,
cli_switches: [
Switch.boolean("all_priorities", alias: :A),
Switch.boolean("all", alias: :a),
Switch.boolean("crash_on_error"),
Switch.keep("files_included"),
Switch.keep("files_excluded"),
Switch.keep("checks_with_tag"),
Switch.keep("checks_without_tag"),
Switch.string("checks", alias: :c),
Switch.string("enable_disabled_checks"),
Switch.string("min_priority"),
Switch.boolean("mute_exit_status"),
Switch.boolean("first_run"),
Switch.string("format"),
Switch.boolean("help", alias: :h),
Switch.string("ignore_checks"),
Switch.string("ignore", alias: :i),
Switch.string("only"),
Switch.boolean("read_from_stdin"),
Switch.boolean("strict"),
Switch.boolean("verbose"),
Switch.boolean("watch")
]
def init(exec) do
Execution.put_pipeline(exec, "suggest",
load_and_validate_source_files: [Task.LoadAndValidateSourceFiles],
prepare_analysis: [Task.PrepareChecksToRun],
__manipulate_config_if_rerun__: [__MODULE__.ManipulateConfigIfRerun],
print_before_analysis: [__MODULE__.PrintBeforeInfo],
run_analysis: [Task.RunChecks],
filter_issues: [Task.SetRelevantIssues],
print_after_analysis: [__MODULE__.PrintResultsAndSummary]
)
end
def call(%Execution{help: true} = exec, _opts), do: SuggestOutput.print_help(exec)
def call(exec, _opts), do: Execution.run_pipeline(exec, __MODULE__)
defmodule PrintBeforeInfo do
@moduledoc false
use Credo.Execution.Task
def call(exec) do
source_files = Execution.get_source_files(exec)
SuggestOutput.print_before_info(source_files, exec)
exec
end
end
defmodule PrintResultsAndSummary do
@moduledoc false
use Credo.Execution.Task
def call(exec) do
source_files = Execution.get_source_files(exec)
time_load = Execution.get_assign(exec, "credo.time.source_files")
time_run = Execution.get_assign(exec, "credo.time.run_checks")
SuggestOutput.print_after_info(source_files, exec, time_load, time_run)
exec
end
end
defmodule ManipulateConfigIfRerun do
@moduledoc false
use Credo.Execution.Task
def call(exec, _opts) do
case Execution.get_rerun(exec) do
:notfound ->
exec
{previous_exec, files_that_changed} ->
exec
|> selectively_transfer_issues_from_previous_exec(previous_exec, files_that_changed)
|> modify_config_to_only_include_needed_checks(files_that_changed)
end
end
def selectively_transfer_issues_from_previous_exec(exec, previous_exec, files_that_changed) do
issues_to_keep =
previous_exec
|> Execution.get_issues()
|> Enum.reject(fn issue ->
issue.category == :consistency ||
Enum.member?(files_that_changed, issue.filename)
end)
# all checks on `files_that_changed`
# consistency checks on all files
Execution.put_issues(exec, issues_to_keep)
end
def modify_config_to_only_include_needed_checks(%Credo.Execution{} = exec, files_that_changed) do
checks =
Enum.map(exec.checks, fn {check, params} ->
if check.category == :consistency do
{check, params}
else
{check, Params.put_rerun_files_that_changed(params, files_that_changed)}
end
end)
%Execution{exec | checks: checks}
end
end
end