A .env parser/loader improved for performance.
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.circleci ๐Ÿ’ƒ Jul 19, 2018
spec fix: put replaced flag outside of loop Aug 22, 2018
src release: dump v0.3.0 Aug 22, 2018
.editorconfig ๐Ÿ’ƒ Jul 19, 2018
.gitignore ๐Ÿ’ƒ Jul 19, 2018
CHANGELOG.md doc: add v0.3.0 changelogs link Aug 22, 2018
LICENSE ๐Ÿ’ƒ Jul 19, 2018
README.md Update README.md Sep 20, 2018
logo-small.png ๐Ÿ’ƒ Jul 19, 2018
shard.yml Compatibility with Crystal 0.27 Nov 5, 2018

README.md

poncho-logo

Poncho

Language Tag Build Status

A .env parser/loader improved for performance. Poncho Icon by lastspark from Noun Project.

Installation

Add this to your application's shard.yml:

dependencies:
  poncho:
    github: icyleaf/poncho

Usage

Add your application configuration to your .env file in the root of your project:

MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_DATABASE=poncho
MYSQL_USER=poncho
MYSQL_PASSWORD=74e10b72-33b1-434b-a476-cfee0faa7d75

Now you can parse or load it.

Parse

Poncho parses the contents of your file containing environment variables is available to use. It accepts a String or IO and will return an Hash with the parsed keys and values.

Rules

Poncho parser currently supports the following rules:

  • Skipped the empty line and comment(#).
  • Ignore the comment which after (#).
  • ENV=development becomes {"ENV" => "development"}.
  • Snakecase and upcase the key: dbName becomes DB_NAME, DB_NAME becomes DB_NAME
  • Support variables in value. $NAME or ${NAME}.
  • Whitespace is removed from both ends of the value. NAME = foo becomes`{"NAME" => "foo"}
  • New lines are expanded if in double quotes. MULTILINE="new\nline" becomes `{"MULTILINE" => "new\nline"}
  • Inner quotes are maintained (such like Hash/JSON). JSON={"foo":"bar"} becomes `{"JSON" => "{"foo":"bar"}"}
  • Empty values become empty strings.
  • Single and double quoted values are escaped.
  • Overwrite optional (default is non-overwrite).
  • Support variables in value. WELCOME="hello $NAME" becomes {"WELCOME" => "hello foo"}

Overrides

By default, Poncho won't overwrite existing environment variables as dotenv assumes the deployment environment has more knowledge about configuration than the application does. To overwrite existing environment variables you can use Poncho.parse!(string_or_io) / Poncho.from_file(file, overwrite: true) and Poncho.parse(string_or_io, overwrite: true).

Examples

require "poncho"
# Or only import parser
require "poncho/parser"

poncho = Poncho.from_file ".env"
# or
poncho = Poncho.parse("ENV=development\nENV=production")
poncho["ENV"] # => "development"

# Overwrite value with exists key
poncho = Poncho.parse!("ENV=development\nENV=production")
poncho["ENV"] # => "production"

Load

Poncho loads the environment file is easy to use, based on parser above.

It accepts both single file (or path) and multiple files.

Orders

Poncho loads single file supports the following order with environment name (default is development):

  • .env - The Originalยฎ
  • .env.development - Environment-specific settings.
  • .env.local - Local overrides. This file is loaded for all environments except test.
  • .env.development.local - Local overrides of environment-specific settings.

NO effect with multiple files, it only loads the given files.

Overrides

By default, Poncho won't overwrite existing environment variables as dotenv assumes the deployment environment has more knowledge about configuration than the application does. To overwrite existing environment variables you can use Poncho.load!(*files) or Poncho.load(*files, overwrite: true).

Examples

require "poncho"
# Or only import loader
require "poncho/loader"

# Load singe file
# Searching order: .env.development, .env.local, .env.development.local
Poncho.load ".env"

# Load from path
Poncho.load "config/"

# Load production file
# Searching order: .env, .env.production, .env.local, .env.production.local
Poncho.load ".env", env: "production"

# Load multiple files and overwrite value with exists key
# note: ignore enviroment name.
# Searching order: .env, .env.local
Poncho.load! ".env", ".env.local", env: "test"

Best solution

Totem is here to help with that. Poncho was built-in to Totem to better with configuration. Configuration file formats is always the problem, you want to focus on building awesome things.

Donate

Poncho is a open source, collaboratively funded project. If you run a business and are using Poncho in a revenue-generating product, it would make business sense to sponsor Poncho development. Individual users are also welcome to make a one time donation if Totem has helped you in your work or personal projects.

You can donate via Paypal.

How to Contribute

Your contributions are always welcome! Please submit a pull request or create an issue to add a new question, bug or feature to the list.

All Contributors are on the wall.

You may also like

  • halite - Crystal HTTP Requests Client with a chainable REST API, built-in sessions and middlewares.
  • totem - Load and parse a configuration file or string in JSON, YAML, dotenv formats.
  • markd - Yet another markdown parser built for speed, Compliant to CommonMark specification.
  • popcorn - Easy and Safe casting from one type to another.
  • fast-crystal - ๐Ÿ’จ Writing Fast Crystal ๐Ÿ˜ -- Collect Common Crystal idioms.

License

MIT License ยฉ icyleaf