mirror of
https://github.com/pry/pry.git
synced 2022-11-09 12:35:05 -05:00
100 lines
3.6 KiB
Ruby
100 lines
3.6 KiB
Ruby
require 'ostruct'
|
|
|
|
class Pry
|
|
class Config < OpenStruct
|
|
|
|
# Get/Set the object to use for input by default by all Pry instances.
|
|
# @return [#readline] The object to use for input by default by all
|
|
# Pry instances.
|
|
attr_accessor :input
|
|
|
|
# Get/Set the object to use for output by default by all Pry instances.
|
|
# @return [#puts] The object to use for output by default by all
|
|
# Pry instances.
|
|
attr_accessor :output
|
|
|
|
# Get/Set the object to use for commands by default by all Pry instances.
|
|
# @return [Pry::CommandBase] The object to use for commands by default by all
|
|
# Pry instances.
|
|
attr_accessor :commands
|
|
|
|
# Get/Set the Proc to use for printing by default by all Pry
|
|
# instances.
|
|
# This is the 'print' component of the REPL.
|
|
# @return [Proc] The Proc to use for printing by default by all
|
|
# Pry instances.
|
|
attr_accessor :print
|
|
|
|
# @return [Proc] The Proc to use for printing exceptions by default by all
|
|
# Pry instances.
|
|
attr_accessor :exception_handler
|
|
|
|
# Get/Set the Hash that defines Pry hooks used by default by all Pry
|
|
# instances.
|
|
# @return [Hash] The hooks used by default by all Pry instances.
|
|
# @example
|
|
# Pry.hooks :before_session => proc { puts "hello" },
|
|
# :after_session => proc { puts "goodbye" }
|
|
attr_accessor :hooks
|
|
|
|
# Get the array of Procs to be used for the prompts by default by
|
|
# all Pry instances.
|
|
# @return [Array<Proc>] The array of Procs to be used for the
|
|
# prompts by default by all Pry instances.
|
|
attr_accessor :prompt
|
|
|
|
# The default editor to use. Defaults to $EDITOR or nano if
|
|
# $EDITOR is not defined.
|
|
# If `editor` is a String then that string is used as the shell
|
|
# command to invoke the editor. If `editor` is callable (e.g a
|
|
# Proc) then `file` and `line` are passed in as parameters and the
|
|
# return value of that callable invocation is used as the exact
|
|
# shell command to invoke the editor.
|
|
# @example String
|
|
# Pry.editor = "emacsclient"
|
|
# @example Callable
|
|
# Pry.editor = proc { |file, line| "emacsclient #{file} +#{line}" }
|
|
# @return [String, #call]
|
|
attr_accessor :editor
|
|
|
|
# @return [Boolean] Toggle Pry color on and off.
|
|
attr_accessor :color
|
|
|
|
# @return [Boolean] Toggle paging on and off.
|
|
attr_accessor :pager
|
|
|
|
# Determines whether the rc file (~/.pryrc) should be loaded.
|
|
# @return [Boolean]
|
|
attr_accessor :should_load_rc
|
|
|
|
# Determines whether plugins should be loaded.
|
|
# @return [Boolean]
|
|
attr_accessor :should_load_plugins
|
|
|
|
# Config option for history.
|
|
# sub-options include hist.file, hist.load, and hist.save
|
|
# hist.file is the file to save/load history too, e.g
|
|
# Pry.config.history.file = "~/.pry_history".
|
|
# hist.should_load is a boolean that determines whether history will be
|
|
# loaded from hist.file at session start.
|
|
# hist.should_save is a boolean that determines whether history will be
|
|
# saved to hist.file at session end.
|
|
# @return [OpenStruct]
|
|
attr_accessor :history
|
|
|
|
# Config option for plugins:
|
|
# sub-options include:
|
|
# `plugins.enabled` (Boolean) to toggle the loading of plugins on and off wholesale. (defaults to true)
|
|
# `plugins.strict_loading` (Boolean) which toggles whether referring to a non-existent plugin should raise an exception (defaults to `false`)
|
|
# @return [OpenStruct]
|
|
attr_accessor :plugins
|
|
|
|
# @return [Integer] Amount of results that will be stored into out
|
|
attr_accessor :memory_size
|
|
|
|
# @return [Boolean] Whether or not evalation results (`=>`) are sent
|
|
# through a pager.
|
|
attr_accessor :result_pager
|
|
end
|
|
end
|
|
|