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)

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

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

Параметры

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

printable_app_name()

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

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

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

Обработчики событий

cmd(command)

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

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

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

cmd(command, options)

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

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

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

Параметры

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

error(message)

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

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

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

info(message)

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

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

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

print_app()

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

print_app() :: :ok

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

prompt(message)

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

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

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

yes?(message)

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

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

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