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 🙏

© 2021 – Pkg Stats / Ryan Hefner

promake-env

v2.1.1

Published

helps ensure promake rules will rerun when environment variables have changed

Downloads

275

Readme

promake-env

CircleCI Coverage Status semantic-release Commitizen friendly npm version

helps ensure promake rules will rerun when environment variables have changed

How it works

envRules you define write the values of the environment variables you specify to a target file you specify. However, it won't modify the file if the current values are equal to the ones in the file (from the last build), so by making the target file a prerequisite of another rule, you can ensure that rule will rerun whenever any of those environment variable values is different from the last build.

Usage

npm install --save promake-env

API

envRule(rule)(file, vars, [options])

First you create the function for defining environment rules by passing the rule function from Promake:

const Promake = require('promake')
const { rule } = new Promake()
const envRule = require('promake-env').envRule(rule)

Then you call the envRule function with (file, vars) to define a rule for creating and updating file.

Make sure to include file in the prerequisites of any other rules you want to rerun when the environment variables change.

file

The name of the file to write the environment variable values to.

vars

An array of environment variable names to check for changes and write to the file.

options.getEnv (optional, default: async () => process.env)

Allows you to customize which environment variables are used. Should be a function which returns a promise that will resolve to the environment variable hash you wish to use.

Example

Here's a make script for a babel project that makes sure it will recompile all the code when run with a different NODE_ENV or BABEL_ENV.

#!/usr/bin/env node

const Promake = require('promake')
const glob = require('glob').sync
const fs = require('fs-extra')

const buildEnv = 'lib/.buildEnv'
const srcFiles = glob('src/server/**/*.js')
const libFiles = srcFiles.map((file) => file.replace(/^src/, 'lib'))
const prerequisites = [
  ...srcFiles,
  buildEnv,
  '.babelrc',
  ...glob('src/**/.babelrc'),
]

const { rule, task, cli, exec } = new Promake()
const envRule = require('promake-env').envRule(rule)

envRule(buildEnv, ['NODE_ENV', 'BABEL_ENV'])
rule(libFiles, prerequisites, () => exec('babel src/ --out-dir lib'))

task('build', libFiles)

task('clean', () => fs.remove('build'))

cli()