Packages
credo
1.7.19
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/help.ex
defmodule Credo.CLI.Command.Help do
@moduledoc false
@ljust 12
@starting_order ~w(suggest explain)
@ending_order ~w(help)
alias Credo.CLI.Output.UI
alias Credo.CLI.Sorter
alias Credo.CLI.Switch
alias Credo.Execution
use Credo.CLI.Command,
short_description: "Show this help message",
cli_switches: [
Switch.string("format"),
Switch.boolean("help", alias: :h)
]
@doc false
def call(exec, _opts) do
print_banner()
print_message(exec)
exec
end
def print_banner do
banner()
|> String.split("")
|> Enum.flat_map(fn char -> [color_for(char), char_for(char)] end)
|> UI.puts()
UI.puts()
end
def print_message(exec) do
UI.puts("Credo Version #{Credo.version()}")
UI.puts(["Usage: ", :olive, "$ mix credo <command> [options]"])
UI.puts("\nCommands:\n")
exec
|> Execution.get_valid_command_names()
|> Sorter.ensure(@starting_order, @ending_order)
|> Enum.each(fn name ->
module = Execution.get_command(exec, name)
padded_name =
name
|> to_string
|> String.pad_trailing(@ljust)
case module.short_description() do
nil ->
UI.puts(" #{padded_name}")
short_description ->
UI.puts(" #{padded_name}#{short_description}")
end
end)
UI.puts("\nUse `--help` on any command to get further information.")
example = [
"For example, `",
:olive,
"mix credo suggest --help",
:reset,
"` for help on the default command."
]
UI.puts(example)
end
def color_for("#"), do: [:reset, :darkgreen]
def color_for(";"), do: [:reset, :faint, :green]
def color_for("~"), do: [:reset, :bright, :green]
def color_for(":"), do: [:reset, :faint, :yellow]
def color_for("="), do: [:reset, :bright, :yellow]
def color_for("-"), do: [:reset, :faint, :red]
def color_for("["), do: [:reset, :bright, :red]
def color_for("M"), do: [:reset, :blue]
def color_for(","), do: [:reset, :color235]
def color_for(_), do: [:reset, :white]
# ~w(▁ ▂ ▃ ▄ ▅ ▆ ▇ █)
def char_for(" "), do: " "
def char_for("\n"), do: "\n"
def char_for("#"), do: "▇"
def char_for(";"), do: "▇"
def char_for("~"), do: "▇"
def char_for(":"), do: "▇"
def char_for("="), do: "▇"
def char_for("-"), do: "▇"
def char_for("["), do: "▇"
def char_for("M"), do: "▇"
def char_for(","), do: "▅"
def char_for(v), do: v
def banner do
"""
####################### ##### ###
#######################,,,,,#####,,, ###
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
~~~~~~~~~~~~~~~~~,,,~~~~~~~~,,,~~~,,,,,,,,,,,
;;;;;;~~~~~~~~~~~~~~~~~,,,~~~~~~~~,,,~~~,,,,,,,,,,,
;;;;;;;;;;;;;,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
::::::::::::::::::::,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
:::::===================,,,==========,,,==,,,,,,,,,,,,,,,,
===================,,,==========,,,==,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
----------------,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
-------[[[[[[[[[[[[[[[[[[[[[[[,,,[[,,,[[[[[[,,,,,,,,,,
[[[[[[[[[[[[[[[[[[[[[[[,,,[[,,,[[[[[[,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
MMMMMMMMMMMMMMMMMMMMMMM,,,,MMMMM,,,, MMM
MMMMMMMMMMMMMMMMMMMMMMM MMMMM MMM
"""
end
end