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

Merge pull request #15148 from ZhongRuoyu/commands-command_description

Browse Source 
commands: explain change in command description splitting
This commit is contained in:
Mike McQuaid 2023-04-05 09:01:42 +01:00 committed by GitHub
commit 1c87b8e67a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Library/Homebrew/commands.rb
View File

@ -32,6 +32,11 @@ module Commands
"lc" => "livecheck", "lc" => "livecheck",
"tc" => "typecheck", "tc" => "typecheck",
}.freeze }.freeze
# This pattern is used to split descriptions at full stops. We only consider a
# dot as a full stop if it is either followed by a whitespace or at the end of
# the description. In this way we can prevent cutting off a sentence in the
# middle due to dots in URLs or paths.
DESCRIPTION_SPLITTING_PATTERN = /\.(?>\s|$)/.freeze
def valid_internal_cmd?(cmd) def valid_internal_cmd?(cmd)
require?(HOMEBREW_CMD_PATH/cmd) require?(HOMEBREW_CMD_PATH/cmd)
@ -203,7 +208,7 @@ module Commands
if (cmd_parser = Homebrew::CLI::Parser.from_cmd_path(path)) if (cmd_parser = Homebrew::CLI::Parser.from_cmd_path(path))
if short if short
cmd_parser.description.split(/\.(?>\s|$)/).first cmd_parser.description.split(DESCRIPTION_SPLITTING_PATTERN).first
else else
cmd_parser.description cmd_parser.description
end end
@ -215,7 +220,7 @@ module Commands
match_data = /^#: (?<desc>\w.*+)$/.match(line) match_data = /^#: (?<desc>\w.*+)$/.match(line)
if match_data if match_data
desc = match_data[:desc] desc = match_data[:desc]
return T.must(desc).split(".").first if short return T.must(desc).split(DESCRIPTION_SPLITTING_PATTERN).first if short
return desc return desc
end end