Packages
credo
0.3.0-dev2
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.ex
defmodule Credo.CLI do
@moduledoc """
Credo.CLI is the entrypoint for both the Mix task and the escript.
It takes the parameters passed from the command line and translates them into
a Command module (see the `Credo.CLI.Command` namespace), the work directory
where the Command should run and a `Credo.Config` object.
"""
alias Credo.Config
alias Credo.CLI.Filename
@default_dir "."
@default_command_name "suggest"
@command_map %{
help: Credo.CLI.Command.Help,
list: Credo.CLI.Command.List,
suggest: Credo.CLI.Command.Suggest,
explain: Credo.CLI.Command.Explain,
categories: Credo.CLI.Command.Categories,
version: Credo.CLI.Command.Version
}
@switches [
format: :string,
checks: :string,
ignore_checks: :string,
min_priority: :integer
]
@aliases [
a: :all,
A: :all_priorities,
c: :checks,
C: :config_name,
i: :ignore_checks,
h: :help,
v: :version,
]
def main(argv) do
Credo.start nil, nil
run(argv)
|> to_exit_status
|> System.halt
end
@doc "Returns a List with the names of all commands."
def commands, do: Map.keys(@command_map)
@doc """
Returns the module of a given `command`.
iex> command_for(:help)
Credo.CLI.Command.Help
"""
def command_for(nil), do: nil
def command_for(command) when is_binary(command) do
command_for(command |> String.to_atom)
end
def command_for(command) when is_atom(command) do
if Enum.member?(commands, command) do
@command_map[command]
else
nil
end
end
defp run(argv) do
{command_mod, dir, config} = parse_options(argv)
command_mod.run(dir, config)
end
defp parse_options(argv) do
{switches, files, []} =
OptionParser.parse(argv, switches: @switches, aliases: @aliases)
command_name =
if files |> List.first |> command_for do
command_name = files |> List.first
files = files |> List.delete_at(0)
command_name
else
nil
end
dir = (files |> List.first) || @default_dir
config = dir |> to_config(switches)
command_name_dir_config(command_name, dir, config)
end
defp command_name_dir_config(nil, dir, %Config{help: true} = config) do
command_name_dir_config("help", dir, config)
end
defp command_name_dir_config(nil, dir, %Config{version: true} = config) do
command_name_dir_config("version", dir, config)
end
defp command_name_dir_config(nil, dir, config) do
if Filename.contains_line_no?(dir) do
command_name_dir_config("explain", dir, config)
else
command_name_dir_config(@default_command_name, dir, config)
end
end
defp command_name_dir_config(command_name, dir, config) do
{command_for(command_name), dir, config}
end
defp to_config(dir, switches) do
dir = dir |> Filename.remove_line_no_and_column
config_name = switch(switches, :config_name)
config = Config.read_or_default(dir, config_name)
if switch(switches, :all) do
config = %Config{config | all: true}
end
if switch(switches, :all_priorities, :strict) do
config = %Config{config | all: true, min_priority: -99}
end
if switch(switches, :help), do: config = %Config{config | help: true}
if switch(switches, :one_line), do: config = %Config{config | format: "one-line"}
if switch(switches, :flycheck), do: config = %Config{config | format: "flycheck"}
if switch(switches, :verbose), do: config = %Config{config | verbose: true}
if switch(switches, :version), do: config = %Config{config | version: true}
if switch(switches, :crash_on_error), do: config = %Config{config | crash_on_error: true}
min_priority = switch(switches, :min_priority)
if min_priority do
config =
%Config{config | min_priority: min_priority}
end
# only include certain checks
check_pattern = switch(switches, :checks, :only)
if check_pattern do
config =
%Config{config | all: true, match_checks: check_pattern |> String.split(",")}
end
# exclude/ignore certain checks
ignore_pattern = switch(switches, :ignore_checks)
if ignore_pattern do
config =
%Config{config | ignore_checks: ignore_pattern |> String.split(",")}
end
config
end
def switch(switches, key), do: Keyword.get(switches, key)
def switch(switches, key, alias_key) do
Keyword.get(switches, key) || Keyword.get(switches, alias_key)
end
# Converts the return value of a Command.run() call into an exit_status
defp to_exit_status(:ok), do: 0
defp to_exit_status({:error, issues}) do
issues
|> Enum.map(&(&1.exit_status))
|> Enum.uniq
|> Enum.reduce(0, &(&1+&2))
end
end