search fire star recently

habitat

Type safe configuration for your classes and modules

0.4.1 released
luckyframework/habitat
45 5 6

Habitat

Easily configure settings for Crystal projects

Installation

Add this to your application's shard.yml:

dependencies:
  habitat:
    github: luckyframework/habitat

Usage

require "habitat"
class MyServer
  Habitat.create do
    setting port : Int32
    setting debug_errors : Bool = true
    setting host : String, example: "127.0.0.1"
  end

  # Access them like this
  def start
    start_server_on port: settings.port
  end
end

MyServer.configure do |settings|
  settings.port = 8080
end

# At the very end of your program use this
# It will raise if you forgot to set any settings
Habitat.raise_if_missing_settings!

Settings can also be accessed from outside the class:

port = MyServer.settings.port
puts "The server is starting on port #{port}"

Contributing

  1. Fork it ( https://github.com/luckyframework/habitat/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

habitat:
  github: luckyframework/habitat
  version: ~> 0.4.1

Authors

  • Paul Smith

License

MIT

Crystal

0.27.2

Dependencies 0

Development Dependencies 0

Last synced .