Icepick

Gem Version Code Climate Dependency Status

Changelog

Icepick bundles a set of useful tools, plugins, and configurations together:

Ruby 2.0.0+ only.

Usage

Install the gem and run icepick or rails console as you normally would.

Options

The following options can be changed with a Rails initializer. Example config/initializers/icepick.rb:

if defined?(Icepick)
    # Change the name to something moar awesomer
    Icepick::Prompt.config.name = 'Iceaxe'
    # Make the layout look more like plain Pry
    Icepick::Prompt.config.main_layout = '[{line_num}] {name}({context}) {separator} '
end

separator

Change the prompt separator to something other than the default: >

main_layout

Allows you to configure the layout for the main Pry prompt, defaults to '{line_num}. {name}@{context} {separator} '. The following placeholders are available for use in the layout:

  • name - The prompt name
  • line_num - Current line number, the Pry input array size
  • context - Path of the current context (eg. cd Pry::CommandSet #=> /Pry/CommandSet)
  • separator - Prompt separator

wait_layout

Configuration for the Pry wait prompt, defaults to '{spaces} {separator} '. In addition to the above placeholders, there are a few available exclusively to the wait prompt:

  • spaces - String of spaces equal to the length to the main prompt without the separator
  • dots - Similar to the above but dots

Contributing

Feedback and features welcome! Please make use of Issues and Pull Requests, all code must have accompanying specs.

Author/Contact

Icepick is written and maintained by @doomspork with the help of @jamesbrink.

License

Icepick is made available under the MIT License.