Module: Homebrew::Manpages Private

Defined in:
manpages.rb,
manpages/parser/ronn.rb,
manpages/converter/roff.rb,
manpages/converter/kramdown.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 functions for generating homebrew manual.

Defined Under Namespace

Modules: Converter, Parser Classes: Variables

Constant Summary collapse

SOURCE_PATH =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let((HOMEBREW_LIBRARY_PATH/"manpages").freeze, Pathname)
TARGET_MAN_PATH =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let((HOMEBREW_REPOSITORY/"manpages").freeze, Pathname)
TARGET_DOC_PATH =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let((HOMEBREW_REPOSITORY/"docs").freeze, Pathname)

Class Method Summary collapse

Class Method Details

.build_man_page(quiet:) ⇒ String

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.

Parameters:

  • quiet (Boolean)

Returns:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'manpages.rb', line 47

def self.build_man_page(quiet:)
  template = (SOURCE_PATH/"brew.1.md.erb").read
  readme = HOMEBREW_REPOSITORY/"README.md"
  variables = Variables.new(
    commands:              generate_cmd_manpages(Commands.internal_commands_paths),
    developer_commands:    generate_cmd_manpages(Commands.internal_developer_commands_paths),
    global_cask_options:   global_cask_options_manpage,
    global_options:        global_options_manpage,
    environment_variables: env_vars_manpage,
    project_leader:        readme.read[/(Homebrew's \[Project Leader.*\.)/, 1]
                                 .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1'),
    lead_maintainers:      readme.read[/(Homebrew's \[Lead Maintainers.*\.)/, 1]
                                 .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1'),
    security_team:         readme.read[/(Homebrew's \[Security Team.*\.)/, 1]
                                 .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1'),
    maintainers:           readme.read[/(Homebrew's other Maintainers .*\.)/, 1]
                                 .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1'),
  )

  ERB.new(template, trim_mode: ">").result(variables.instance_eval { binding })
end

.cmd_comment_manpage_lines(cmd_path) ⇒ Array<String>?

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.

Parameters:

Returns:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'manpages.rb', line 146

def self.cmd_comment_manpage_lines(cmd_path)
  comment_lines = cmd_path.read.lines.grep(/^#:/)
  return if comment_lines.empty?

  first_comment_line = comment_lines.first
  return unless first_comment_line
  return if first_comment_line.include?("@hide_from_man_page")

  lines = [format_usage_banner(first_comment_line).chomp]
  all_but_first_comment_lines = comment_lines.slice(1..-1)
  return unless all_but_first_comment_lines
  return if all_but_first_comment_lines.empty?

  all_but_first_comment_lines.each do |line|
    line = line.slice(4..-2)
    unless line
      lines.last << "\n"
      next
    end

    # Omit the common global_options documented separately in the man page.
    next if line.match?(/--(debug|help|quiet|verbose) /)

    # Format one option or a comma-separated pair of short and long options.
    line.gsub!(/^ +(-+[a-z-]+), (-+[a-z-]+) +(.*)$/, "`\\1`, `\\2`\n\n: \\3\n")
    line.gsub!(/^ +(-+[a-z-]+) +(.*)$/, "`\\1`\n\n: \\2\n")

    lines << line
  end
  lines.last << "\n"
  lines
end

.cmd_parser_manpage_lines(cmd_parser) ⇒ Array<String>

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.

Parameters:

Returns:



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
126
 
# File 'manpages.rb', line 99

def self.cmd_parser_manpage_lines(cmd_parser)
  lines = []
  if cmd_parser.subcommands.present?
    root_usage_banner_text = cmd_parser.root_usage_banner_text
    lines << "#{format_usage_banner(root_usage_banner_text)}\n\n" if root_usage_banner_text
    if (description = cmd_parser.description).present?
      lines << "#{description}\n\n"
    end

    root_options = cmd_parser.processed_options_for_root_command
    lines += option_manpage_lines(root_options)

    cmd_parser.subcommands.each do |subcommand|
      next if subcommand.hidden

      usage_banner = subcommand.usage_banner
      next if usage_banner.blank?

      lines << "#{format_usage_text(usage_banner)}\n\n"
      lines += option_manpage_lines(cmd_parser.processed_options_for_subcommand(subcommand.name) - root_options)
    end
  else
    usage_banner_text = cmd_parser.usage_banner_text
    lines << format_usage_banner(usage_banner_text) if usage_banner_text
    lines += option_manpage_lines(cmd_parser.processed_options)
  end
  lines
end

.env_vars_manpage ⇒ String

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.

Returns:



199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'manpages.rb', line 199

def self.env_vars_manpage
  lines = Homebrew::EnvConfig::ENVS.filter_map do |env, hash|
    next if Homebrew::EnvConfig.hidden?(hash)

    entry = "`#{env}`\n\n: #{hash[:description]}\n"
    default = Homebrew::EnvConfig.default_description(env)
    entry += "\n\n    *Default:* #{default}\n" if default

    entry
  end
  lines.join("\n")
end

.format_opt(opt) ⇒ String?

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.

Parameters:

Returns:



213
214
215
 
# File 'manpages.rb', line 213

def self.format_opt(opt)
  "`#{opt}`" unless opt.nil?
end

.format_usage_banner(usage_banner) ⇒ String

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.

Parameters:

Returns:



239
240
241
 
# File 'manpages.rb', line 239

def self.format_usage_banner(usage_banner)
  format_usage_text(usage_banner).sub(/^(?:#: *\* )?/, "### ")
end

.generate_cmd_manpages(cmd_paths) ⇒ String

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.

Parameters:

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'manpages.rb', line 76

def self.generate_cmd_manpages(cmd_paths)
  man_page_lines = []

  # preserve existing manpage order
  cmd_paths.sort_by { sort_key_for_path(it) }
           .each do |cmd_path|
    cmd_man_page_lines = if (cmd_parser = Homebrew::CLI::Parser.from_cmd_path(cmd_path))
      next if cmd_parser.hide_from_man_page

      cmd_parser_manpage_lines(cmd_parser).join
    else
      cmd_comment_manpage_lines(cmd_path)&.join("\n")
    end
    # Convert subcommands to definition lists
    cmd_man_page_lines&.gsub!(/(?<=\n\n)([\\?\[`].+):\n/, "\\1\n\n: ")

    man_page_lines << cmd_man_page_lines
  end

  man_page_lines.compact.join("\n")
end

.generate_option_doc(short, long, desc) ⇒ String

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.

Parameters:

Returns:



224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'manpages.rb', line 224

def self.generate_option_doc(short, long, desc)
  comma = if short && long
    ", "
  else
    ""
  end
  <<~EOS
    #{format_opt(short)}#{comma}#{format_opt(long)}

    : #{desc}

  EOS
end

.global_cask_options_manpage ⇒ String

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.

Returns:



180
181
182
183
184
185
186
187
 
# File 'manpages.rb', line 180

def self.global_cask_options_manpage
  lines = ["These options are applicable to the `install`, `reinstall` and `upgrade` " \
           "subcommands with the `--cask` switch.\n"]
  lines += Homebrew::CLI::Parser.global_cask_options.map do |_, long, kwargs|
    generate_option_doc(nil, long.chomp("="), kwargs.fetch(:description))
  end
  lines.join("\n")
end

.global_options_manpage ⇒ String

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.

Returns:



190
191
192
193
194
195
196
 
# File 'manpages.rb', line 190

def self.global_options_manpage
  lines = ["These options are applicable across multiple subcommands.\n"]
  lines += Homebrew::CLI::Parser.global_options.map do |short, long, desc|
    generate_option_doc(short, long, desc)
  end
  lines.join("\n")
end

.regenerate_man_pages(quiet:) ⇒ void

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.

This method returns an undefined value.

Parameters:

  • quiet (Boolean) 


27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'manpages.rb', line 27

def self.regenerate_man_pages(quiet:)
  require "kramdown"
  require "manpages/parser/ronn"
  require "manpages/converter/kramdown"
  require "manpages/converter/roff"

  markup = build_man_page(quiet:)
  root, warnings = Parser::Ronn.parse(markup)
  $stderr.puts(warnings)

  roff, warnings = Converter::Kramdown.convert(root)
  $stderr.puts(warnings)
  File.write(TARGET_DOC_PATH/"Manpage.md", roff)

  roff, warnings = Converter::Roff.convert(root)
  $stderr.puts(warnings)
  File.write(TARGET_MAN_PATH/"brew.1", roff)
end

.sort_key_for_path(path) ⇒ String

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.

Parameters:

Returns:



70
71
72
73
 
# File 'manpages.rb', line 70

def self.sort_key_for_path(path)
  # Options after regular commands (`~` comes after `z` in ASCII table).
  path.basename.to_s.sub(/\.(?:rb|sh)$/, "").sub(/^--/, "~~")
end