README.md

env-assert

Setup (after install):

npx env-assert
yarn env-assert
pnpm env-assert

---

This will create an example config file

env-assert.config.ts

Here you can setup your required and optional environment variables

import type { CreateEnvVarsType } from "env-assert";

const required = ["FOO"] as const;
const optional = ["BAR"] as const;

const config = {
  required,
  optional,
};

export default config;

export type EnvVars = CreateEnvVarsType<typeof config>;

How to use

Run env-assert before any script, for example:

yarn env-assert && yarn build

Pass the type of your config to CreateEnvVarsType to receive a type that you can use to extend ProcessEnv, so you know what variables are available. 👌

global.d.ts

import { EnvVars } from "./env-assert.config";

export declare global {
  declare namespace NodeJS {
    interface ProcessEnv extends EnvVars {}
  }
}