Class | Pry::Config |
In: |
lib/pry/config.rb
|
Parent: | OpenStruct |
auto_indent | [RW] |
@return [Boolean] Whether or not code should be indented
using Pry::Indent. |
collision_warning | [RW] |
@return [Boolean] Whether or not a warning will be displayed when
a command name collides with a method/local in the current context. |
color | [RW] | @return [Boolean] Toggle Pry color on and off. |
command_prefix | [RW] | A string that must precede all Pry commands (e.g., if command_prefix is set to "%", the "cd" command must be invoked as "%cd"). @return [String] |
commands | [RW] |
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. |
control_d_handler | [RW] |
@return [Proc] The proc that manages ^D presses in the REPL.
The proc is passed the current eval_string and the current pry instance. |
correct_indent | [RW] |
@return [Boolean] Whether or not indentation should be corrected
after hitting enter. This feature is not supported by all terminals. |
default_window_size | [RW] |
@return [Fixnum] The number of lines of context to show before and after
exceptions, etc. |
disable_auto_reload | [RW] | Determines whether to disable edit-method‘s auto-reloading behavior. @return [Boolean] |
editor | [RW] |
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.config.editor = "emacsclient" @example Callable Pry.config.editor = proc { |file, line| "emacsclient #{file} +#{line}" } @return [String, call] |
exception_handler | [RW] |
@return [Proc] The Proc to use for printing exceptions by default by all
Pry instances. |
exception_whitelist | [RW] | @return [Array] The classes of exception that will not be caught by Pry. |
gist | [RW] |
Config option for gist. sub-options include
`gist.inspecter`, `gist.inspecter` is a callable that defines how the
expression output will be displayed when using the `gist -i` command.
@example Pretty inspect output
Pry.config.gist.inspecter = proc { |v| v.pretty_inspect } @example Regular inspect Pry.config.gist.inspecter = proc &:inspect @return [OpenStruct] |
history | [RW] | Config option for history. sub-options include history.file, history.load, and history.save history.file is the file to save/load history to, e.g Pry.config.history.file = "~/.pry_history". history.should_load is a boolean that determines whether history will be loaded from history.file at session start. history.should_save is a boolean that determines whether history will be saved to history.file at session end. @return [OpenStruct] |
hooks | [R] |
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" } |
input | [RW] |
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. |
input_stack | [RW] |
Get/Set the stack of input objects that a Pry
instance switches to when its current input object encounters EOF. @return
[Array] The array of input objects. @example
Pry.config.input_stack = [StringIO.new("puts 'hello world'\nexit")] |
memory_size | [RW] | @return [Integer] Amount of results that will be stored into out |
output | [RW] |
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. |
pager | [RW] | @return [Boolean] Toggle paging on and off. |
plugins | [RW] | Config option for plugins: sub-options include: `plugins.strict_loading` (Boolean) which toggles whether referring to a non-existent plugin should raise an exception (defaults to `false`) @return [OpenStruct] |
[RW] |
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. |
|
prompt | [RW] |
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. |
requires | [RW] | @return [Array<String>] Ruby files to be required after loading any plugins. |
should_load_plugins | [RW] | Determines whether plugins should be loaded. @return [Boolean] |
should_load_rc | [RW] | Determines whether the rc file (~/.pryrc) should be loaded. @return [Boolean] |
should_load_requires | [RW] | Determines whether to load files specified with the -r flag. @return [Boolean] |
should_trap_interrupts | [RW] | Determines whether Pry should trap SIGINT and cause it to raise an Interrupt exception. This is only useful on jruby, MRI does this for us. @return [Boolean] |
system | [RW] |
@return [Proc] The proc that runs system commands
The proc is passed the pry output object, the command string to eval, and a reference to the pry instance |
FIXME: This is a hack to alert people of the new API. @param [Pry::Hooks] v Only accept `Pry::Hooks` now!