Class: Toys::StandardCLI
Overview
Subclass of Toys::CLI
configured for the behavior of the standard Toys
executable.
Constant Summary collapse
- CONFIG_DIR_NAME =
Standard toys configuration directory name.
".toys"
- CONFIG_FILE_NAME =
Standard toys configuration file name.
".toys.rb"
- INDEX_FILE_NAME =
Standard index file name in a toys configuration.
".toys.rb"
- PRELOAD_DIR_NAME =
Standard preload directory name in a toys configuration.
".preload"
- PRELOAD_FILE_NAME =
Standard preload file name in a toys configuration.
".preload.rb"
- DATA_DIR_NAME =
Standard data directory name in a toys configuration.
".data"
- LIB_DIR_NAME =
Standard lib directory name in a toys configuration.
".lib"
- EXECUTABLE_NAME =
Name of the standard toys executable.
"toys"
- EXTRA_DELIMITERS =
Delimiter characters recognized.
":."
- DEFAULT_ROOT_DESC =
Short description for the standard root tool.
"Your personal command line tool"
- DEFAULT_ROOT_LONG_DESC =
Help text for the standard root tool.
"Toys is your personal command line tool. You can write commands using a simple Ruby DSL," \ " and Toys will automatically organize them, parse arguments, and provide documentation." \ " Tools can be global or scoped to specific directories. You can also use Toys instead of" \ " Rake to provide build and maintenance scripts for your projects." \ " For detailed information, see https://dazuma.github.io/toys"
- DEFAULT_VERSION_FLAG_DESC =
Short description for the version flag.
"Show the version of Toys."
- TOYS_PATH_ENV =
Name of the toys path environment variable.
"TOYS_PATH"
Instance Attribute Summary
Attributes inherited from CLI
#base_level, #completion, #executable_name, #extra_delimiters, #loader, #logger, #logger_factory
Instance Method Summary collapse
-
#initialize(cur_dir: nil) ⇒ StandardCLI
constructor
Create a standard CLI, configured with the appropriate paths and middleware.
Methods inherited from CLI
#add_config_block, #add_config_path, #add_search_path, #add_search_path_hierarchy, #child, default_logger_factory, default_middleware_lookup, default_middleware_stack, default_mixin_lookup, default_template_lookup, #run
Constructor Details
#initialize(cur_dir: nil) ⇒ StandardCLI
Create a standard CLI, configured with the appropriate paths and middleware.
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/toys/standard_cli.rb', line 99 def initialize(cur_dir: nil) super( executable_name: EXECUTABLE_NAME, config_dir_name: CONFIG_DIR_NAME, config_file_name: CONFIG_FILE_NAME, index_file_name: INDEX_FILE_NAME, preload_file_name: PRELOAD_FILE_NAME, preload_dir_name: PRELOAD_DIR_NAME, data_dir_name: DATA_DIR_NAME, lib_dir_name: LIB_DIR_NAME, extra_delimiters: EXTRA_DELIMITERS, middleware_stack: default_middleware_stack, template_lookup: default_template_lookup ) add_standard_paths(cur_dir: cur_dir, toys_dir_name: CONFIG_DIR_NAME) end |