majortom327 / env-refiner

Handle your environment to ensure your secrets, and define it from external files

Env-Refiner

A simple project to manage the environment of the application, share it in the repository without exposing secret and validate an environment.

• Installation
• Usage
  • Define your dotenv
  • Load the environment
  • Render the environment to a file
  • Get the environment as a Record
    • All the environment
    • Only the public environment
• Definition of placeholder
  • env
  • docker
  • uuid
  • date
• Placeholders in WIP status
  • random
  • file
  • base64
  • base64file

Installation

npm install env-refiner
yarn add env-refiner

CLI Usage

You can also use the cli to render a .env file based on a template.

# Long version
yarn env-refiner --input template.env --output .env

# Short version
yarn env-refiner -i template.env -o .env

Usage

This librairie enable you define your dotenv with placeholde. That mean, you can define where it would load the informations and replace the placeholder. That way you can have your dotenv in the repository. Load the information from your environment or directly from your docker compose.

Define your dotenv

# .env
# Load from the environment
APP_NAME={{env:APP_NAME}}

# DATABASE_URL={{docker:db.DB_URL}}

# Load from the docker compose (from the service "db" environment)
POSTGRES_USER={{docker:db.POSTGRES_USER}}
POSTGRES_PASSWORD={{docker:db.POSTGRES_PASSWORD}}
POSTGRES_DB={{docker:db.POSTGRES_DB}}

# Generate a uuid for this variable at each restart
COOKIE_SECRET={{uuid}}

Load the environment

import configure from 'env-refiner'

const env = configure({})

// Will print the value of the environment variable APP_NAME loaded from the environment
console.log(env.get('APP_NAME'))


// Will print the value of the environment variable DATABASE_URL loaded from the docker compose
console.log(env.get('DATABASE_URL'))

You can define a schema to validate the environments variables and especially to remove the unused environment variables:

import * as zod from 'zod';
import configure from 'env-refiner';

const schema = zod.object({
  APP_NAME: zod.string(),
  DATABASE_URL: zod.string(),
});

const env = configure({ schema });

// Will print the value of the environment variable APP_NAME loaded from the environment
console.log(env.get('APP_NAME'));

// Will print the value of the environment variable DATABASE_URL loaded from the docker compose
console.log(env.get('DATABASE_URL'));

console.log(env.get('POSTGRES_USER')); // Will return undefined

This beahviour is useful to just have what you need in your environment and ensure to not access to variable that should not be used.

Note: A variable loaded from the docker compose will be send to the schema validator too. So you can validate the value of the variable loaded from the docker compose too.

You may want to have default value ? You can do it with the schema:

import * as zod from 'zod';
import configure from 'env-refiner';

const publicEnvSchema = zod.object({
  APP_NAME: zod.string().default('My App'),
});

const schema = zod.object({
  DATABASE_URL: zod.string(),
}).merge(publicEnvSchema);

const env = configure({ schema });


console.log(env.get('APP_NAME')); // Will print "My App" if not set in environment

// Only a subset of the environment, useful to send to the client for example
const publicEnv = env.getPublicEnv();

// All the environment, useful to send to the server for example
const allEnv = env.getEnv();

Advanced usage

You totally can define a variable that should load multiple other variables from multiples sources.

This can be useful if you have to compose a url from multiple variables for example. In the following example, we will load the database url from the docker compose and the database name from the environment.

# .env

DATABASE_URL="postgresql://{{docker:postgres.POSTGRES_USER}}:{{docker:postgres.POSTGRES_PASSWORD}}@localhost:5432/{{docker:postgres.POSTGRES_DB}}"

Render the environment to a file

if you want you can use a template env and render it to a file with the value of the environment. This could be useful if you want to generate a dotenv file for your docker compose for example or something else. You do what you want, I don't judge.

import * as zod from 'zod';
import configure from 'env-refiner';

const schema = zod.object({
  APP_NAME: zod.string(),
  DATABASE_URL: zod.string(),
});


const env = configure({ schema, envFile: 'template.env' });

// This will write a new rendered .env file based on the template.env file
env.renderToFile('.env');

Get the environment as a Record

All the environment

You should be able to access all the environment variables as a Record<string, string> with the getEnv method.

import * as zod from 'zod';
import configure from 'env-refiner';

const publicEnvSchema = zod.object({
  APP_NAME: zod.string().default('My App'),
});

const schema = zod.object({
  DATABASE_URL: zod.string(),
}).merge(publicEnvSchema);

const env = configure({ schema });

// Here you get all the environment variables as a Record<string, string>
const allEnv = env.getEnv();

Only the public environment

If you want to limite to a subset of items as a public environment, that way you can limit to a subset of the environment.

import * as zod from 'zod';
import configure from 'env-refiner';

const publicEnvSchema = zod.object({
  APP_NAME: zod.string().default('My App'),
});

const schema = zod.object({
  DATABASE_URL: zod.string(),
}).merge(publicEnvSchema);

const env = configure({ schema });

// Here you can get a subset of the environment variable that could be used to be sent to the client for example
const publicEnv = env.getPublicEnv();

Definition of placeholder

To define a placeholder you must use a basic format: {{source:variable}}. Depending of the source, the variable part can be a bit different.

Here is a list of the available source:

env

{{env:variable_name}}

This make you able to load a variable from the environment. It will be replaced with the found variable in the process.env[variable_name].

Example:

APP_NAME={{env:APP_NAME}}

docker

{{docker:service.variable_name}}

This one is a bit different, it will load the variable from the docker file by using the service name and the variable name.

The service and the variable name being separated by a dot.

Example:

POSTGRES_USER={{docker:db.POSTGRES_USER}}

uuid

{{uuid}}

This one will generate a uuid at each restart of the application. It can be useful to generate a secret for example.

Example:

COOKIE_SECRET={{uuid}}

date

{{date}}

This will replace the value by the current date in ISO format. This can be useful to have a timestamp for example.

Example:

LAST_START={{date}}

---

Placeholders in WIP status

random

{{random}}

This will replace the value by a random string. This can be useful to have a secret for example.

file

{{file:path/to/file}}

This will replace the value by the content of the file. This can be useful to load a certificate for example.

base64

{{base64:variable}}

This will replace the value by the base64 encoded value of the variable. This can be useful to load a certificate for example.

base64file

{{base64file:path/to/file}}

This will replace the value by the base64 encoded value of the file. This can be useful to load a certificate for example.