climate.cr v0.2.2

Tiny tool to make your CLI output ๐ŸŒˆ coloured

climate.cr CI Releases License

Small helper utility to make your CLI program output ๐ŸŒˆ coloured by means of configurable markup styles. Think of it as your CLI-mate :)

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      climate:
        github: Sija/climate.cr
    
  2. Run shards install

Usage

require "climate"

message = "Usage: {#{PROGRAM_NAME}} <required-arg> [optional-arg]"

# you can call `Climate.parse` method directly
puts Climate.parse(message)

# or use a `String#climatize` extension
puts message.climatize

Defaults

Default styles are:

  • <> colored in green (keeping delimiters)
  • [] colored in yellow (keeping delimiters)
  • {} colored in blue (hiding delimiters)
  • !ยก colored in red (hiding delimiters)

Configuration

You can change the global settings with a #configure block:

Climate.configure do |settings|
  # use defaults
  settings.use_defaults!

  # and/or configure your own styles
  settings.styles << Climate::Style.new(
    delimiters: {'?', 'ยฟ'},
    keep_delimiters: false,
    colors: {
      fore: :magenta,
      back: :default,
    },
    decoration: :bold
  )
end

For the colors and decoration reference values see documentation for the Colorize module (which Climate uses under the hood).

Contributing

  1. Fork it (https://github.com/Sija/climate.cr/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 a new Pull Request

Contributors

Repository

climate.cr

Owner
Statistic
  • 14
  • 0
  • 0
  • 1
  • 1
  • 5 months ago
  • May 21, 2020
License

MIT License

Links
Synced at

Wed, 27 Mar 2024 14:16:36 GMT

Languages