distillery

v2.1.1

distillery v2.1.1 Distillery.Releases.Shell View Source

This module provides conveniences for writing output to the shell.

Link to this section Summary

Types

verbosity()

Functions

colorf(message, color)

Wraps a message in the given color

configure(verbosity)

Configure the logging verbosity of the release logger.

confirm?(message)

Ask the user to confirm an action using the given message. The confirmation prompt will default to "[Yn]: ", and the regex for determining whether the action was confirmed will default to "^(y(es)?)?$".

confirm?(message, prompt, answer_pattern)

Same as confirm/1, but takes a custom prompt and answer regex pattern. If the pattern matches the response, the action is considered confirmed.

debug(message)

Write an debug message to standard out.

debugf(message, color \\ :cyan)

Write a debug level message, but with minimal formatting. Default color is same as debug level

error(message)

Write an error message to standard out.

fail!(message)

Prints an error message, then terminates the VM with a non-zero status code

info(message)

Write an info message to standard out.

levelf(level, message)

Print a message formatted with the default formatting for the given log level

notice(message)

Write an notice message to standard out.

success(message)

Write an success message to standard out.

verbosity()

Returns the current verbosity setting

warn(message)

Write an warn message to standard out.

write(message)

Write the given iodata directly, bypassing the log level

writef(message, color)

Write the given iodata, wrapped in the given color, but bypassing the log level

Link to this section Types

Link to this type

verbosity() View Source 
verbosity() :: :silent | :quiet | :normal | :verbose

Link to this section Functions

Link to this function

colorf(message, color) View Source

Wraps a message in the given color

Link to this function

configure(verbosity) View Source 
configure(verbosity()) :: :ok

Configure the logging verbosity of the release logger.

Valid verbosity settings are:

* `:silent`  - no output except errors
* `:quiet`   - no output except warnings/errors
* `:normal`  - no debug output (default)
* `:verbose` - all output
Link to this function

confirm?(message) View Source 
confirm?(String.t()) :: boolean()

Ask the user to confirm an action using the given message. The confirmation prompt will default to "[Yn]: ", and the regex for determining whether the action was confirmed will default to "^(y(es)?)?$".

Use confirm/3 to provide your own prompt and answer regex.

Link to this function

confirm?(message, prompt, answer_pattern) View Source 
confirm?(String.t(), String.t(), Regex.t()) :: boolean()

Same as confirm/1, but takes a custom prompt and answer regex pattern. If the pattern matches the response, the action is considered confirmed.

Link to this function

debug(message) View Source

Write an debug message to standard out.

Link to this function

debugf(message, color \\ :cyan) View Source

Write a debug level message, but with minimal formatting. Default color is same as debug level

Link to this function

error(message) View Source

Write an error message to standard out.

Link to this function

fail!(message) View Source 
fail!(iodata()) :: no_return()

Prints an error message, then terminates the VM with a non-zero status code

Link to this function

info(message) View Source

Write an info message to standard out.

Link to this function

levelf(level, message) View Source

Print a message formatted with the default formatting for the given log level

Link to this function

notice(message) View Source

Write an notice message to standard out.

Link to this function

success(message) View Source

Write an success message to standard out.

Link to this function

verbosity() View Source

Returns the current verbosity setting

Link to this function

warn(message) View Source

Write an warn message to standard out.

Link to this function

write(message) View Source

Write the given iodata directly, bypassing the log level

Link to this function

writef(message, color) View Source

Write the given iodata, wrapped in the given color, but bypassing the log level