Packages
credo
1.7.2-rc.1
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.ex
defmodule Credo.CLI.Command do
@moduledoc """
`Command` is used to describe commands which can be executed from the command line.
The default command is `Credo.CLI.Command.Suggest.SuggestCommand`.
A basic command that writes "Hello World" can be implemented like this:
defmodule HelloWorldCommand do
use Credo.CLI.Command
alias Credo.CLI.Output.UI
def call(_exec, _opts) do
UI.puts([:yellow, "Hello ", :orange, "World"])
end
end
"""
@typedoc false
@type t :: module
@doc """
Is called when a Command is invoked.
defmodule FooTask do
use Credo.Execution.Task
def call(exec) do
IO.inspect(exec)
end
end
The `call/1` functions receives an `exec` struct and must return a (modified) `Credo.Execution`.
"""
@callback call(exec :: Credo.Execution.t()) :: Credo.Execution.t()
@doc """
Is called when a Command is initialized.
The `init/1` functions receives an `exec` struct and must return a (modified) `Credo.Execution`.
This can be used to initialize Execution pipelines for the current Command:
defmodule FooTask do
use Credo.Execution.Task
def init(exec) do
Execution.put_pipeline(exec, __MODULE__,
run_my_thing: [
{RunMySpecialThing, []}
],
filter_results: [
{FilterResults, []}
],
print_results: [
{PrintResultsAndSummary, []}
]
)
end
end
"""
@callback init(exec :: Credo.Execution.t()) :: Credo.Execution.t()
@valid_use_opts [
:short_description,
:treat_unknown_args_as_files,
:cli_switches
]
@doc false
defmacro __using__(opts \\ []) do
Enum.each(opts, fn
{key, _name} when key not in @valid_use_opts ->
raise "Could not find key `#{key}` in #{inspect(@valid_use_opts)}"
_ ->
nil
end)
def_short_description =
if opts[:short_description] do
quote do
@impl true
def short_description, do: unquote(opts[:short_description])
end
end
def_cli_switches =
quote do
@impl true
def cli_switches do
unquote(opts[:cli_switches])
|> List.wrap()
|> Enum.map(&Credo.CLI.Switch.ensure/1)
end
end
def_treat_unknown_args_as_files =
quote do
@impl true
def treat_unknown_args_as_files? do
!!unquote(opts[:treat_unknown_args_as_files])
end
end
quote do
@before_compile Credo.CLI.Command
@behaviour Credo.CLI.Command
unquote(def_short_description)
unquote(def_treat_unknown_args_as_files)
unquote(def_cli_switches)
@deprecated "Use Credo.Execution.Task.run/2 instead"
defp run_task(exec, task), do: Credo.Execution.Task.run(task, exec)
@doc false
@impl true
def init(exec), do: exec
@doc false
@impl true
def call(exec), do: exec
defoverridable init: 1
defoverridable call: 1
end
end
@doc false
defmacro __before_compile__(env) do
quote do
unquote(deprecated_def_short_description(env))
end
end
defp deprecated_def_short_description(env) do
shortdoc = Module.get_attribute(env.module, :shortdoc)
if is_nil(shortdoc) do
if not Module.defines?(env.module, {:short_description, 0}) do
quote do
@impl true
def short_description, do: nil
end
end
else
# deprecated - remove once we ditch @shortdoc
if not Module.defines?(env.module, {:short_description, 0}) do
quote do
@impl true
def short_description do
@shortdoc
end
end
end
end
end
@doc "Runs the Command"
@callback call(exec :: Credo.Execution.t(), opts :: list()) :: Credo.Execution.t()
@doc "Returns a short, one-line description of what the command does"
@callback short_description() :: String.t()
@callback treat_unknown_args_as_files?() :: boolean()
@callback cli_switches() :: [Map.t()]
end