dotenv-local

dotenv-local

dotenv-local is a utility library for loading environment variables in a specific order of priority.

Installation

npm install dotenv-local
# or
yarn add dotenv-local

Usage

Import the library

import { loadEnv, LoadEnvOpts } from "dotenv-local";

Define the options

const opts: LoadEnvOpts = {
  envDir: "/path/to/env/files",
  mode: "production",
  envPrefix: ["APP_"],
  envInitial: {
    DEFAULT_VAR: "default_value",
  },
  removeEnvPrefix: false,
  encoding: "utf-8",
};

Use the library

const envVariables = loadEnv(opts);
console.log(envVariables);

Options

• envDir: Directory where the environment files are located. Default: Current working directory (process.cwd()).
• mode: Application mode, used to determine which environment files to load. Default: process.env.NODE_ENV || "production".
• envPrefix: Prefix for environment variables to be loaded. Default: 'APP_'.
• envInitial: Initial values for environment variables. Default: {}.
• removeEnvPrefix: Whether to remove the prefix from loaded environment variables. Default: false.
• encoding: Encoding of the environment files. Default: 'utf-8'.

Prioritizing File Loading with getEnvFilesForMode Function

This library determines the order of environment file loading based on the provided mode (mode=development).

[".env", ".env.local", ".env.development", ".env.development.local"];

The array represents the priority order in which environment files will be loaded. In the given example, the files are loaded in the following sequence: .env, .env.local, .env.development, and finally .env.development.local. This prioritization ensures that variables defined in files with later positions in the array will override those defined in earlier files.

Examples

Basic Usage

import { loadEnv } from "dotenv-local";
const envVariables = loadEnv();
console.log(envVariables);

Custom Options

import { loadEnv } from "dotenv-local";
const customOptions = {
  envDir: "/path/to/custom/env/files",
  mode: "staging",
  envPrefix: ["API_", "MONGO_"],
  envInitial: {
    INITIAL_VAR: "initial_value",
  },
  removeEnvPrefix: true,
  encoding: "utf-16",
};
const envVariables = loadEnv(customOptions);
console.log(envVariables);

License

This project is licensed under the MIT License - see the LICENSE file for details.