MyNixOS website logo
Description

Automatically read config.json from the current directory.

Automatically discover and parse a config.json file in the current working directory or any of its parent directories. No need to manually pass file paths. Built on top of aeson, it provides a simple `getConfig :: FromJSON a => IO a` function that also supports default values when fields are missing in the JSON file.

e9571-config-reader-haskell

A tiny, zero-configuration Haskell library that instantly reads a config.json file from the current working directory.

Out-of-the-box, no setup required.
Just drop a config.json file next to your executable and start using the library — it just works.

Usage (two steps)

  1. Create a config.json file in the same directory as your program:

    {
      "host": "127.0.0.1",
      "port": 8080
    }
    
  2.    {-# LANGUAGE OverloadedStrings #-}
    
       import E9571.ConfigReader
       import Data.Aeson
    
       data Config = Config { host :: String, port :: Int } deriving Show
    
       instance FromJSON Config where
           parseJSON = withObject "Config" $ \o -> Config
               <$> o .: "host"
               <*> o .: "port"
    
       main :: IO ()
       main = do
           cfg <- loadConfigOrDie :: IO Config   -- automatically reads ./config.json
           putStrLn $ "Server starting at " ++ host cfg ++ ":" ++ show (port cfg)
    

Features

  • Automatically looks for ./config.json at runtime
  • No file paths, no command-line flags, no environment variables
  • Works with any FromJSON instance
  • Helpful error messages when the file is missing or malformed
  • Only depends on aeson

Installation

cabal install e9571-config-reader-haskell

Source: https://github.com/e9571/e9571-config-reader-haskell Hackage: https://hackage.haskell.org/package/e9571-config-reader-haskell

Enjoy the simplicity!

Metadata

Version

0.1.0.2

License

Platforms (78)

    Darwin
    FreeBSD
    Genode
    GHCJS
    Linux
    MMIXware
    NetBSD
    none
    OpenBSD
    Redox
    Solaris
    uefi
    WASI
    Windows
Show all
  • aarch64-darwin
  • aarch64-freebsd
  • aarch64-genode
  • aarch64-linux
  • aarch64-netbsd
  • aarch64-none
  • aarch64-uefi
  • aarch64-windows
  • aarch64_be-none
  • arm-none
  • armv5tel-linux
  • armv6l-linux
  • armv6l-netbsd
  • armv6l-none
  • armv7a-linux
  • armv7a-netbsd
  • armv7l-linux
  • armv7l-netbsd
  • avr-none
  • i686-cygwin
  • i686-freebsd
  • i686-genode
  • i686-linux
  • i686-netbsd
  • i686-none
  • i686-openbsd
  • i686-windows
  • javascript-ghcjs
  • loongarch64-linux
  • m68k-linux
  • m68k-netbsd
  • m68k-none
  • microblaze-linux
  • microblaze-none
  • microblazeel-linux
  • microblazeel-none
  • mips-linux
  • mips-none
  • mips64-linux
  • mips64-none
  • mips64el-linux
  • mipsel-linux
  • mipsel-netbsd
  • mmix-mmixware
  • msp430-none
  • or1k-none
  • powerpc-linux
  • powerpc-netbsd
  • powerpc-none
  • powerpc64-linux
  • powerpc64le-linux
  • powerpcle-none
  • riscv32-linux
  • riscv32-netbsd
  • riscv32-none
  • riscv64-linux
  • riscv64-netbsd
  • riscv64-none
  • rx-none
  • s390-linux
  • s390-none
  • s390x-linux
  • s390x-none
  • vc4-none
  • wasm32-wasi
  • wasm64-wasi
  • x86_64-cygwin
  • x86_64-darwin
  • x86_64-freebsd
  • x86_64-genode
  • x86_64-linux
  • x86_64-netbsd
  • x86_64-none
  • x86_64-openbsd
  • x86_64-redox
  • x86_64-solaris
  • x86_64-uefi
  • x86_64-windows