purescript-config2

This is a fork of the TinkerTravel project that is no longer active.

Applicative configuration inspired by the talk Move Over Free Monads: Make Way for Free Applicatives!

Example

You can use the applicative DSL in Data.Config to build a description of your configuration. This description contains the keys and types of your configuration, for consumption by various interpreters. Here is an example of such a description, for PostgreSQL connections:

import Database.PostgreSQL (PoolConfiguration)

postgreSQLPool :: Config {name :: String} PoolConfiguration
postgreSQLPool =
  { user: _, password: _, host: _, port: _, database: _
  , max: 10, idleTimeoutMillis: 0 }
  <$> string {name: "user"}
  <*> string {name: "password"}
  <*> string {name: "host"}
  <*> int    {name: "port"}
  <*> string {name: "database"}

Interpreters

Currently two interpreters are provided.

Environment variables

This interpreter is called fromEnv and can be found in Data.Config.Node:

import Control.Monad.Maybe.Trans (runMaybeT)
import Data.Config.Node (fromEnv)

main :: Effect Unit
main = do
  config <- fromEnv "DB" postgreSQLPool
  ...

When applied to the above description, it will read these environment variables, derived from the name fields in the records in the description: DB_USER, DB_PASSWORD, DB_HOST, DB_PORT, DB_DATABASE. It returns a set of incorrect variables (Left), or the complete configuration (Right).

Help

This interpreter is called help and can be found in Data.Config.Help. It returns a data structure that represents a help document. It requires that in addition to name fields, you provide info fields with documentation. Passing the return value of help to renderHelp (from the same module) will pretty-print the help into a string.