Mix

v1.5.1

Mix

Mix v1.5.1 Mix.Shell behaviour View Source

Defines Mix.Shell contract.

Link to this section Summary

Functions

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

An implementation of the command callback that is shared across different shells

printable_app_name()

Returns the printable app name

Callbacks

cmd(command)

Executes the given command and returns its exit status

cmd(command, options)

Executes the given command and returns its exit status

error(message)

Prints the given error to the shell

info(message)

Prints the given message to the shell

print_app()

Prints the current application to the shell if it was not printed yet

prompt(message)

Prompts the user for input

yes?(message)

Prompts the user for confirmation

Link to this section Functions

Link to this function cmd(command, options \\ [], callback) View Source

An implementation of the command callback that is shared across different shells.

Link to this function printable_app_name() View Source

Returns the printable app name.

This function returns the current application name, but only if the application name should be printed.

Calling this function automatically toggles its value to false until the current project is re-entered. The goal is to avoid printing the application name multiple times.

Link to this section Callbacks

Link to this callback cmd(command) View Source 
cmd(command :: String.t()) :: integer()

Executes the given command and returns its exit status.

Link to this callback cmd(command, options) View Source 
cmd(command :: String.t(), options :: keyword()) :: integer()

Executes the given command and returns its exit status.

Options

  • :print_app - when false, does not print the app name when the command outputs something

  • :stderr_to_stdout - when false, does not redirect stderr to stdout

  • :quiet - when true, do not print the command output

  • :env - environment options to the executed command

Link to this callback error(message) View Source 
error(message :: IO.ANSI.ansidata()) :: any()

Prints the given error to the shell.

Link to this callback info(message) View Source 
info(message :: IO.ANSI.ansidata()) :: any()

Prints the given message to the shell.

Link to this callback print_app() View Source 
print_app() :: any()

Prints the current application to the shell if it was not printed yet.

Link to this callback prompt(message) View Source 
prompt(message :: String.t()) :: String.t()

Prompts the user for input.

Link to this callback yes?(message) View Source 
yes?(message :: String.t()) :: boolean()

Prompts the user for confirmation.