Class: Homebrew::CLI::Parser::Subcommand Private

Inherits:

T::Struct

• Object
• T::Struct
• Homebrew::CLI::Parser::Subcommand

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

• #aliases ⇒ Array<String> readonly private

  Returns the value of prop aliases.

• #default ⇒ Boolean readonly private

  Returns the value of prop default.

• #description ⇒ String^? private

  Returns the value of prop description.

• #max_named_args ⇒ Integer^? private

  Returns the value of prop max_named_args.

• #min_named_args ⇒ Integer^? private

  Returns the value of prop min_named_args.

• #name ⇒ String readonly private

  Returns the value of prop name.

• #named_args_type ⇒ ArgType private

  Returns the value of prop named_args_type.

• #named_args_without_api ⇒ Boolean private

  Returns the value of prop named_args_without_api.

• #usage_banner ⇒ String^? private

  Returns the value of prop usage_banner.

Instance Method Summary

• #initialize(name:, aliases: [], description: nil, usage_banner: nil, default: false, named_args_type: nil, max_named_args: nil, min_named_args: nil, named_args_without_api: false) ⇒ void constructor

Constructor Details

#initialize(name:, aliases: [], description: nil, usage_banner: nil, default: false, named_args_type: nil, max_named_args: nil, min_named_args: nil, named_args_without_api: false) ⇒ void

Parameters:

• name (String)
• aliases (Array<String>) (defaults to: [])
• description (String, nil) (defaults to: nil)
• usage_banner (String, nil) (defaults to: nil)
• default (Boolean) (defaults to: false)
• named_args_type (ArgType) (defaults to: nil)
• max_named_args (Integer, nil) (defaults to: nil)
• min_named_args (Integer, nil) (defaults to: nil)
• named_args_without_api (Boolean) (defaults to: false)

# File ''

const :name, String
const :aliases, T::Array[String], default: []
prop :description, T.nilable(String), default: nil
prop :usage_banner, T.nilable(String), default: nil
const :default, T::Boolean, default: false
prop :named_args_type, ArgType, default: nil
prop :max_named_args, T.nilable(Integer), default: nil
prop :min_named_args, T.nilable(Integer), default: nil
prop :named_args_without_api, T::Boolean, default: false

Instance Attribute Details

#aliases ⇒ Array<String> (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 the value of prop aliases.

Returns:

• (Array<String>)

# File ''

const :aliases, T::Array[String], default: []

#default ⇒ 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 the value of prop default.

Returns:

• (Boolean)

# File ''

const :default, T::Boolean, default: false

#description ⇒ 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 the value of prop description.

Returns:

• (String, nil)

# File ''

prop :description, T.nilable(String), default: nil

#max_named_args ⇒ Integer^?

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 the value of prop max_named_args.

Returns:

• (Integer, nil)

# File ''

prop :max_named_args, T.nilable(Integer), default: nil

#min_named_args ⇒ Integer^?

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 the value of prop min_named_args.

Returns:

• (Integer, nil)

# File ''

prop :min_named_args, T.nilable(Integer), default: nil

#name ⇒ String (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 the value of prop name.

Returns:

• (String)

# File ''

const :name, String

#named_args_type ⇒ ArgType

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 the value of prop named_args_type.

Returns:

• (ArgType)

# File ''

prop :named_args_type, ArgType, default: nil

#named_args_without_api ⇒ Boolean

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 the value of prop named_args_without_api.

Returns:

• (Boolean)

# File ''

prop :named_args_without_api, T::Boolean, default: false

#usage_banner ⇒ 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 the value of prop usage_banner.

Returns:

• (String, nil)

# File ''

prop :usage_banner, T.nilable(String), default: nil