Skip to content

Don't let your console messages drown in a wall of text, make them stand out!

License

Notifications You must be signed in to change notification settings

Arkham/priscilla

Repository files navigation

Priscilla

Frock up your console messages. πŸ’ƒ πŸ’ƒ πŸ’ƒ

Build Status Code Climate Coverage

Why Priscilla

Because of Priscilla, Queen of the Desert.

Don't let your console messages drown in a wall of text, make them stand out!

Tutorial

Install

Add this line to your application's Gemfile:

gem 'priscilla'

And then execute:

$ bundle

Or install it yourself as:

$ gem install priscilla

Use

Require the gem:

require 'priscilla'

Use pr to frock up your console messages

pr "A cock in a frock on a rock"

Result

Result

Decorators

Priscilla supports a lot of different decorators:

Strings

Strings

Colored Strings, view all options

Colored Strings Colored Strings, part 2

Unicode Emojis, view all options

Unicode Emojis

Text Emojis, view all options

Text Emojis

Configure

If you're using Rails, create an initializer in config/initializers/priscilla.rb:

# This is the default configuration
Priscilla.configure do |c|
  c.width = 80
  c.decorator = ':dancer: '
  c.presenter = ->(msg) { puts msg; puts }
end

Or if you prefer to use the Rails logger:

Priscilla.configure do |c|
  c.width = 80
  c.decorator = ':dancer: '
  c.presenter = ->(msg) { Rails.logger.debug "\n#{msg}" }
end

Troubleshoot

I can't see the fancy emojis!!! I'm on Linux!!!

On Ubuntu: sudo apt-get install ttf-ancient-fonts

On Fedora: yum install gdouros-symbola-fonts

Contribute

  1. Fork it ( http://github.com/Arkham/priscilla/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

About

Don't let your console messages drown in a wall of text, make them stand out!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages