Class: Homebrew::CLI::Parser Private

Inherits:
Object
  • Object
show all
Includes:
Utils::Output::Mixin
Defined in:
cli/parser.rb

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils::Output::Mixin

#odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled

Constructor Details

#initialize(cmd = nil, &block) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'cli/parser.rb', line 151

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)
    odisabled(
      "`brew #{@command_name}'. This command needs to be refactored, as it is written in a style that",
      "subclassing of `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

Instance Attribute Details

#args ⇒ Args (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



29
30
31
 
# File 'cli/parser.rb', line 29

def args
  @args
end

#hide_from_man_page ⇒ Boolean (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (Boolean) 


35
36
37
 
# File 'cli/parser.rb', line 35

def hide_from_man_page
  @hide_from_man_page
end

#named_args_type ⇒ ArgType (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:

  • (ArgType) 


38
39
40
 
# File 'cli/parser.rb', line 38

def named_args_type
  @named_args_type
end

#processed_options ⇒ Args::OptionsType (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



32
33
34
 
# File 'cli/parser.rb', line 32

def processed_options
  @processed_options
end

Class Method Details

.from_cmd_path(cmd_path) ⇒ CLI::Parser?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'cli/parser.rb', line 41

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 Homebrew.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

.global_cask_options ⇒ Array<Array<(Symbol, String, Hash)>>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'cli/parser.rb', line 63

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

.global_options ⇒ Array<Array<(String, String, String)>>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



134
135
136
137
138
139
140
141
 
# File 'cli/parser.rb', line 134

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

.option_to_name(option) ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



144
145
146
 
# File 'cli/parser.rb', line 144

def self.option_to_name(option)
  option.sub(/\A--?(\[no-\])?/, "").tr("-", "_").delete("=")
end

Instance Method Details

#cask_options ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.



477
478
479
480
481
482
483
484
 
# File 'cli/parser.rb', line 477

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

#comma_array(name, description: nil, hidden: false) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • name (String)
  • description (String, nil) (defaults to: nil)
  • hidden (Boolean) (defaults to: false) 


278
279
280
281
282
283
284
285
 
# File 'cli/parser.rb', line 278

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

#conflicts(*options) ⇒ Array<Array<String>>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



329
330
331
 
# File 'cli/parser.rb', line 329

def conflicts(*options)
  @conflicts << options.map { |option| option_to_name(option) }
end

#description(text = nil) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • text (String, nil) (defaults to: nil)

Returns:



263
264
265
266
267
 
# File 'cli/parser.rb', line 263

def description(text = nil)
  return @description if text.blank?

  @description = text.chomp
end

#flag(*names, description: nil, replacement: nil, depends_on: nil, hidden: false) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • names (String)
  • description (String, nil) (defaults to: nil)
  • replacement (Symbol, String, nil) (defaults to: nil)
  • depends_on (String, nil) (defaults to: nil)
  • hidden (Boolean) (defaults to: false) 


291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'cli/parser.rb', line 291

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

#formula_options ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.



487
488
489
 
# File 'cli/parser.rb', line 487

def formula_options
  @formula_options = true
end

#generate_help_text ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



465
466
467
468
469
470
471
472
473
474
 
# File 'cli/parser.rb', line 465

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|
             T.must(underlined[1...-1]).gsub(/^(\s*)(.*?)$/, "\\1#{Tty.underline}\\2#{Tty.reset}")
           end
end

#hide_from_man_page! ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.



522
523
524
 
# File 'cli/parser.rb', line 522

def hide_from_man_page!
  @hide_from_man_page = true
end

#name_to_option(name) ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



337
338
339
340
341
342
343
 
# File 'cli/parser.rb', line 337

def name_to_option(name)
  if name.length == 1
    "-#{name}"
  else
    "--#{name.tr("_", "-")}"
  end
end

#named_args(type = nil, number: nil, min: nil, max: nil, without_api: false) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • type (ArgType) (defaults to: nil)
  • number (Integer, nil) (defaults to: nil)
  • min (Integer, nil) (defaults to: nil)
  • max (Integer, nil) (defaults to: nil)
  • without_api (Boolean) (defaults to: false)

Raises:

  • (ArgumentError) 


500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'cli/parser.rb', line 500

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

#option_description(description, *names, hidden: false) ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • description (String, nil)
  • names (String)
  • hidden (Boolean) (defaults to: false)

Returns:



351
352
353
354
355
356
 
# File 'cli/parser.rb', line 351

def option_description(description, *names, hidden: false)
  return HIDDEN_DESC_PLACEHOLDER if hidden
  return description if description.present?

  option_to_description(*names)
end

#option_to_description(*names) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



346
347
348
 
# File 'cli/parser.rb', line 346

def option_to_description(*names)
  names.map { |name| name.to_s.sub(/\A--?/, "").tr("-", " ") }.max
end

#option_to_name(option) ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



334
 
# File 'cli/parser.rb', line 334

def option_to_name(option) = self.class.option_to_name(option)

#parse(argv = ARGV.freeze, ignore_invalid_options: false) ⇒ Args

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • argv (Array<String>) (defaults to: ARGV.freeze)
  • ignore_invalid_options (Boolean) (defaults to: false)

Returns:



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'cli/parser.rb', line 398

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

#parse_remaining(argv, ignore_invalid_options: false) ⇒ Array<(Array<String>, Array<String>)>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • argv (Array<String>)
  • ignore_invalid_options (Boolean) (defaults to: false)

Returns:



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'cli/parser.rb', line 362

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

#set_args_method(name, value) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • name (Symbol)
  • value (T.untyped) 


318
319
320
321
322
323
324
325
326
 
# File 'cli/parser.rb', line 318

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

#set_default_options ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.



459
 
# File 'cli/parser.rb', line 459

def set_default_options; end

#switch(*names, description: nil, env: nil, depends_on: nil, method: :on, hidden: false, replacement: nil, odeprecated: false, odisabled: false, disable: false) ⇒ void Also known as: switch_option

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:

  • names (String)
  • description (String, nil) (defaults to: nil)
  • env (T.untyped) (defaults to: nil)
  • depends_on (String, nil) (defaults to: nil)
  • method (Symbol) (defaults to: :on)
  • hidden (Boolean) (defaults to: false)
  • replacement (String, false, nil) (defaults to: nil)
  • odeprecated (Boolean) (defaults to: false)
  • odisabled (Boolean) (defaults to: false)
  • disable (Boolean) (defaults to: false) 


210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'cli/parser.rb', line 210

def switch(*names, description: nil, env: nil,
           depends_on: nil, method: :on,
           hidden: false, replacement: nil,
           odeprecated: false, odisabled: false, disable: false)
  global_switch = names.first.is_a?(Symbol)
  return if global_switch

  if disable
    # this odeprecated should turn into odisabled in 5.1.0
    odeprecated "disable:", "odisabled:"
    odisabled = disable
  end
  if !odeprecated && !odisabled && replacement
    # this odeprecated should turn into odisabled in 5.1.0
    odeprecated "replacement: without :odeprecated or :odisabled",
                "replacement: with :odeprecated or :odisabled"
    odeprecated = true
  end
  hidden = true if odisabled || odeprecated

  description = option_description(description, *names, hidden:)
  env, counterpart = env
  if env && @non_global_processed_options.any?
    affix = counterpart ? " and `#{counterpart}` is passed." : "."
    description += " Enabled by default if `$HOMEBREW_#{env.upcase}` is set#{affix}"
  end
  if odeprecated || odisabled
    description += " (#{odisabled ? "disabled" : "deprecated"}#{"; replaced by #{replacement}" if replacement})"
  end
  process_option(*names, description, type: :switch, hidden:) unless odisabled

  @parser.public_send(method, *names, *wrap_option_desc(description)) do |value|
    # This odeprecated should stick around indefinitely.
    replacement_string = replacement if replacement
    if odeprecated || odisabled
      odeprecated "the `#{names.first}` switch", replacement_string, disable: odisabled
    end
    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)
  value = env_value&.present?
  set_switch(*names, value:, from: :env) unless value.nil?
end

#usage_banner(text) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:



270
271
272
 
# File 'cli/parser.rb', line 270

def usage_banner(text)
  @usage_banner, @description = text.chomp.split("\n\n", 2)
end

#usage_banner_text ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



275
 
# File 'cli/parser.rb', line 275

def usage_banner_text = @parser.banner

#validate_options ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.



462
 
# File 'cli/parser.rb', line 462

def validate_options; end