ericclemmons / if-env Goto Github PK

View Code? Open in Web Editor NEW

97.0 4.0 14.0 7 KB

Simplify npm scripts with `if-env ... && npm run this || npm run that`

License: MIT License

JavaScript 100.00%

if-env's Introduction

if-env

Simplify npm scripts with if-env ... && npm run this || npm run that

I recommend switching to per-env, which is much simpler and much more powerful!

Suppose you want to simplify development and be able to run npm start in all environments & run the correct scripts.

Your package.json might look like this:

"scripts": {
  "start": "if [[ ${NODE_ENV} == \"production\" ]]; then npm run start:prod; else npm run start:dev; fi",
  "start:dev": "webpack",
  "start:prod": "start-cluster"
}

The problem is, this doesn't work in all environments.

Instead, you can write:

"scripts": {
  "start": "if-env NODE_ENV=production && npm run start:prod || npm run start:dev",
  "start:dev": "webpack",
  "start:prod": "start-cluster"
}

Usage

1. Install

$ npm install if-env --save

2. Add to `package.json`

"scripts": {
  "start": "if-env SOME_ENV_VAR=some_val ANOTHER_ENV_VAR=another_val && npm run this || npm run that"
}

License

MIT © Eric Clemmons 2015

if-env's People

Contributors

Stargazers

Watchers

Forkers

ryanflorence loris reganhe dpr00f handtrix nicolaischmid ericyahoo2 netanelbasal kamzh88 mjlhthomassen-sorama jvanoers

if-env's Issues

Does it work with husky?

HI, I would like to implement this module in husky.

I am using a package called post-npm-install to automatically update dependencies on merge or rebase. I do not want to do it in PROD environment. This is what I have done.

"husky": { "hooks": { "pre-commit": "lint-staged", "post-merge": "if-env NODE_ENV != 'production' && post-npm-install", "post-rebase": "if-env NODE_ENV != 'production' && post-npm-install" } },

This doesnt work. Should I do something to make this work? Please advice.

bump npm-run-all version

npm-run-all version 1.4.0 has vulnerabilities.
See here.

Update version to at least 4.1.4 to fix the issue.

Failed to work in docker

My npm script likes this:

"scripts": {
"start": "if-env NODE_ENV=production ?? npm run start:prod || npm run start:dev",
"start:dev": "DEBUG=dummy-app:* node --inspect ./bin/www",
"start:prod": "node ./bin/www"
}

Then I run NODE_ENV=production npm start but it did not work。

if-env NODE_ENV=production && npm run start:prod || npm start:dev

This command may play really bad joke with you, I learned it a hard way

if-env NODE_ENV=production && npm run start:prod || npm start:dev

if your app dies on unhandled exception then npm run start:prod returns no-zero code, then this expression proceeds to the npm start:dev and restarts your app in dev mode

Does not work with bash scripts?

The only difference from the example I see is not using nom run (and setting the env value) in:
"test" : "NODE_ENV='production' && if-env NODE_ENV==production && echo 'prod' $NODE_ENV || echo 'dev' $NODE_ENV",

The output I get (in Mac OS Sierra):
dev production

Do I use it wrongly or did I met a limitation?

Breaking - Don't use && and ||

Example:

if-env NODE_ENV=production && npm run webpack:prod || npm run webpack:dev

If webpack:prod fails, then webpack:dev runs. This isn't the desired behavior, as if-env only helps when everything works.