crystal-env

0.1.01 version

github.com/crystal-lang/crystal-env

No description declared in shard.yml.

14 stars

4 dependents

License: MIT

Installation

# Add this to your shard.yml
dependencies:
  crystal-env:
    github: crystal-lang/crystal-env
    version: ~> 0.1.0

Then run:

shards install

This version declares no dependencies.

This shard provides environment detection. The selected environment is configured using CRYSTAL_ENV environment variable.

Add this to your application's shard.yml:

dependencies:
  crystal-env:
    github: crystal-lang/crystal-env

Add the following require in the application code. The default environment will be development.

require "crystal-env"

In the spec/spec_helper.cr require crystal-env/spec before your app code. When running crystal spec the default environment will be test.

require "spec"
require "crystal-env/spec"
require "../your-app"

Use the following methods to detect the environment
- Crystal.env.development?
- Crystal.env.production?
- Crystal.env.test?
Use the following method to get name the environment
- Crystal.env.name
Set CRYSTAL_ENV to development, production or test