Module: Formatter Private
- Defined in:
- utils/formatter.rb
Overview
This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.
Helper module for formatting output.
Class Method Summary collapse
-
.arrow(string, color: nil) ⇒ Object
private
-
.columns(*objects, gap_size: 2) ⇒ Object
private
-
.error(string, label: nil) ⇒ Object
private
-
.format_help_text(string, width: 172) ⇒ Object
private
Wraps text to fit within a given number of columns using regular expressions that:.
-
.headline(string, color: nil) ⇒ Object
private
-
.identifier(string) ⇒ Object
private
-
.option(string) ⇒ Object
private
-
.success(string, label: nil) ⇒ Object
private
-
.url(string) ⇒ Object
private
-
.warning(string, label: nil) ⇒ Object
private
Class Method Details
.arrow(string, color: nil) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
10 11 12 |
# File 'utils/formatter.rb', line 10 def self.arrow(string, color: nil) prefix("==>", string, color) end |
.columns(*objects, gap_size: 2) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'utils/formatter.rb', line 84 def self.columns(*objects, gap_size: 2) objects = objects.flatten.map(&:to_s) fallback = proc do return objects.join("\n").concat("\n") end fallback.call if objects.empty? fallback.call if respond_to?(:tty?) ? !T.unsafe(self).tty? : !$stdout.tty? console_width = Tty.width object_lengths = objects.map { |obj| Tty.strip_ansi(obj).length } cols = (console_width + gap_size) / (T.must(object_lengths.max) + gap_size) fallback.call if cols < 2 rows = (objects.count + cols - 1) / cols cols = (objects.count + rows - 1) / rows # avoid empty trailing columns col_width = ((console_width + gap_size) / cols) - gap_size gap_string = "".rjust(gap_size) output = +"" rows.times do |row_index| item_indices_for_row = T.cast(row_index.step(objects.size - 1, rows).to_a, T::Array[Integer]) first_n = T.must(item_indices_for_row[0...-1]).map do |index| objects[index] + "".rjust(col_width - object_lengths.fetch(index)) end # don't add trailing whitespace to last column last = objects.values_at(item_indices_for_row.fetch(-1)) output.concat((first_n + last) .join(gap_string)) .concat("\n") end output.freeze end |
.error(string, label: nil) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
34 35 36 |
# File 'utils/formatter.rb', line 34 def self.error(string, label: nil) label(label, string, :red) end |
.format_help_text(string, width: 172) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Wraps text to fit within a given number of columns using regular expressions that:
- convert hard-wrapped paragraphs to a single line
- add line break and indent to subcommand descriptions
- find any option descriptions longer than a pre-set length and wrap between words with a hanging indent, without breaking any words that overflow
- wrap any remaining description lines that need wrapping with the same indent
- wrap all lines to the given width.
Note that an option (e.g. --foo
) may not be at the beginning of a line,
so we always wrap one word before an option.
51 52 53 54 55 56 57 58 59 |
# File 'utils/formatter.rb', line 51 def self.format_help_text(string, width: 172) desc = OPTION_DESC_WIDTH indent = width - desc string.gsub(/(?<=\S) *\n(?=\S)/, " ") .gsub(/([`>)\]]:) /, "\\1\n ") .gsub(/^( +-.+ +(?=\S.{#{desc}}))(.{1,#{desc}})( +|$)(?!-)\n?/, "\\1\\2\n#{" " * indent}") .gsub(/^( {#{indent}}(?=\S.{#{desc}}))(.{1,#{desc}})( +|$)(?!-)\n?/, "\\1\\2\n#{" " * indent}") .gsub(/(.{1,#{width}})( +|$)(?!-)\n?/, "\\1\n") end |
.headline(string, color: nil) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
14 15 16 |
# File 'utils/formatter.rb', line 14 def self.headline(string, color: nil) arrow("#{Tty.bold}#{string}#{Tty.reset}", color: color) end |
.identifier(string) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
18 19 20 |
# File 'utils/formatter.rb', line 18 def self.identifier(string) "#{Tty.green}#{string}#{Tty.default}" end |
.option(string) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
22 23 24 |
# File 'utils/formatter.rb', line 22 def self.option(string) "#{Tty.bold}#{string}#{Tty.reset}" end |
.success(string, label: nil) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
26 27 28 |
# File 'utils/formatter.rb', line 26 def self.success(string, label: nil) label(label, string, :green) end |
.url(string) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
61 62 63 |
# File 'utils/formatter.rb', line 61 def self.url(string) "#{Tty.underline}#{string}#{Tty.no_underline}" end |
.warning(string, label: nil) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
30 31 32 |
# File 'utils/formatter.rb', line 30 def self.warning(string, label: nil) label(label, string, :yellow) end |