admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #8450 from reitermarkus/document-help

Browse Source 
Refactor and document `Help`.
This commit is contained in:
Markus Reiter 2020-08-23 04:40:59 +02:00 committed by GitHub
commit 89b4b48e6c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
Library/Homebrew/help.rb
View File

@ -1,6 +1,19 @@
# frozen_string_literal: true
HOMEBREW_HELP = <<~EOS
require "cli/parser"
require "commands"
module Homebrew
# Helper module for printing help output.
#
# @api private
module Help
# NOTE: Keep the length of vanilla `--help` less than 25 lines!
# This is because the default Terminal height is 25 lines. Scrolling sucks
# and concision is important. If more help is needed we should start
# specialising help like the gem command does.
# NOTE: Keep lines less than 80 characters! Wrapping is just not cricket.
HOMEBREW_HELP = <<~EOS
Example usage:
brew search [TEXT|/REGEX/]
brew info [FORMULA...]
@ -24,20 +37,9 @@ HOMEBREW_HELP = <<~EOS
brew help [COMMAND]
man brew
https://docs.brew.sh
EOS
EOS
private_constant :HOMEBREW_HELP
# NOTE Keep the length of vanilla --help less than 25 lines!
# This is because the default Terminal height is 25 lines. Scrolling sucks
# and concision is important. If more help is needed we should start
# specialising help like the gem command does.
# NOTE Keep lines less than 80 characters! Wrapping is just not cricket.
# NOTE The reason the string is at the top is so 25 lines is easy to measure!
require "cli/parser"
require "commands"
module Homebrew
module Help
module_function
def help(cmd = nil, empty_argv: false, usage_error: nil, remaining_args: [])
@ -89,6 +91,7 @@ module Homebrew
output
end
private_class_method :command_help
def parser_help(path, remaining_args:)
# Let OptionParser generate help text for commands which have a parser.
@ -99,6 +102,7 @@ module Homebrew
cmd_parser.parse(remaining_args, ignore_invalid_options: true)
cmd_parser.generate_help_text
end
private_class_method :parser_help
def comment_help(path)
# Otherwise read #: lines from the file.
@ -113,5 +117,6 @@ module Homebrew
.gsub(/<(.*?)>/m, "#{Tty.underline}\\1#{Tty.reset}")
.gsub(/\*(.*?)\*/m, "#{Tty.underline}\\1#{Tty.reset}")
end
private_class_method :comment_help
end
end