kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

* lib/irb.rb, lib/irb/context.rb: Add documentation on how to enable

Browse source 
auto-indentation and autocompletion using irbrc and irb_context
  [ruby-core:51209] [Bug #7642] and [ruby-core:51348] [Bug #7680]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@39048 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
zzak 2013-02-04 22:36:22 +00:00
parent 9cfc40ab96
commit e195e181e6
3 changed files with 37 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

6
ChangeLog
View file

@ -1,3 +1,9 @@
Tue Feb 5 07:35:00 2013 Zachary Scott <zachary@zacharyscott.net>
* lib/irb.rb, lib/irb/context.rb: Add documentation on how to enable
auto-indentation and autocompletion using irbrc and irb_context
[ruby-core:51209] [Bug #7642] and [ruby-core:51348] [Bug #7680]
Tue Feb 5 05:20:00 2013 Zachary Scott <zachary@zacharyscott.net> Tue Feb 5 05:20:00 2013 Zachary Scott <zachary@zacharyscott.net>
* doc/standard_library.rdoc: Document list of libraries and extensions * doc/standard_library.rdoc: Document list of libraries and extensions

21
lib/irb.rb
View file

@ -105,6 +105,18 @@ STDOUT.sync = true
# IRB.conf[:PROMPT] = {...} # IRB.conf[:PROMPT] = {...}
# IRB.conf[:DEBUG_LEVEL]=0 # IRB.conf[:DEBUG_LEVEL]=0
# #
# === Auto indentation
#
# To enable auto-indent mode in irb, add the following to your +.irbrc+:
#
# IRB.conf[:AUTO_INDENT] = true
#
# === Autocompletion
#
# To enable autocompletion for irb, add the following to your +.irbrc+:
#
# require 'irb/completion'
#
# == Customizing the IRB Prompt # == Customizing the IRB Prompt
# #
# In order to customize the prompt, you can change the following Hash: # In order to customize the prompt, you can change the following Hash:
@ -114,20 +126,19 @@ STDOUT.sync = true
# This example can be used in your +.irbrc+ # This example can be used in your +.irbrc+
# #
# IRB.conf[:PROMPT][:MY_PROMPT] = { # name of prompt mode # IRB.conf[:PROMPT][:MY_PROMPT] = { # name of prompt mode
# :AUTO_INDENT => true # enables auto-indent mode
# :PROMPT_I => nil, # normal prompt # :PROMPT_I => nil, # normal prompt
# :PROMPT_S => nil, # prompt for continuated strings # :PROMPT_S => nil, # prompt for continuated strings
# :PROMPT_C => nil, # prompt for continuated statement # :PROMPT_C => nil, # prompt for continuated statement
# :RETURN => " ==>%s\n" # format to return value # :RETURN => " ==>%s\n" # format to return value
# } # }
# #
# Then, invoke irb with the above prompt mode by: # IRB.conf[:PROMPT_MODE] = :MY_PROMPT
#
# Or, invoke irb with the above prompt mode by:
# #
# irb --prompt my-prompt # irb --prompt my-prompt
# #
# Or, add the following in your +.irbrc+:
#
# IRB.conf[:PROMPT_MODE] = :MY_PROMPT
#
# Constants +PROMPT_I+, +PROMPT_S+ and +PROMPT_C+ specify the format. In the # Constants +PROMPT_I+, +PROMPT_S+ and +PROMPT_C+ specify the format. In the
# prompt specification, some special strings are available: # prompt specification, some special strings are available:
# #

16
lib/irb/context.rb
View file

@ -161,8 +161,22 @@ module IRB
attr_accessor :prompt_c attr_accessor :prompt_c
# See IRB@Customizing+the+IRB+Prompt for more information. # See IRB@Customizing+the+IRB+Prompt for more information.
attr_accessor :prompt_n attr_accessor :prompt_n
# Can be either the deafult <code>IRB.conf[:AUTO_INDENT]</code>, or the # Can be either the default <code>IRB.conf[:AUTO_INDENT]</code>, or the
# mode set by #prompt_mode= # mode set by #prompt_mode=
#
# To enable auto-indentation in irb:
#
# IRB.conf[:AUTO_INDENT] = true
#
# or
#
# irb_context.auto_indent_mode = true
#
# or
#
# IRB.CurrentContext.auto_indent_mode = true
#
# See IRB@Configuration for more information.
attr_accessor :auto_indent_mode attr_accessor :auto_indent_mode
# The format of the return statement, set by #prompt_mode= using the # The format of the return statement, set by #prompt_mode= using the
# +:RETURN+ of the +mode+ passed to set the current #prompt_mode. # +:RETURN+ of the +mode+ passed to set the current #prompt_mode.