Mix.Shell поведение

Определяет Mix.Shell контракт.

Краткое описание

Функции

cmd(command, options \\ [], callback): Выполняет заданную command как команду оболочки и вызывает callback для потокового ответа.
printable_app_name(): Возвращает имя приложения, пригодное для вывода.

Обработчики

cmd(command): Выполняет заданную команду и возвращает ее код завершения.
cmd(command, options): Выполняет заданную команду и возвращает ее код завершения.
error(message): Выводит заданную ANSI-ошибку в оболочку.
info(message): Выводит заданное ANSI-сообщение в оболочку.
print_app(): Выводит текущее приложение в оболочку, если оно ещё не выводилось.
prompt(message): Запрашивает ввод у пользователя.
yes?(message): Запрашивает подтверждение у пользователя.

Функции

cmd(command, options \\ [], callback)Source

Выполняет заданную command как команду оболочки и вызывает callback для потокового ответа.

Это чаще всего используется реализациями оболочки, но также может быть вызвано напрямую.

Параметры

:cd - (с версии v1.11.0) каталог для выполнения команды
:stderr_to_stdout - перенаправляет stderr в stdout, по умолчанию true
:env - список переменных среды, по умолчанию []
:quiet - переопределяет обработчик на пустую функцию

printable_app_name()Source

Возвращает имя приложения, пригодное для вывода.

Эта функция возвращает текущее имя приложения, но только если имя приложения должно быть выведено.

Вызов этой функции автоматически переключает ее значение на false до тех пор, пока текущий проект не будет повторно вошел. Цель - избежать многократного вывода имени приложения.

Обработчики

cmd(command)Source

Спецификации

cmd(command :: String.t()) :: integer()

Выполняет заданную команду и возвращает ее код завершения.

cmd(command, options)Source

Спецификации

cmd(command :: String.t(), options :: keyword()) :: integer()

Выполняет заданную команду и возвращает ее код завершения.

Параметры

:print_app - когда false, не выводит имя приложения, когда команда выводит что-то
:stderr_to_stdout - когда false, не перенаправляет stderr в stdout
:quiet - когда true, не выводит вывод команды
:env - параметры переменных среды для исполняемой команды

error(message)Source

Спецификации

error(message :: IO.ANSI.ansidata()) :: :ok

Выводит заданную ANSI-ошибку в оболочку.

info(message)Source

Спецификации

info(message :: IO.ANSI.ansidata()) :: :ok

Выводит заданное ANSI-сообщение в оболочку.

print_app()Source

Спецификации

print_app() :: :ok

Выводит текущее приложение в оболочку, если оно ещё не выводилось.

prompt(message)Source

Спецификации

prompt(message :: binary()) :: binary()

Запрашивает ввод у пользователя.

yes?(message)Source

Спецификации

yes?(message :: binary()) :: boolean()

Запрашивает подтверждение у пользователя.