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

cli_parser: improve help text formatting

Browse Source 
- reduce desc_line_length so `brew help` output fits in 80 columns
- support special formatting across line breaks
- support emphasis using asterisks
- add missing depends_on: tests
This commit is contained in:
EricFromCanada 2018-10-06 22:52:47 -04:00
parent 662641557e
commit 6b8724431f
3 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Library/Homebrew/cli_parser.rb
View File

@ -28,13 +28,13 @@ module Homebrew
@constraints = []
@conflicts = []
@processed_options = []
@desc_line_length = 48
@desc_line_length = 43
instance_eval(&block)
post_initialize
end
def post_initialize
@parser.on_tail("-h", "--help", "Show this message") do
@parser.on_tail("-h", "--help", "Show this message.") do
puts generate_help_text
exit 0
end
@ -127,9 +127,10 @@ module Homebrew
def generate_help_text
@parser.to_s.sub(/^/, "#{Tty.bold}Usage: brew#{Tty.reset} ")
.gsub(/`(.*?)`/, "#{Tty.bold}\\1#{Tty.reset}")
.gsub(/`(.*?)`/m, "#{Tty.bold}\\1#{Tty.reset}")
.gsub(%r{<([^\s]+?://[^\s]+?)>}) { |url| Formatter.url(url) }
.gsub(/<(.*?)>/, "#{Tty.underline}\\1#{Tty.reset}")
.gsub(/<(.*?)>/m, "#{Tty.underline}\\1#{Tty.reset}")
.gsub(/\*(.*?)\*/m, "#{Tty.underline}\\1#{Tty.reset}")
end
private

1
Library/Homebrew/help.rb
View File

@ -93,6 +93,7 @@ module Homebrew
.gsub(/`(.*?)`/, "#{Tty.bold}\\1#{Tty.reset}")
.gsub(%r{<([^\s]+?://[^\s]+?)>}) { |url| Formatter.url(url) }
.gsub(/<(.*?)>/, "#{Tty.underline}\\1#{Tty.reset}")
.gsub(/\*(.*?)\*/, "#{Tty.underline}\\1#{Tty.reset}")
.gsub("@hide_from_man_page", "")
end.join.strip
end

2
Library/Homebrew/test/cli_parser_spec.rb
View File

@ -89,6 +89,7 @@ describe Homebrew::CLI::Parser do
it "raises exception on depends_on constraint violation" do
expect { parser.parse(["--flag2=flag2"]) }.to raise_error(Homebrew::CLI::OptionConstraintError)
expect { parser.parse(["--flag4=flag4"]) }.to raise_error(Homebrew::CLI::OptionConstraintError)
end
it "raises exception for conflict violation" do
@ -139,6 +140,7 @@ describe Homebrew::CLI::Parser do
it "raises exception on depends_on constraint violation" do
expect { parser.parse(["--switch-c"]) }.to raise_error(Homebrew::CLI::OptionConstraintError)
expect { parser.parse(["--switch-d"]) }.to raise_error(Homebrew::CLI::OptionConstraintError)
end
it "raises exception for conflict violation" do