lambdaisland/dotenv

October 17, 2022 · View on GitHub

cljdoc badge Clojars Project

Pure Clojure/ClojureScript parser of dotenv file syntax.

Features

Parse the contents of a dotenv file, returns a map.

  • each line is interpreted as VAR_NAME=value
  • leading whitespace, a leading export keyword, and whitespace around the = sign is ignored
  • lines starting with # (and optionally whitespace) are ignored
  • Unix and Windows line endings are understood
  • Values can be unquoted, single-, or double-quoted
  • Quoted values can continue on consequtive lines
  • Unquoted or double-quoted values can contain interpolation using the ${VAR} syntax if {:expand? true} is set. Values can be interpolated from vars set earlier in the contents, passed in as the :vars options, or on Clojure (not ClojureScript) will be filled from the process environment (using System/getenv).
  • Certain backslash sequences are understood. \n newline, \t tab, \n newline, \r carriage return, \f form feed, \b backspace, \uFFFF unicode character. A backslash followed by any other character will be replaced by said characters, including single and double quotes.

Installation

To use the latest release, add the following to your deps.edn (Clojure CLI)

com.lambdaisland/dotenv {:mvn/version "0.2.5"}

or add the following to your project.clj (Leiningen)

[com.lambdaisland/dotenv "0.2.5"]

Usage

(require '[lambdaisland.dotenv :as dotenv])

(dotenv/parse-dotenv
 "FOO=xxx
BAR=\"${FOO} hello ${FOO}\"
FILE_PATH=${HOME}/my_file"
 {:expand? true})
;; => {"FOO" "xxx", "BAR" "xxx hello xxx", "FILE_PATH" "/home/arne/my_file"}

Lambda Island Open Source

 

dotenv is part of a growing collection of quality Clojure libraries created and maintained by the fine folks at Gaiwan.

Pay it forward by becoming a backer on our Open Collective, so that we may continue to enjoy a thriving Clojure ecosystem.

You can find an overview of our projects at lambdaisland/open-source.

 

 

Contributing

Everyone has a right to submit patches to dotenv, and thus become a contributor.

Contributors MUST

  • adhere to the LambdaIsland Clojure Style Guide
  • write patches that solve a problem. Start by stating the problem, then supply a minimal solution. *
  • agree to license their contributions as MPL 2.0.
  • not break the contract with downstream consumers. **
  • not break the tests.

Contributors SHOULD

  • update the CHANGELOG and README.
  • add tests for new functionality.

If you submit a pull request that adheres to these rules, then it will almost certainly be merged immediately. However some things may require more consideration. If you add new dependencies, or significantly increase the API surface, then we need to decide if these changes are in line with the project's goals. In this case you can start by writing a pitch, and collecting feedback on it.

* This goes for features too, a feature needs to solve a problem. State the problem it solves, then supply a minimal solution.

** As long as this project has not seen a public release (i.e. is not on Clojars) we may still consider making breaking changes, if there is consensus that the changes are justified.

License

Copyright © 2022 Arne Brasseur and Contributors

Licensed under the term of the Mozilla Public License 2.0, see LICENSE.