mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
4c012a41c6
This provides a decent speedup:
```
$ hyperfine 'git checkout master; brew help' 'git checkout help_bash; brew help'
Benchmark 1: git checkout master; brew help
Time (mean ± σ): 506.4 ms ± 50.9 ms [User: 223.7 ms, System: 99.9 ms]
Range (min … max): 454.6 ms … 634.1 ms 10 runs
Benchmark 2: git checkout help_bash; brew help
Time (mean ± σ): 109.5 ms ± 57.1 ms [User: 1
```
and compares favourably to `pip3 help`:
```
$ hyperfine 'brew help' 'pip3 help'
Benchmark 1: brew help
Time (mean ± σ): 72.9 ms ± 15.9 ms [User: 4.9 ms, System: 6.3 ms]
Range (min … max): 53.6 ms … 126.6 ms 31 runs
Benchmark 2: pip3 help
Time (mean ± σ): 171.5 ms ± 6.1 ms [User: 131.6 ms, System: 24.7 ms]
Range (min … max): 164.2 ms … 189.3 ms 15 runs
Summary
brew help ran
2.35 ± 0.52 times faster than pip3 help
```
96 lines
3.0 KiB
Ruby
96 lines
3.0 KiB
Ruby
# typed: true
|
|
# frozen_string_literal: true
|
|
|
|
require "cli/parser"
|
|
require "commands"
|
|
|
|
module Homebrew
|
|
# Helper module for printing help output.
|
|
module Help
|
|
def self.help(cmd = nil, empty_argv: false, usage_error: nil, remaining_args: [])
|
|
if cmd.nil?
|
|
# Handle `brew` (no arguments).
|
|
if empty_argv
|
|
$stderr.puts HOMEBREW_HELP_MESSAGE
|
|
exit 1
|
|
end
|
|
|
|
# Handle `brew (-h|--help|--usage|-?|help)` (no other arguments).
|
|
puts HOMEBREW_HELP_MESSAGE
|
|
exit 0
|
|
end
|
|
|
|
# Resolve command aliases and find file containing the implementation.
|
|
path = Commands.path(cmd)
|
|
|
|
# Display command-specific (or generic) help in response to `UsageError`.
|
|
if usage_error
|
|
$stderr.puts path ? command_help(cmd, path, remaining_args:) : HOMEBREW_HELP_MESSAGE
|
|
$stderr.puts
|
|
onoe usage_error
|
|
exit 1
|
|
end
|
|
|
|
# Resume execution in `brew.rb` for unknown commands.
|
|
return if path.nil?
|
|
|
|
# Display help for internal command (or generic help if undocumented).
|
|
puts command_help(cmd, path, remaining_args:)
|
|
exit 0
|
|
end
|
|
|
|
def self.command_help(cmd, path, remaining_args:)
|
|
# Only some types of commands can have a parser.
|
|
output = if Commands.valid_internal_cmd?(cmd) ||
|
|
Commands.valid_internal_dev_cmd?(cmd) ||
|
|
Commands.external_ruby_v2_cmd_path(cmd)
|
|
parser_help(path, remaining_args:)
|
|
end
|
|
|
|
output ||= comment_help(path)
|
|
|
|
output ||= if output.blank?
|
|
opoo "No help text in: #{path}" if Homebrew::EnvConfig.developer?
|
|
HOMEBREW_HELP_MESSAGE
|
|
end
|
|
|
|
output
|
|
end
|
|
private_class_method :command_help
|
|
|
|
def self.parser_help(path, remaining_args:)
|
|
# Let OptionParser generate help text for commands which have a parser.
|
|
cmd_parser = CLI::Parser.from_cmd_path(path)
|
|
return unless cmd_parser
|
|
|
|
# Try parsing arguments here in order to show formula options in help output.
|
|
cmd_parser.parse(remaining_args, ignore_invalid_options: true)
|
|
cmd_parser.generate_help_text
|
|
end
|
|
private_class_method :parser_help
|
|
|
|
def self.command_help_lines(path)
|
|
path.read
|
|
.lines
|
|
.grep(/^#:/)
|
|
.map { |line| line.slice(2..-1).delete_prefix(" ") }
|
|
end
|
|
private_class_method :command_help_lines
|
|
|
|
def self.comment_help(path)
|
|
# Otherwise read #: lines from the file.
|
|
help_lines = command_help_lines(path)
|
|
return if help_lines.blank?
|
|
|
|
Formatter.format_help_text(help_lines.join, width: Formatter::COMMAND_DESC_WIDTH)
|
|
.sub("@hide_from_man_page ", "")
|
|
.sub(/^\* /, "#{Tty.bold}Usage: brew#{Tty.reset} ")
|
|
.gsub(/`(.*?)`/m, "#{Tty.bold}\\1#{Tty.reset}")
|
|
.gsub(%r{<([^\s]+?://[^\s]+?)>}) { |url| Formatter.url(url) }
|
|
.gsub(/<(.*?)>/m, "#{Tty.underline}\\1#{Tty.reset}")
|
|
.gsub(/\*(.*?)\*/m, "#{Tty.underline}\\1#{Tty.reset}")
|
|
end
|
|
private_class_method :comment_help
|
|
end
|
|
end
|