Polyglot dotenv parser and evaluator.
npm install @ju1ius/pointenv
Polyglot dotenv parser and evaluator.
``sh`
npm install @ju1ius/pointenv
* posix
* docker-compose
* symfony/dotenv
The formal dotenv syntax for this project is posix only.
The posix dialect is a subset of the POSIX shell syntax
and is compatible with shell scripts.
Support for other dotenv syntax dialects is included for interoperability purposes.
Compatibility will be improved gradually, but 100% compatibility is not always possible,
nor desirable (for example symfony supports shell command evaluation, which we don't for obvious reasons).
The default entrypoint for this module parses and evaluates
the given files in order, then injects the resulting variables
into the global environment object (process.env or Deno.env).
It returns a Map object containing the variables
that have been injected into the environment.
`ts
import pointenv from '@ju1ius/pointenv'
const applied = await pointenv(['.env', '.env.local'])
console.log(applied)
`
Variables that are already present in the environment have precedence
over those specified in the dotenv files, unless the override option is true:
`ts`
await pointenv(['.env'], {override: true})
If an env option is provided,
the variable resolution will use that instead of the global envionment.
This can be used i.e. for providing defaults for when a variable is not set in the environment.
`sh`.env
BAR="${FOO:-not found}"
`ts`
const env = await pointenv(['.env'], {
env: {
FOO: 'bar',
...process.env,
}
})
console.log(env.get('BAR')) // 'bar'
If you just want to parse and evaluate the files
without injecting anything into the environment,
use the load function:
`ts
import {load} from '@ju1ius/pointenv'
const env = await load(['.env'])
// env is a Map
// found in the provided files
console.log(env)
`
The dialect option can be set to one of the supported alternative dialects:
`ts``
import pointenv, {load, Dialect} from '@ju1ius/pointenv'
// use the docker-compose dialect
await pointenv(['.env'], {dialect: Dialect.Compose})
// use the symfony dialect
await load(['.env'], {dialect: Dialect.Symfony})