/ Ruby
/
method

class_option

ruby latest stable - Class: Bundler::Thor::Base::ClassMethods

Method not available on this version

This method is only available on newer versions. The first available version (v2_6_3) is shown here.

class_option(name, options = {})
public

Adds an option to the set of class options

Parameters

name

The name of the argument.

options

Described below.

Options

:desc

– Description for the argument.

:required

– If the argument is required or not.

:default

– Default value for this argument.

:group

– The group for this options. Use by class options to output options in different levels.

:aliases

– Aliases for this option. Note: Bundler::Thor follows a convention of one-dash-one-letter options. Thus aliases like “-something” wouldn’t be parsed; use either “--something” or “-s” instead.

:type

– The type of the argument, can be :string, :hash, :array, :numeric or :boolean.

:banner

– String to show on usage notes.

:hide

– If you want to hide this option from the help.