Giter Club home page Giter Club logo

notenv's Introduction

notenv

notenv is a "replacement" for a dumb uses of .env files. You really shouldn't use .env files. Any production secret that would live in a .env should never live on some engineers computer. And in many cases, any development "secret" should be so unimportant that it's fine to put it in source control.

For example, you don't need to put your "password" for the development postgres in .env if it's just something running locally on a developer's laptop.

The general rule of thumb: if you're worried about committing a secret to source control, it probably shouldn't be living on some engineers computer either.

Install

yarn add notenv

Usage

notenv lets you proclaim the existence of an environment variables and then get them later on with a type-safe getter.

import proclaim from "notenv";

const env = proclaim({
  DATABASE_PASSWORD: "my-development-password"
});

env("DATABASE_PASSWORD"); // returns "my-development-password" when NODE_ENV !== "production"
env("ARGLE_BARGLE"); // Fails typecheck

If you're in production and it can't find it in process.env[key], it'll throw an error. Otherwise, it'll use the development value, (the property in the object).

The suggested way to use notenv is to create a env.js (or env.ts) file somewhere and then export all your environment variables from there.

// env.js
import proclaim from "notenv";

export default proclaim({
  DATABASE_URL: "postgres://localhost...",
  DATABASE_USER: "local",
  DATABASE_PASSWORD: "dummy-buddy"
});

Then in some other file, you can use env variables like this:

import env from "./env.js";

env("DATABASE_USER");

notenv's People

Contributors

flaque avatar

Stargazers

Roman avatar Harald Hanek avatar Alexey avatar John Dori avatar  avatar Mark Old avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.