npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

puntoenv

v4.0.0

Published

Simple package that enables you to load .env files in to process.env and also do variable expansion in a predetermined order based on the NODE_ENV environment variable value.

Downloads

31

Readme

PuntoEnv

Test GitHub license

PuntoEnv is a simple package that enables you to load .env files in to process.env and also do variable expansion in a predetermined order based on the NODE_ENV environment variable value.

Motivation

I like how Next.js loads .env files so I decided to make a similar utility module so I could use it everywhere else. Under the hood, it uses dotenv and dotenv-expand packages.

Installation

npm i puntoenv

Getting Started

Setup is really simple, just pass in a path to the directory that has your .env files and that's it!

import { setupEnv } from 'puntoenv'

setupEnv('/path/to/your-dir/')

Custom ENV variable

Also note that NODE_ENV will be the default environment variable that will be checked, but you can use any other variable.

//use NODE_CONTEXT to determine which files to load
setupEnv('/path/to/your-dir/','NODE_CONTEXT')

Make sure you call the function as early as possible in your code.

Loaded file callback

You can pass in optional onLoad callback (to the options object), that will fire for every loaded file. Inside the callback there is info about the path, filename and the result of the dotEnv.config method call.

setupEnv(__dirname, {
  onLoad: (data) => {
    console.log('path ',data.path)
    console.log('filename ',data.filename)
    console.log('result ',data.result) // {error?: Error , parsed:Record<string,string>}
  },
})

How it works.

PuntoEnv will load .env files in a particular order. Environment variables are looked up in the following places, in order, stopping once the variable is found. Environment variables that already exist have the highest priority and will not be overwritten by .env files.

const value = process.env.NODE_ENV // production

- process.env
- .env.$(value).local // .env.production.local
- .env.local
- .env.$(value) // .env.production
- .env

One exception to this rule is when the NODE_ENV=test in that case *.local files will not be loaded as you expect tests to produce the same results for everyone (but you can use .env.test file).

I would also recommend adding all .env*.local files to the .gitignore file.

Variable expansion

After all the files have been processed, the variable expansion will take place. Before expansion:

SERVER=www.example.com:$PORT
PORT=3000

After expansion:

SERVER=www.example.com:3000
PORT=3000

License

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