Packages
credo
1.5.3
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/options.ex
defmodule Credo.CLI.Options do
@moduledoc """
The `Options` struct represents the options given on the command line.
The `Options` struct is stored as part of the `Execution` struct.
"""
alias Credo.Priority
defstruct command: nil,
path: nil,
args: [],
switches: nil,
unknown_switches: [],
unknown_args: []
@doc """
Returns a `Options` struct for the given parameters.
iex> Credo.CLI.Options.parse(["alice", "--debug"], ".", ["alice", "bob", "eve"], [], [debug: :boolean], [])
%Credo.CLI.Options{args: [], command: "alice", path: ".", switches: %{debug: true}, unknown_args: [], unknown_switches: []}
iex> Credo.CLI.Options.parse(["alice", "--friend", "bob", "--friend", "eve"], ".", ["alice", "bob", "eve"], [], [friend: :keep], [])
%Credo.CLI.Options{args: [], command: "alice", path: ".", switches: %{friend: ["bob", "eve"]}, unknown_args: [], unknown_switches: []}
iex> Credo.CLI.Options.parse(["alice", "--friend", "bob", "--friend", "eve"], ".", ["alice", "bob", "eve"], [], [friend: [:string, :keep]], [])
%Credo.CLI.Options{args: [], command: "alice", path: ".", switches: %{friend: ["bob", "eve"]}, unknown_args: [], unknown_switches: []}
"""
def parse(argv, current_dir, command_names, ignored_args, switches_definition, aliases) do
argv
|> OptionParser.parse(strict: switches_definition, aliases: aliases)
|> parse_result(current_dir, command_names, ignored_args, switches_definition)
end
defp parse_result(
{switches_keywords, args, unknown_switches_keywords},
current_dir,
command_names,
ignored_args,
switches_definition
) do
args = Enum.reject(args, &Enum.member?(ignored_args, &1))
{command, path, unknown_args} = split_args(args, current_dir, command_names)
{switches_keywords, extra_unknown_switches} = patch_switches(switches_keywords)
switch_definitions_for_lists =
Enum.filter(switches_definition, fn
{_name, :keep} -> true
{_name, [_, :keep]} -> true
{_name, _value} -> false
end)
switches_with_lists_as_map =
switch_definitions_for_lists
|> Enum.map(fn {name, _value} ->
{name, Keyword.get_values(switches_keywords, name)}
end)
|> Enum.into(%{})
switches =
switches_keywords
|> Enum.into(%{})
|> Map.merge(switches_with_lists_as_map)
%__MODULE__{
command: command,
path: path,
args: unknown_args,
switches: switches,
unknown_switches: unknown_switches_keywords ++ extra_unknown_switches
}
end
defp patch_switches(switches_keywords) do
{switches, unknowns} = Enum.map_reduce(switches_keywords, [], &patch_switch/2)
switches = Enum.reject(switches, &(&1 == nil))
{switches, unknowns}
end
defp patch_switch({:min_priority, str}, unknowns) do
priority = priority_as_name(str) || priority_as_number(str)
case priority do
nil -> {nil, [{"--min-priority", str} | unknowns]}
int -> {{:min_priority, int}, unknowns}
end
end
defp patch_switch(switch, unknowns), do: {switch, unknowns}
defp priority_as_name(str), do: Priority.to_integer(str)
defp priority_as_number(str) do
case Integer.parse(str) do
{int, ""} -> int
_ -> nil
end
end
defp split_args([], current_dir, _) do
{path, unknown_args} = extract_path([], current_dir)
{nil, path, unknown_args}
end
defp split_args([head | tail] = args, current_dir, command_names) do
if Enum.member?(command_names, head) do
{path, unknown_args} = extract_path(tail, current_dir)
{head, path, unknown_args}
else
{path, unknown_args} = extract_path(args, current_dir)
{nil, path, unknown_args}
end
end
defp extract_path([], base_dir) do
{base_dir, []}
end
defp extract_path([path | tail] = args, base_dir) do
if File.exists?(path) or path =~ ~r/[\?\*]/ do
{path, tail}
else
path_with_base = Path.join(base_dir, path)
if File.exists?(path_with_base) do
{path_with_base, tail}
else
{base_dir, args}
end
end
end
end