756 lines
26 KiB
Ruby
756 lines
26 KiB
Ruby
# typed: strict
|
|
# frozen_string_literal: true
|
|
|
|
require "abstract_command"
|
|
require "env_config"
|
|
require "cask/config"
|
|
require "cli/args"
|
|
require "cli/error"
|
|
require "commands"
|
|
require "optparse"
|
|
require "utils/tty"
|
|
require "utils/formatter"
|
|
|
|
module Homebrew
|
|
module CLI
|
|
class Parser
|
|
ArgType = T.type_alias { T.any(NilClass, Symbol, T::Array[String], T::Array[Symbol]) }
|
|
HIDDEN_DESC_PLACEHOLDER = "@@HIDDEN@@"
|
|
SYMBOL_TO_USAGE_MAPPING = T.let({
|
|
text_or_regex: "<text>|`/`<regex>`/`",
|
|
url: "<URL>",
|
|
}.freeze, T::Hash[Symbol, String])
|
|
private_constant :ArgType, :HIDDEN_DESC_PLACEHOLDER, :SYMBOL_TO_USAGE_MAPPING
|
|
|
|
sig { returns(Args) }
|
|
attr_reader :args
|
|
|
|
sig { returns(Args::OptionsType) }
|
|
attr_reader :processed_options
|
|
|
|
sig { returns(T::Boolean) }
|
|
attr_reader :hide_from_man_page
|
|
|
|
sig { returns(ArgType) }
|
|
attr_reader :named_args_type
|
|
|
|
sig { params(cmd_path: Pathname).returns(T.nilable(CLI::Parser)) }
|
|
def self.from_cmd_path(cmd_path)
|
|
cmd_args_method_name = Commands.args_method_name(cmd_path)
|
|
cmd_name = cmd_args_method_name.to_s.delete_suffix("_args").tr("_", "-")
|
|
|
|
begin
|
|
if require?(cmd_path)
|
|
cmd = Homebrew::AbstractCommand.command(cmd_name)
|
|
if cmd
|
|
cmd.parser
|
|
else
|
|
# FIXME: remove once commands are all subclasses of `AbstractCommand`:
|
|
Homebrew.send(cmd_args_method_name)
|
|
end
|
|
end
|
|
rescue NoMethodError => e
|
|
raise if e.name.to_sym != cmd_args_method_name
|
|
|
|
nil
|
|
end
|
|
end
|
|
|
|
sig { returns(T::Array[[Symbol, String, { description: String }]]) }
|
|
def self.global_cask_options
|
|
[
|
|
[:flag, "--appdir=", {
|
|
description: "Target location for Applications " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:appdir]}`).",
|
|
}],
|
|
[:flag, "--keyboard-layoutdir=", {
|
|
description: "Target location for Keyboard Layouts " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:keyboard_layoutdir]}`).",
|
|
}],
|
|
[:flag, "--colorpickerdir=", {
|
|
description: "Target location for Color Pickers " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:colorpickerdir]}`).",
|
|
}],
|
|
[:flag, "--prefpanedir=", {
|
|
description: "Target location for Preference Panes " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:prefpanedir]}`).",
|
|
}],
|
|
[:flag, "--qlplugindir=", {
|
|
description: "Target location for Quick Look Plugins " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:qlplugindir]}`).",
|
|
}],
|
|
[:flag, "--mdimporterdir=", {
|
|
description: "Target location for Spotlight Plugins " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:mdimporterdir]}`).",
|
|
}],
|
|
[:flag, "--dictionarydir=", {
|
|
description: "Target location for Dictionaries " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:dictionarydir]}`).",
|
|
}],
|
|
[:flag, "--fontdir=", {
|
|
description: "Target location for Fonts " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:fontdir]}`).",
|
|
}],
|
|
[:flag, "--servicedir=", {
|
|
description: "Target location for Services " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:servicedir]}`).",
|
|
}],
|
|
[:flag, "--input-methoddir=", {
|
|
description: "Target location for Input Methods " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:input_methoddir]}`).",
|
|
}],
|
|
[:flag, "--internet-plugindir=", {
|
|
description: "Target location for Internet Plugins " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:internet_plugindir]}`).",
|
|
}],
|
|
[:flag, "--audio-unit-plugindir=", {
|
|
description: "Target location for Audio Unit Plugins " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:audio_unit_plugindir]}`).",
|
|
}],
|
|
[:flag, "--vst-plugindir=", {
|
|
description: "Target location for VST Plugins " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:vst_plugindir]}`).",
|
|
}],
|
|
[:flag, "--vst3-plugindir=", {
|
|
description: "Target location for VST3 Plugins " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:vst3_plugindir]}`).",
|
|
}],
|
|
[:flag, "--screen-saverdir=", {
|
|
description: "Target location for Screen Savers " \
|
|
"(default: `#{Cask::Config::DEFAULT_DIRS[:screen_saverdir]}`).",
|
|
}],
|
|
[:comma_array, "--language", {
|
|
description: "Comma-separated list of language codes to prefer for cask installation. " \
|
|
"The first matching language is used, otherwise it reverts to the cask's " \
|
|
"default language. The default value is the language of your system.",
|
|
}],
|
|
]
|
|
end
|
|
|
|
sig { returns(T::Array[[String, String, String]]) }
|
|
def self.global_options
|
|
[
|
|
["-d", "--debug", "Display any debugging information."],
|
|
["-q", "--quiet", "Make some output more quiet."],
|
|
["-v", "--verbose", "Make some output more verbose."],
|
|
["-h", "--help", "Show this message."],
|
|
]
|
|
end
|
|
|
|
sig { params(option: String).returns(String) }
|
|
def self.option_to_name(option)
|
|
option.sub(/\A--?(\[no-\])?/, "").tr("-", "_").delete("=")
|
|
end
|
|
|
|
sig {
|
|
params(cmd: T.nilable(T.class_of(Homebrew::AbstractCommand)), block: T.nilable(T.proc.bind(Parser).void)).void
|
|
}
|
|
def initialize(cmd = nil, &block)
|
|
@parser = T.let(OptionParser.new, OptionParser)
|
|
@parser.summary_indent = " "
|
|
# Disable default handling of `--version` switch.
|
|
@parser.base.long.delete("version")
|
|
# Disable default handling of `--help` switch.
|
|
@parser.base.long.delete("help")
|
|
|
|
@args = T.let((cmd&.args_class || Args).new, Args)
|
|
|
|
if cmd
|
|
@command_name = T.let(cmd.command_name, String)
|
|
@is_dev_cmd = T.let(cmd.dev_cmd?, T::Boolean)
|
|
else
|
|
# FIXME: remove once commands are all subclasses of `AbstractCommand`:
|
|
# Filter out Sorbet runtime type checking method calls.
|
|
cmd_location = caller_locations.select do |location|
|
|
T.must(location.path).exclude?("/gems/sorbet-runtime-")
|
|
end.fetch(1)
|
|
@command_name = T.let(T.must(cmd_location.label).chomp("_args").tr("_", "-"), String)
|
|
@is_dev_cmd = T.let(T.must(cmd_location.absolute_path).start_with?(Commands::HOMEBREW_DEV_CMD_PATH),
|
|
T::Boolean)
|
|
odeprecated(
|
|
"`brew #{@command_name}'. This command needs to be refactored, as it is written in a style that",
|
|
"inherits from `Homebrew::AbstractCommand' ( see https://docs.brew.sh/External-Commands )",
|
|
disable_for_developers: false,
|
|
)
|
|
end
|
|
|
|
@constraints = T.let([], T::Array[[String, String]])
|
|
@conflicts = T.let([], T::Array[T::Array[String]])
|
|
@switch_sources = T.let({}, T::Hash[String, Symbol])
|
|
@processed_options = T.let([], Args::OptionsType)
|
|
@non_global_processed_options = T.let([], T::Array[[String, ArgType]])
|
|
@named_args_type = T.let(nil, T.nilable(ArgType))
|
|
@max_named_args = T.let(nil, T.nilable(Integer))
|
|
@min_named_args = T.let(nil, T.nilable(Integer))
|
|
@named_args_without_api = T.let(false, T::Boolean)
|
|
@description = T.let(nil, T.nilable(String))
|
|
@usage_banner = T.let(nil, T.nilable(String))
|
|
@hide_from_man_page = T.let(false, T::Boolean)
|
|
@formula_options = T.let(false, T::Boolean)
|
|
@cask_options = T.let(false, T::Boolean)
|
|
|
|
self.class.global_options.each do |short, long, desc|
|
|
switch short, long, description: desc, env: option_to_name(long), method: :on_tail
|
|
end
|
|
|
|
instance_eval(&block) if block
|
|
|
|
generate_banner
|
|
end
|
|
|
|
sig {
|
|
params(names: String, description: T.nilable(String), replacement: T.untyped, env: T.untyped,
|
|
depends_on: T.nilable(String), method: Symbol, hidden: T::Boolean, disable: T::Boolean).void
|
|
}
|
|
def switch(*names, description: nil, replacement: nil, env: nil, depends_on: nil,
|
|
method: :on, hidden: false, disable: false)
|
|
global_switch = names.first.is_a?(Symbol)
|
|
return if global_switch
|
|
|
|
description = option_description(description, *names, hidden:)
|
|
process_option(*names, description, type: :switch, hidden:) unless disable
|
|
|
|
if replacement || disable
|
|
description += " (#{disable ? "disabled" : "deprecated"}#{"; replaced by #{replacement}" if replacement})"
|
|
end
|
|
|
|
@parser.public_send(method, *names, *wrap_option_desc(description)) do |value|
|
|
# This odeprecated should stick around indefinitely.
|
|
odeprecated "the `#{names.first}` switch", replacement, disable: disable if !replacement.nil? || disable
|
|
value = true if names.none? { |name| name.start_with?("--[no-]") }
|
|
|
|
set_switch(*names, value:, from: :args)
|
|
end
|
|
|
|
names.each do |name|
|
|
set_constraints(name, depends_on:)
|
|
end
|
|
|
|
env_value = value_for_env(env)
|
|
set_switch(*names, value: env_value, from: :env) unless env_value.nil?
|
|
end
|
|
alias switch_option switch
|
|
|
|
sig { params(text: T.nilable(String)).returns(T.nilable(String)) }
|
|
def description(text = nil)
|
|
return @description if text.blank?
|
|
|
|
@description = text.chomp
|
|
end
|
|
|
|
sig { params(text: String).void }
|
|
def usage_banner(text)
|
|
@usage_banner, @description = text.chomp.split("\n\n", 2)
|
|
end
|
|
|
|
sig { returns(T.nilable(String)) }
|
|
def usage_banner_text = @parser.banner
|
|
|
|
sig { params(name: String, description: T.nilable(String), hidden: T::Boolean).void }
|
|
def comma_array(name, description: nil, hidden: false)
|
|
name = name.chomp "="
|
|
description = option_description(description, name, hidden:)
|
|
process_option(name, description, type: :comma_array, hidden:)
|
|
@parser.on(name, OptionParser::REQUIRED_ARGUMENT, Array, *wrap_option_desc(description)) do |list|
|
|
set_args_method(option_to_name(name).to_sym, list)
|
|
end
|
|
end
|
|
|
|
sig {
|
|
params(names: String, description: T.nilable(String), replacement: T.any(Symbol, String, NilClass),
|
|
depends_on: T.nilable(String), hidden: T::Boolean).void
|
|
}
|
|
def flag(*names, description: nil, replacement: nil, depends_on: nil, hidden: false)
|
|
required, flag_type = if names.any? { |name| name.end_with? "=" }
|
|
[OptionParser::REQUIRED_ARGUMENT, :required_flag]
|
|
else
|
|
[OptionParser::OPTIONAL_ARGUMENT, :optional_flag]
|
|
end
|
|
names.map! { |name| name.chomp "=" }
|
|
description = option_description(description, *names, hidden:)
|
|
if replacement.nil?
|
|
process_option(*names, description, type: flag_type, hidden:)
|
|
else
|
|
description += " (disabled#{"; replaced by #{replacement}" if replacement.present?})"
|
|
end
|
|
@parser.on(*names, *wrap_option_desc(description), required) do |option_value|
|
|
# This odisabled should stick around indefinitely.
|
|
odisabled "the `#{names.first}` flag", replacement unless replacement.nil?
|
|
names.each do |name|
|
|
set_args_method(option_to_name(name).to_sym, option_value)
|
|
end
|
|
end
|
|
|
|
names.each do |name|
|
|
set_constraints(name, depends_on:)
|
|
end
|
|
end
|
|
|
|
sig { params(name: Symbol, value: T.untyped).void }
|
|
def set_args_method(name, value)
|
|
@args.set_arg(name, value)
|
|
return if @args.respond_to?(name)
|
|
|
|
@args.define_singleton_method(name) do
|
|
# We cannot reference the ivar directly due to https://github.com/sorbet/sorbet/issues/8106
|
|
instance_variable_get(:@table).fetch(name)
|
|
end
|
|
end
|
|
|
|
sig { params(options: String).returns(T::Array[T::Array[String]]) }
|
|
def conflicts(*options)
|
|
@conflicts << options.map { |option| option_to_name(option) }
|
|
end
|
|
|
|
sig { params(option: String).returns(String) }
|
|
def option_to_name(option) = self.class.option_to_name(option)
|
|
|
|
sig { params(name: String).returns(String) }
|
|
def name_to_option(name)
|
|
if name.length == 1
|
|
"-#{name}"
|
|
else
|
|
"--#{name.tr("_", "-")}"
|
|
end
|
|
end
|
|
|
|
sig { params(names: String).returns(T.nilable(String)) }
|
|
def option_to_description(*names)
|
|
names.map { |name| name.to_s.sub(/\A--?/, "").tr("-", " ") }.max
|
|
end
|
|
|
|
sig { params(description: T.nilable(String), names: String, hidden: T::Boolean).returns(String) }
|
|
def option_description(description, *names, hidden: false)
|
|
return HIDDEN_DESC_PLACEHOLDER if hidden
|
|
return description if description.present?
|
|
|
|
option_to_description(*names)
|
|
end
|
|
|
|
sig {
|
|
params(argv: T::Array[String], ignore_invalid_options: T::Boolean)
|
|
.returns([T::Array[String], T::Array[String]])
|
|
}
|
|
def parse_remaining(argv, ignore_invalid_options: false)
|
|
i = 0
|
|
remaining = []
|
|
|
|
argv, non_options = split_non_options(argv)
|
|
allow_commands = Array(@named_args_type).include?(:command)
|
|
|
|
while i < argv.count
|
|
begin
|
|
begin
|
|
arg = argv[i]
|
|
|
|
remaining << arg unless @parser.parse([arg]).empty?
|
|
rescue OptionParser::MissingArgument
|
|
raise if i + 1 >= argv.count
|
|
|
|
args = argv[i..(i + 1)]
|
|
@parser.parse(args)
|
|
i += 1
|
|
end
|
|
rescue OptionParser::InvalidOption
|
|
if ignore_invalid_options || (allow_commands && Commands.path(arg))
|
|
remaining << arg
|
|
else
|
|
$stderr.puts generate_help_text
|
|
raise
|
|
end
|
|
end
|
|
|
|
i += 1
|
|
end
|
|
|
|
[remaining, non_options]
|
|
end
|
|
|
|
sig { params(argv: T::Array[String], ignore_invalid_options: T::Boolean).returns(Args) }
|
|
def parse(argv = ARGV.freeze, ignore_invalid_options: false)
|
|
raise "Arguments were already parsed!" if @args_parsed
|
|
|
|
# If we accept formula options, but the command isn't scoped only
|
|
# to casks, parse once allowing invalid options so we can get the
|
|
# remaining list containing formula names.
|
|
if @formula_options && !only_casks?(argv)
|
|
remaining, non_options = parse_remaining(argv, ignore_invalid_options: true)
|
|
|
|
argv = [*remaining, "--", *non_options]
|
|
|
|
formulae(argv).each do |f|
|
|
next if f.options.empty?
|
|
|
|
f.options.each do |o|
|
|
name = o.flag
|
|
description = "`#{f.name}`: #{o.description}"
|
|
if name.end_with? "="
|
|
flag(name, description:)
|
|
else
|
|
switch name, description:
|
|
end
|
|
|
|
conflicts "--cask", name
|
|
end
|
|
end
|
|
end
|
|
|
|
remaining, non_options = parse_remaining(argv, ignore_invalid_options:)
|
|
|
|
named_args = if ignore_invalid_options
|
|
[]
|
|
else
|
|
remaining + non_options
|
|
end
|
|
|
|
unless ignore_invalid_options
|
|
unless @is_dev_cmd
|
|
set_default_options
|
|
validate_options
|
|
end
|
|
check_constraint_violations
|
|
check_named_args(named_args)
|
|
end
|
|
|
|
@args.freeze_named_args!(named_args, cask_options: @cask_options, without_api: @named_args_without_api)
|
|
@args.freeze_remaining_args!(non_options.empty? ? remaining : [*remaining, "--", non_options])
|
|
@args.freeze_processed_options!(@processed_options)
|
|
@args.freeze
|
|
|
|
@args_parsed = T.let(true, T.nilable(TrueClass))
|
|
|
|
if !ignore_invalid_options && @args.help?
|
|
puts generate_help_text
|
|
exit
|
|
end
|
|
|
|
@args
|
|
end
|
|
|
|
sig { void }
|
|
def set_default_options; end
|
|
|
|
sig { void }
|
|
def validate_options; end
|
|
|
|
sig { returns(String) }
|
|
def generate_help_text
|
|
Formatter.format_help_text(@parser.to_s, width: Formatter::COMMAND_DESC_WIDTH)
|
|
.gsub(/\n.*?@@HIDDEN@@.*?(?=\n)/, "")
|
|
.sub(/^/, "#{Tty.bold}Usage: brew#{Tty.reset} ")
|
|
.gsub(/`(.*?)`/m, "#{Tty.bold}\\1#{Tty.reset}")
|
|
.gsub(%r{<([^\s]+?://[^\s]+?)>}) { |url| Formatter.url(url) }
|
|
.gsub(/\*(.*?)\*|<(.*?)>/m) do |underlined|
|
|
underlined[1...-1].gsub(/^(\s*)(.*?)$/, "\\1#{Tty.underline}\\2#{Tty.reset}")
|
|
end
|
|
end
|
|
|
|
sig { void }
|
|
def cask_options
|
|
self.class.global_cask_options.each do |args|
|
|
options = T.cast(args.pop, T::Hash[Symbol, String])
|
|
send(*args, **options)
|
|
conflicts "--formula", args[1]
|
|
end
|
|
@cask_options = true
|
|
end
|
|
|
|
sig { void }
|
|
def formula_options
|
|
@formula_options = true
|
|
end
|
|
|
|
sig {
|
|
params(
|
|
type: ArgType,
|
|
number: T.nilable(Integer),
|
|
min: T.nilable(Integer),
|
|
max: T.nilable(Integer),
|
|
without_api: T::Boolean,
|
|
).void
|
|
}
|
|
def named_args(type = nil, number: nil, min: nil, max: nil, without_api: false)
|
|
raise ArgumentError, "Do not specify both `number` and `min` or `max`" if number && (min || max)
|
|
|
|
if type == :none && (number || min || max)
|
|
raise ArgumentError, "Do not specify both `number`, `min` or `max` with `named_args :none`"
|
|
end
|
|
|
|
@named_args_type = type
|
|
|
|
if type == :none
|
|
@max_named_args = 0
|
|
elsif number
|
|
@min_named_args = @max_named_args = number
|
|
elsif min || max
|
|
@min_named_args = min
|
|
@max_named_args = max
|
|
end
|
|
|
|
@named_args_without_api = without_api
|
|
end
|
|
|
|
sig { void }
|
|
def hide_from_man_page!
|
|
@hide_from_man_page = true
|
|
end
|
|
|
|
private
|
|
|
|
sig { returns(String) }
|
|
def generate_usage_banner
|
|
command_names = ["`#{@command_name}`"]
|
|
aliases_to_skip = %w[instal uninstal]
|
|
command_names += Commands::HOMEBREW_INTERNAL_COMMAND_ALIASES.filter_map do |command_alias, command|
|
|
next if aliases_to_skip.include? command_alias
|
|
|
|
"`#{command_alias}`" if command == @command_name
|
|
end.sort
|
|
|
|
options = if @non_global_processed_options.empty?
|
|
""
|
|
elsif @non_global_processed_options.count > 2
|
|
" [<options>]"
|
|
else
|
|
required_argument_types = [:required_flag, :comma_array]
|
|
@non_global_processed_options.map do |option, type|
|
|
next " [`#{option}=`]" if required_argument_types.include? type
|
|
|
|
" [`#{option}`]"
|
|
end.join
|
|
end
|
|
|
|
named_args = ""
|
|
if @named_args_type.present? && @named_args_type != :none
|
|
arg_type = if @named_args_type.is_a? Array
|
|
types = @named_args_type.filter_map do |type|
|
|
next unless type.is_a? Symbol
|
|
next SYMBOL_TO_USAGE_MAPPING[type] if SYMBOL_TO_USAGE_MAPPING.key?(type)
|
|
|
|
"<#{type}>"
|
|
end
|
|
types << "<subcommand>" if @named_args_type.any?(String)
|
|
types.join("|")
|
|
elsif SYMBOL_TO_USAGE_MAPPING.key? @named_args_type
|
|
SYMBOL_TO_USAGE_MAPPING[@named_args_type]
|
|
else
|
|
"<#{@named_args_type}>"
|
|
end
|
|
|
|
named_args = if @min_named_args.nil? && @max_named_args == 1
|
|
" [#{arg_type}]"
|
|
elsif @min_named_args.nil?
|
|
" [#{arg_type} ...]"
|
|
elsif @min_named_args == 1 && @max_named_args == 1
|
|
" #{arg_type}"
|
|
elsif @min_named_args == 1
|
|
" #{arg_type} [...]"
|
|
else
|
|
" #{arg_type} ..."
|
|
end
|
|
end
|
|
|
|
"#{command_names.join(", ")}#{options}#{named_args}"
|
|
end
|
|
|
|
sig { returns(String) }
|
|
def generate_banner
|
|
@usage_banner ||= generate_usage_banner
|
|
|
|
@parser.banner = <<~BANNER
|
|
#{@usage_banner}
|
|
|
|
#{@description}
|
|
|
|
BANNER
|
|
end
|
|
|
|
sig { params(names: String, value: T.untyped, from: Symbol).void }
|
|
def set_switch(*names, value:, from:)
|
|
names.each do |name|
|
|
@switch_sources[option_to_name(name)] = from
|
|
set_args_method(:"#{option_to_name(name)}?", value)
|
|
end
|
|
end
|
|
|
|
sig { params(args: String).void }
|
|
def disable_switch(*args)
|
|
args.each do |name|
|
|
result = if name.start_with?("--[no-]")
|
|
nil
|
|
else
|
|
false
|
|
end
|
|
set_args_method(:"#{option_to_name(name)}?", result)
|
|
end
|
|
end
|
|
|
|
sig { params(name: String).returns(T::Boolean) }
|
|
def option_passed?(name)
|
|
[name.to_sym, :"#{name}?"].any? do |method|
|
|
@args.public_send(method) if @args.respond_to?(method)
|
|
end
|
|
end
|
|
|
|
sig { params(desc: String).returns(T::Array[String]) }
|
|
def wrap_option_desc(desc)
|
|
Formatter.format_help_text(desc, width: Formatter::OPTION_DESC_WIDTH).split("\n")
|
|
end
|
|
|
|
sig { params(name: String, depends_on: T.nilable(String)).returns(T.nilable(T::Array[[String, String]])) }
|
|
def set_constraints(name, depends_on:)
|
|
return if depends_on.nil?
|
|
|
|
primary = option_to_name(depends_on)
|
|
secondary = option_to_name(name)
|
|
@constraints << [primary, secondary]
|
|
end
|
|
|
|
sig { void }
|
|
def check_constraints
|
|
@constraints.each do |primary, secondary|
|
|
primary_passed = option_passed?(primary)
|
|
secondary_passed = option_passed?(secondary)
|
|
|
|
next if !secondary_passed || (primary_passed && secondary_passed)
|
|
|
|
primary = name_to_option(primary)
|
|
secondary = name_to_option(secondary)
|
|
|
|
raise OptionConstraintError.new(primary, secondary, missing: true)
|
|
end
|
|
end
|
|
|
|
sig { void }
|
|
def check_conflicts
|
|
@conflicts.each do |mutually_exclusive_options_group|
|
|
violations = mutually_exclusive_options_group.select do |option|
|
|
option_passed? option
|
|
end
|
|
|
|
next if violations.count < 2
|
|
|
|
env_var_options = violations.select do |option|
|
|
@switch_sources[option_to_name(option)] == :env
|
|
end
|
|
|
|
select_cli_arg = violations.count - env_var_options.count == 1
|
|
raise OptionConflictError, violations.map { name_to_option(_1) } unless select_cli_arg
|
|
|
|
env_var_options.each { disable_switch(_1) }
|
|
end
|
|
end
|
|
|
|
sig { void }
|
|
def check_invalid_constraints
|
|
@conflicts.each do |mutually_exclusive_options_group|
|
|
@constraints.each do |p, s|
|
|
next unless Set[p, s].subset?(Set[*mutually_exclusive_options_group])
|
|
|
|
raise InvalidConstraintError.new(p, s)
|
|
end
|
|
end
|
|
end
|
|
|
|
sig { void }
|
|
def check_constraint_violations
|
|
check_invalid_constraints
|
|
check_conflicts
|
|
check_constraints
|
|
end
|
|
|
|
sig { params(args: T::Array[String]).void }
|
|
def check_named_args(args)
|
|
types = Array(@named_args_type).filter_map do |type|
|
|
next type if type.is_a? Symbol
|
|
|
|
:subcommand
|
|
end.uniq
|
|
|
|
exception = if @min_named_args && @max_named_args && @min_named_args == @max_named_args &&
|
|
args.size != @max_named_args
|
|
NumberOfNamedArgumentsError.new(@min_named_args, types:)
|
|
elsif @min_named_args && args.size < @min_named_args
|
|
MinNamedArgumentsError.new(@min_named_args, types:)
|
|
elsif @max_named_args && args.size > @max_named_args
|
|
MaxNamedArgumentsError.new(@max_named_args, types:)
|
|
end
|
|
|
|
raise exception if exception
|
|
end
|
|
|
|
sig { params(args: String, type: Symbol, hidden: T::Boolean).void }
|
|
def process_option(*args, type:, hidden: false)
|
|
option, = @parser.make_switch(args)
|
|
@processed_options.reject! { |existing| existing.second == option.long.first } if option.long.first.present?
|
|
@processed_options << [option.short.first, option.long.first, option.desc.first, hidden]
|
|
|
|
args.pop # last argument is the description
|
|
if type == :switch
|
|
disable_switch(*args)
|
|
else
|
|
args.each do |name|
|
|
set_args_method(option_to_name(name).to_sym, nil)
|
|
end
|
|
end
|
|
|
|
return if hidden
|
|
return if self.class.global_options.include? [option.short.first, option.long.first, option.desc.first]
|
|
|
|
@non_global_processed_options << [option.long.first || option.short.first, type]
|
|
end
|
|
|
|
sig { params(argv: T::Array[String]).returns([T::Array[String], T::Array[String]]) }
|
|
def split_non_options(argv)
|
|
if (sep = argv.index("--"))
|
|
[argv.take(sep), argv.drop(sep + 1)]
|
|
else
|
|
[argv, []]
|
|
end
|
|
end
|
|
|
|
sig { params(argv: T::Array[String]).returns(T::Array[Formula]) }
|
|
def formulae(argv)
|
|
argv, non_options = split_non_options(argv)
|
|
|
|
named_args = argv.reject { |arg| arg.start_with?("-") } + non_options
|
|
spec = if argv.include?("--HEAD")
|
|
:head
|
|
else
|
|
:stable
|
|
end
|
|
|
|
# Only lowercase names, not paths, bottle filenames or URLs
|
|
named_args.filter_map do |arg|
|
|
next if arg.match?(HOMEBREW_CASK_TAP_CASK_REGEX)
|
|
|
|
begin
|
|
Formulary.factory(arg, spec, flags: argv.select { |a| a.start_with?("--") })
|
|
rescue FormulaUnavailableError, FormulaSpecificationError
|
|
nil
|
|
end
|
|
end.uniq(&:name)
|
|
end
|
|
|
|
sig { params(argv: T::Array[String]).returns(T::Boolean) }
|
|
def only_casks?(argv)
|
|
argv.include?("--casks") || argv.include?("--cask")
|
|
end
|
|
|
|
sig { params(env: T.any(NilClass, String, Symbol)).returns(T.untyped) }
|
|
def value_for_env(env)
|
|
return if env.blank?
|
|
|
|
method_name = :"#{env}?"
|
|
if Homebrew::EnvConfig.respond_to?(method_name)
|
|
Homebrew::EnvConfig.public_send(method_name)
|
|
else
|
|
ENV.fetch("HOMEBREW_#{env.upcase}", nil)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
require "extend/os/parser"
|