string-env-interpolation

string-env-interpolation

Use string interpolation to provide Environment Variables.

Installation

yarn add string-env-interpolation
npm install string-env-interpolation

Usage

Let's say we have a config file: config.yaml.

debug: ${DEBUG:false}
name: ${NAME:"Development"}
user: ${USER}

Our library wants to be able to consume environment variables in index.js.

import { env } from "string-env-interpolation";
import { readFileSync } from "fs";

const content = env(readFileSync("./config.yaml", "utf-8"));

console.log(content);

Outputs:

DEBUG=true USER=kamil node index.js

# Output
debug: true
name: Development
user: kamil



NAME=Production USER=kamil node index.js

# Output
debug: false
name: Production
user: kamil

Similar packages

Other packages similar to string-env-interpolation

dotenv

dotenv is a popular package for loading environment variables from a .env file into process.env. While it doesn't directly interpolate strings, it is often used in conjunction with string interpolation libraries to manage environment variables. Unlike string-env-interpolation, dotenv focuses on loading and managing environment variables rather than string manipulation.

envsub

envsub is a tool for substituting environment variables in files. It provides similar functionality to string-env-interpolation but is more focused on file-based operations rather than direct string manipulation. It is useful for templating configuration files with environment variables.

mustache

Mustache is a logic-less template engine that can be used for string interpolation. It allows for more complex templating scenarios compared to string-env-interpolation, which is specifically designed for environment variable interpolation. Mustache can be used for a broader range of templating tasks beyond just environment variables.