Credo.CLI.Output (Credo v1.6.0) View Source

This module provides helper functions regarding command line output.

Link to this section Summary

Functions

check_color(category)

check_tag(category, in_parens \\ true)

complain_about_invalid_source_files(invalid_source_files)

complain_about_timed_out_source_files(large_source_files)

foreground_color(background_color)

Returns a suitable foreground color for a given background_color.

issue_color(issue_or_priority)

Returns a suitable color for a given priority.

print_skipped_checks(execution)

priority_arrow(issue_or_priority)

Returns a suitable arrow for a given priority.

priority_name(issue_or_priority)

Returns a suitable name for a given priority.

term_columns(default \\ 80)

Link to this section Functions

check_color(category)

check_tag(category, in_parens \\ true)

complain_about_invalid_source_files(invalid_source_files)

complain_about_timed_out_source_files(large_source_files)

foreground_color(background_color)

Returns a suitable foreground color for a given background_color.

iex> Credo.CLI.Output.foreground_color(:yellow)
:black

iex> Credo.CLI.Output.foreground_color(:blue)
:white

issue_color(issue_or_priority)

Returns a suitable color for a given priority.

iex> Credo.CLI.Output.issue_color(%Credo.Issue{priority: :higher})
:red

iex> Credo.CLI.Output.issue_color(%Credo.Issue{priority: 20})
:red

print_skipped_checks(execution)

priority_arrow(issue_or_priority)

Returns a suitable arrow for a given priority.

iex> Credo.CLI.Output.priority_arrow(:high)
"↗"

iex> Credo.CLI.Output.priority_arrow(10)
"↗"

iex> Credo.CLI.Output.priority_arrow(%Credo.Issue{priority: 10})
"↗"

priority_name(issue_or_priority)

Returns a suitable name for a given priority.

iex> Credo.CLI.Output.priority_name(:normal)
"normal"

iex> Credo.CLI.Output.priority_name(1)
"normal"

iex> Credo.CLI.Output.priority_name(%Credo.Issue{priority: 1})
"normal"

term_columns(default \\ 80)