merofuruya / environmentality

Makes you have a good time with environment variables and dotenv

I’m @MeroFuruya.

Interests:

• Python
  • Discord bots (using i.py)
  • mongodb (pymongo/motor)
  • http/api stuff
  • webapps (flask, aiohttp)
• js
  • typescript
  • express
  • typeorm
• Pascal/Delphi
  • using it at work as a dev
  • mostly vcl stuff (delphi by Embarcadero)

environmentality's Issues

return value not null but undefined

Describe the bug

const result = envConverter.convert([
  {
    name: "WONG_BOOLEAN",
    type: "boolean",
  },
])
expect(result).toEqual({ WONG_BOOLEAN: null })

fails:

- Expected  - 3
+ Received  + 1

- Object {
-   "MISSING_REQUIRED": null,
- }
+ Object {}

Steps to reproduce

see Describe the bug

Expected behavior

i expect that to pass

Environment

• Version: 562c30e

Other information

No response

case insensitive naming option

Describe the feature

i would like to be able to set variable name matching to case insensitive

Example

Env var name: TEST_STRING
code var name: test_string

this isn't possible atm

Motivation

:)

write default values into process.env

Describe the feature

i would like default values to be written into process.env. that would help with other libraries that use environment variables.

Example

if i give NEW_RELIC_ENABLED a default value and it isnt set in process.env that it then will be set.

Motivation

this would allow one to use the library to set variables for other libraries

default value array - type error

Describe the bug

When trying to set a default value for an array, it gives an type error.

Steps to reproduce

const result = envConverter.convert([
  {
    name: "DEFAULT_ARRAY",
    type: "string",
    array: true,
    default: ["default1", "default2", "default3"],  // <- type error there
  },
])

Expected behavior

I expect it to enforce an array and be happy with it

Environment

• Version: 562c30e

Other information

fix:

export interface EnvironmentalityPropertyOptions<
  T extends EnvironmentalityPropertyTypes,
  IsArray extends boolean,
> {
  /*
   * The name of the environment variable to use. Defaults to the property name.
   */
  name?: string
  /*
   * Whether the environment variable is required. Defaults to true.
   */
  required?: boolean
  /*
   * The default value to use if the environment variable is not set. Defaults to undefined.
   */
  default?: IsArray extends true
    ? EnvironmentalityPropertyTypesConstructor<T>[]
    : EnvironmentalityPropertyTypesConstructor<T>
  /*
   * The type of the environment variable. Defaults to string.
   */
  type?: T
  array?: IsArray
  enumValues?: EnvironmentalityPropertyTypesConstructor<T>[]
}

export type EnvironmentalityPropertyOptionsAny =
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  EnvironmentalityPropertyOptions<any, any>

escape symbols when parsing

Describe the feature

i would like to be able to escape characters from being used for parsing

Example

escape , eg in lists by doing \,
same for other symbols

"a,b\,c,d" => ["a", "b,c", "d"]

Motivation

this would allow parsed characters to be in strings

import doesn't allow class parsing

Describe the bug

i was trying to import like that:

import { Env, EnvVar } from "environmentality"

but i had to do that:

import environmentality from "environmentality"
const { Env, EnvVar } = environmentality

Steps to reproduce

do as stated above

Expected behavior

i wanna do that maaaaan:

import { Env, EnvVar } from "environmentality"

Environment

• Version: 2.1.0

Other information

No response

default values per NODE_ENV

Describe the feature

i would love to be able to set a default value while testing or just have some kind of easyness while testing.

Example

like when node_env is test that the "required" becomes obsolete. only if the value is really called.

Motivation

make testing easier.