https://github.com/custompro98/glenv

Type-safe access to your environment variables.
https://github.com/custompro98/glenv

Last synced: about 2 months ago
JSON representation

Type-safe access to your environment variables.

• Host: GitHub
• URL: https://github.com/custompro98/glenv
• Owner: custompro98
• License: apache-2.0
• Created: 2024-07-02T21:01:24.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-07-05T19:13:44.000Z (3 months ago)
• Last Synced: 2024-07-20T11:19:51.505Z (2 months ago)
• Language: Gleam
• Size: 20.5 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-gleam - glenv - [📚](https://hexdocs.pm/glenv/) - A library for type-safe environment variable access. (Packages / Configuration)

README

        
# glenv

[![Package Version](https://img.shields.io/hexpm/v/glenv)](https://hex.pm/packages/glenv)

[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/glenv/)

Type-safe environment variables for Gleam.

Accessing environment variables doesn't give us the type of safety guarantees we'd like in a langauge like Gleam. glenv aims to guarantee that each environment variable is of the correct type AND is present.

```sh

gleam add glenv

```

```gleam

import dot_env

import gleam/decode

import glenv

pub type MyEnv {

  MyEnv(hello: String, foo: Float, count: Int, is_on: Bool)

}

pub fn main() {

  // Optional: Load environment variables from a file

  dot_env.load_default()

  let definitions = [

    #("HELLO", glenv.String),

    #("FOO", glenv.Float),

    #("COUNT", glenv.Int),

    #("IS_ON", glenv.Bool),

  ]

  let decoder =

    decode.into({

      use hello <- decode.parameter

      use foo <- decode.parameter

      use count <- decode.parameter

      use is_on <- decode.parameter

      MyEnv(hello: hello, foo: foo, count: count, is_on: is_on)

    })

    |> decode.field("HELLO", decode.string)

    |> decode.field("FOO", decode.float)

    |> decode.field("COUNT", decode.int)

    |> decode.field("IS_ON", decode.bool)

  let assert Ok(env) = glenv.load(decoder, definitions)

  env.hello == "hello"

  env.foo == 1.0

  env.count == 1

  env.is_on == True

}

```

## Expected values

### Bool

Any casing of `true`, `yes` or `1` will be parsed as `True`. Any other value will be parsed as `False`.

### Float

Any value that can be parsed as a float will be parsed as a float. Any other value will result in an `InvalidEnvValue` error.

### Int

Any value that can be parsed as an int will be parsed as an int. Any other value will result in an `InvalidEnvValue` error.

### String

Any value will be parsed as a string.

Further documentation can be found at .

## Development

```sh

gleam run   # Run the project

gleam test  # Run the tests

gleam shell # Run an Erlang shell

```