Packages
credo
0.7.4
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.
"""
use Bitwise
alias Credo.Config
alias Credo.ConfigBuilder
alias Credo.Sources
alias Credo.CLI.Filename
alias Credo.CLI.Options
alias Credo.CLI.Output.UI
alias Credo.Service.Commands
@default_command_name "suggest"
@doc false
def main(argv) do
Credo.start nil, nil
argv
|> run()
|> to_exit_status()
|> halt_if_failed()
end
defp run(argv) when is_list(argv) do
argv
|> parse_options()
|> run()
end
defp run({:ok, command_mod, _dir, config}) do
config
|> UI.use_colors
|> Credo.CheckForUpdates.run
|> require_requires()
|> command_mod.run
end
defp run({:error, options, config}) do
UI.use_colors(config)
Enum.each(options.unknown_args, &print_argument/1)
Enum.each(options.unknown_switches, &print_switch/1)
:error
end
defp print_argument(name) do
UI.warn [:red, "Unknown argument: #{name}"]
end
defp print_switch({name, _value}), do: print_switch(name)
defp print_switch(name) do
UI.warn [:red, "Unknown switch: #{name}"]
end
# Requires the additional files specified in the config.
defp require_requires(%Config{requires: requires} = config) do
requires
|> Sources.find
|> Enum.each(&Code.require_file/1)
config
end
defp parse_options(argv) when is_list(argv) do
options = Options.parse(argv, File.cwd!, Commands.names, [UI.edge])
config = ConfigBuilder.parse(options)
options
|> set_command_in_options(config)
|> validate_options(config)
end
defp validate_options(%Options{unknown_args: [], unknown_switches: []} = options, config) do
{:ok, command_for(options.command), options.path, config}
end
defp validate_options(options, config) do
{:error, options, config}
end
defp set_command_in_options(%Options{command: nil} = options, %Config{help: true}) do
%Options{options | command: "help"}
end
defp set_command_in_options(%Options{command: nil} = options, %Config{version: true}) do
%Options{options | command: "version"}
end
defp set_command_in_options(%Options{command: nil, args: args} = options, _config) do
potential_path = List.first(args)
if Filename.contains_line_no?(potential_path) do
%Options{options | command: "explain", path: potential_path}
else
%Options{options | command: @default_command_name}
end
end
defp set_command_in_options(options, _config), do: options
@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_mod) when is_atom(command_mod) do
if Enum.member?(Commands.modules, command_mod) do
command_mod
else
nil
end
end
def command_for(command_name) when is_binary(command_name) do
if Enum.member?(Commands.names, command_name) do
Commands.get(command_name)
else
nil
end
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), do: 255
defp to_exit_status({:error, issues}) do
issues
|> Enum.map(&(&1.exit_status))
|> Enum.reduce(0, &(&1 ||| &2))
end
defp halt_if_failed(0), do: nil
defp halt_if_failed(x), do: System.halt(x)
end