Module: Toys::Tool::Keys

Defined in:

lib/toys/tool.rb

Overview

Well-known context keys.

Constant Summary

CLI =

Context key for the currently running CLI.

Returns:

• (Object)

::Object.new.freeze

VERBOSITY =

Context key for the verbosity value. Verbosity is an integer defaulting to 0, with higher values meaning more verbose and lower meaning quieter.

Returns:

• (Object)

::Object.new.freeze

TOOL_DEFINITION =

Context key for the Toys::Definition::Tool object being executed.

Returns:

• (Object)

::Object.new.freeze

TOOL_NAME =

Context key for the full name of the tool being executed. Value is an array of strings.

Returns:

• (Object)

::Object.new.freeze

LOADER =

Context key for the active Toys::Loader object.

Returns:

• (Object)

::Object.new.freeze

LOGGER =

Context key for the active Logger object.

Returns:

• (Object)

::Object.new.freeze

BINARY_NAME =

Context key for the name of the toys binary. Value is a string.

Returns:

• (Object)

::Object.new.freeze

ARGS =

Context key for the argument list passed to the current tool. Value is an array of strings.

Returns:

• (Object)

::Object.new.freeze

USAGE_ERROR =

Context key for the usage error raised. Value is a string if there was an error, or nil if there was no error.

Returns:

• (Object)

::Object.new.freeze