76 lines
2.8 KiB
Ruby
76 lines
2.8 KiB
Ruby
# typed: strict
|
|
# frozen_string_literal: true
|
|
|
|
require "abstract_command"
|
|
require "descriptions"
|
|
require "search"
|
|
require "description_cache_store"
|
|
|
|
module Homebrew
|
|
module Cmd
|
|
class Desc < AbstractCommand
|
|
cmd_args do
|
|
description <<~EOS
|
|
Display <formula>'s name and one-line description.
|
|
The cache is created on the first search, making that search slower than subsequent ones.
|
|
EOS
|
|
switch "-s", "--search",
|
|
description: "Search both names and descriptions for <text>. If <text> is flanked by " \
|
|
"slashes, it is interpreted as a regular expression."
|
|
switch "-n", "--name",
|
|
description: "Search just names for <text>. If <text> is flanked by slashes, it is " \
|
|
"interpreted as a regular expression."
|
|
switch "-d", "--description",
|
|
description: "Search just descriptions for <text>. If <text> is flanked by slashes, " \
|
|
"it is interpreted as a regular expression."
|
|
switch "--eval-all",
|
|
description: "Evaluate all available formulae and casks, whether installed or not, to search their " \
|
|
"descriptions. Implied if `$HOMEBREW_EVAL_ALL` is set."
|
|
switch "--formula", "--formulae",
|
|
description: "Treat all named arguments as formulae."
|
|
switch "--cask", "--casks",
|
|
description: "Treat all named arguments as casks."
|
|
|
|
conflicts "--search", "--name", "--description"
|
|
|
|
named_args [:formula, :cask, :text_or_regex], min: 1
|
|
end
|
|
|
|
sig { override.void }
|
|
def run
|
|
search_type = if args.search?
|
|
:either
|
|
elsif args.name?
|
|
:name
|
|
elsif args.description?
|
|
:desc
|
|
end
|
|
|
|
if search_type.present?
|
|
if !args.eval_all? && !Homebrew::EnvConfig.eval_all? && Homebrew::EnvConfig.no_install_from_api?
|
|
raise UsageError, "`brew desc --search` needs `--eval-all` passed or `$HOMEBREW_EVAL_ALL` set!"
|
|
end
|
|
|
|
query = args.named.join(" ")
|
|
string_or_regex = Search.query_regexp(query)
|
|
return Search.search_descriptions(string_or_regex, args, search_type:)
|
|
end
|
|
|
|
desc = {}
|
|
args.named.to_formulae_and_casks.each do |formula_or_cask|
|
|
case formula_or_cask
|
|
when Formula
|
|
desc[formula_or_cask.full_name] = formula_or_cask.desc
|
|
when Cask::Cask
|
|
description = formula_or_cask.desc.presence || Formatter.warning("[no description]")
|
|
desc[formula_or_cask.full_name] = "(#{formula_or_cask.name.join(", ")}) #{description}"
|
|
else
|
|
raise TypeError, "Unsupported formula_or_cask type: #{formula_or_cask.class}"
|
|
end
|
|
end
|
|
Descriptions.new(desc).print
|
|
end
|
|
end
|
|
end
|
|
end
|