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
- .build_man_page(quiet:) ⇒ String private
- .cmd_comment_manpage_lines(cmd_path) ⇒ Array<String>? private
- .cmd_parser_manpage_lines(cmd_parser) ⇒ Array<String> private
- .env_vars_manpage ⇒ String private
- .format_opt(opt) ⇒ String? private
- .format_usage_banner(usage_banner) ⇒ String private
- .generate_cmd_manpages(cmd_paths) ⇒ String private
- .generate_option_doc(short, long, desc) ⇒ String private
- .global_cask_options_manpage ⇒ String private
- .global_options_manpage ⇒ String private
- .regenerate_man_pages(quiet:) ⇒ void private
- .sort_key_for_path(path) ⇒ String private
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.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'manpages.rb', line 50 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), official_external_commands: generate_cmd_manpages(Commands.official_external_commands_paths(quiet:)), global_cask_options: , global_options: , environment_variables: env_vars_manpage, lead: readme.read[/(Homebrew's \[Project Leader.*\.)/, 1] .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1'), plc: readme.read[/(Homebrew's \[Project Leadership Committee.*\.)/, 1] .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1'), tsc: readme.read[/(Homebrew's \[Technical Steering Committee.*\.)/, 1] .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1'), maintainers: readme.read[/(Homebrew's maintainers .*\.)/, 1] .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1'), alumni: readme.read[/(Former 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.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'manpages.rb', line 125 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 = [(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.
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'manpages.rb', line 105 def self.cmd_parser_manpage_lines(cmd_parser) lines = [] = cmd_parser. lines << () if lines += cmd_parser..filter_map do |short, long, desc, hidden| next if hidden if long.present? next if Homebrew::CLI::Parser..include?([short, long, desc]) next if Homebrew::CLI::Parser..any? do |_, option, kwargs| [long, "#{long}="].include?(option) && kwargs.fetch(:description) == desc end end generate_option_doc(short, long, desc) 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.
178 179 180 181 182 183 184 185 186 187 188 |
# File 'manpages.rb', line 178 def self.env_vars_manpage lines = Homebrew::EnvConfig::ENVS.flat_map do |env, hash| entry = "`#{env}`\n\n: #{hash[:description]}\n" default = hash[:default_text] default ||= "`#{hash[:default]}`." if hash[:default] 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.
191 192 193 |
# File 'manpages.rb', line 191 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.
213 214 215 216 |
# File 'manpages.rb', line 213 def self.() .sub(/^(#: *\* )?/, "### ") .gsub(/(?<!`)\[([^\[\]]*)\](?!`)/, "\\[\\1\\]") # escape [] character (except those in code spans) 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.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'manpages.rb', line 82 def self.generate_cmd_manpages(cmd_paths) man_page_lines = [] # preserve existing manpage order cmd_paths.sort_by { sort_key_for_path(_1) } .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.
202 203 204 205 206 207 208 209 210 |
# File 'manpages.rb', line 202 def self.generate_option_doc(short, long, desc) comma = (short && long) ? ", " : "" <<~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.
159 160 161 162 163 164 165 166 |
# File 'manpages.rb', line 159 def self. lines = ["These options are applicable to the `install`, `reinstall` and `upgrade` " \ "subcommands with the `--cask` switch.\n"] lines += Homebrew::CLI::Parser..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.
169 170 171 172 173 174 175 |
# File 'manpages.rb', line 169 def self. lines = ["These options are applicable across multiple subcommands.\n"] lines += Homebrew::CLI::Parser..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.
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
# File 'manpages.rb', line 30 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.
76 77 78 79 |
# File 'manpages.rb', line 76 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 |