View Source mix mobilizon.common (Mobilizon v4.1.0-alpha.1)

Common functions to be reused in mix tasks

Summary

task_module()

mix_shell?()

Performs a safe check whether Mix.shell/0 is available (does not raise if Mix is not loaded)

mix_task?()

shortdoc(module)

Gets the shortdoc for the given task module. Returns the shortdoc or nil.

@type task_module() :: atom()

@spec escape_sh_path(String.t()) :: String.t()

@spec get_option(Keyword.t(), atom(), String.t(), String.t() | nil, String.t() | nil) ::
  any()

@spec list_subtasks_for_module(module()) :: [{String.t(), String.t()}]

@spec mix_shell?() :: boolean()

Performs a safe check whether Mix.shell/0 is available (does not raise if Mix is not loaded)

@spec mix_task?() :: boolean()

@spec shell_error(String.t(), Keyword.t()) :: nil | no_return()

@spec shell_info(String.t()) :: :ok

@spec shell_prompt(String.t(), String.t() | nil, String.t() | nil) :: String.t()

@spec shell_yes?(String.t()) :: boolean()

@spec shortdoc(task_module()) :: String.t() | nil

Gets the shortdoc for the given task module. Returns the shortdoc or nil.

@spec show_subtasks_for_module(module()) :: :ok

@spec start_mobilizon() :: any()