Packages
credo
1.7.13
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.7-rc.0
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.2-rc.4
1.7.2-rc.3
1.7.2-rc.2
1.7.2-rc.1
1.7.2-rc.0
1.7.1
1.7.0
1.7.0-rc.2
1.7.0-rc.1
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.5
1.5.0-rc.4
1.5.0-rc.3
1.5.0-rc.2
1.5.0-rc.1
1.4.1
1.4.0
1.4.0-rc.2
1.4.0-rc.1
1.3.2
1.3.1
1.3.0
1.3.0-rc3
1.3.0-rc2
1.3.0-rc1
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc4
1.2.0-rc3
1.2.0-rc2
1.2.0-rc1
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.1.0-rc3
1.1.0-rc2
1.1.0-rc1
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.1-rc1
1.0.0
1.0.0-rc1
0.10.2
0.10.1
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.9.0-rc8
0.9.0-rc7
0.9.0-rc6
0.9.0-rc5
0.9.0-rc4
0.9.0-rc3
0.9.0-rc2
0.9.0-rc1
0.8.10
0.8.9
0.8.8
0.8.7
0.8.6
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.8.0-rc7
0.8.0-rc6
0.8.0-rc5
0.8.0-rc4
0.8.0-rc3
0.8.0-rc2
0.8.0-rc1
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.1
0.6.0
0.6.0-rc2
0.6.0-rc1
0.5.3
0.5.2
0.5.1
0.5.0
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.10-dev
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-beta5
0.4.0-beta4
0.4.0-beta3
0.4.0-beta2
0.4.0-beta1
0.3.13
0.3.12
0.3.11
0.3.10
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.3.0-dev2
0.3.0-dev
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.1-dev
A static code analysis tool with a focus on code consistency and teaching.
Current section
Files
Jump to
Current section
Files
lib/credo/cli/output/ui.ex
defmodule Credo.CLI.Output.UI do
@moduledoc """
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
"""
@edge "┃"
@ellipsis "…"
@shell_service Credo.CLI.Output.Shell
if Mix.env() == :test do
def puts, do: nil
def puts(_), do: nil
def puts(_, color) when is_atom(color), do: nil
def warn(_), do: nil
else
defdelegate puts, to: @shell_service
defdelegate puts(v), to: @shell_service
def puts(v, color) when is_atom(color) do
@shell_service.puts([color, v])
end
defdelegate warn(v), to: @shell_service
end
def edge(color, indent \\ 2) when is_integer(indent) do
[:reset, color, @edge |> String.pad_trailing(indent)]
end
@doc "Returns the edge (`┃`) which is used in much of Credo's output as a binary."
def edge, do: @edge
def use_colors(exec) do
@shell_service.use_colors(exec.color)
exec
end
def puts_edge(color, indent \\ 2) when is_integer(indent) do
color
|> edge(indent)
|> puts
end
def wrap_at(text, number) do
"(?:((?>.{1,#{number}}(?:(?<=[^\\S\\r\\n])[^\\S\\r\\n]?|(?=\\r?\\n)|$|[^\\S\\r\\n]))|.{1,#{number}})(?:\\r?\\n)?|(?:\\r?\\n|$))"
|> Regex.compile!("u")
|> Regex.scan(text)
|> Enum.map(&List.first/1)
|> List.delete_at(-1)
end
@doc """
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 ..."
"""
def truncate(line, max_length) when max_length <= 0 or is_nil(line), do: ""
def truncate(line, max_length) when max_length > 0 do
truncate(line, max_length, @ellipsis)
end
def truncate(_line, max_length, _ellipsis) when max_length <= 0, do: ""
def truncate(line, max_length, ellipsis) when max_length > 0 do
cond do
String.length(line) <= max_length ->
line
String.length(ellipsis) >= max_length ->
ellipsis
true ->
chars_to_display = max_length - String.length(ellipsis)
String.slice(line, 0, chars_to_display) <> ellipsis
end
end
end