View Source Credo.CLI.Output.UI (Credo v1.7.2-rc.4)

This module provides functions used to create the UI.

>>> alias Credo.CLI.Output.UI
>>> UI.puts "This is a test."
This is a test.
nil

>>> alias Credo.CLI.Output.UI
>>> UI.warn "This is a warning."
This is a warning.
nil

Summary

Functions

edge()

Returns the edge (┃) which is used in much of Credo's output as a binary.

edge(color, indent \\ 2)

puts()

See Credo.CLI.Output.Shell.puts/0.

puts(v)

See Credo.CLI.Output.Shell.puts/1.

puts(v, color)

puts_edge(color, indent \\ 2)

truncate(line, max_length)

Truncate a line to fit within a specified maximum length. Truncation is indicated by a trailing ellipsis (…), and you can override this using an optional third argument.

truncate(line, max_length, ellipsis)

use_colors(exec)

warn(v)

See Credo.CLI.Output.Shell.warn/1.

wrap_at(text, number)

Functions

edge()

Returns the edge (┃) which is used in much of Credo's output as a binary.

edge(color, indent \\ 2)

puts()

See Credo.CLI.Output.Shell.puts/0.

puts(v)

See Credo.CLI.Output.Shell.puts/1.

puts(v, color)

puts_edge(color, indent \\ 2)

truncate(line, max_length)

Truncate a line to fit within a specified maximum length. Truncation is indicated by a trailing ellipsis (…), and you can override this using an optional third argument.

iex> Credo.CLI.Output.UI.truncate(nil, 7)
""
iex> Credo.CLI.Output.UI.truncate("  7 chars\n", 7)
"  7 ch…"
iex> Credo.CLI.Output.UI.truncate("  more than 7\n", 7)
"  more…"
iex> Credo.CLI.Output.UI.truncate("  more than 7\n", 7, " ...")
"  m ..."

truncate(line, max_length, ellipsis)

use_colors(exec)

warn(v)

See Credo.CLI.Output.Shell.warn/1.

Settings View Source Credo.CLI.Output.UI (Credo v1.7.2-rc.4)

Summary

Functions

Functions

edge()

edge(color, indent \\ 2)

puts()

puts(v)

puts(v, color)

puts_edge(color, indent \\ 2)

truncate(line, max_length)

truncate(line, max_length, ellipsis)

use_colors(exec)

warn(v)

wrap_at(text, number)

View Source Credo.CLI.Output.UI (Credo v1.7.2-rc.4)