by-node-env

by-node-env

Run package.json scripts by NODE_ENV.

Installation

Install with npm:

npm install by-node-env

Install with pnpm:

pnpm install by-node-env

Install with Yarn:

yarn add by-node-env

Features

• Defaults NODE_ENV to development.
• Customize process.env for each NODE_ENV.
• Clearer, concise scripts.
• No more Bash-scripting in package.json.
• Works on Linux, macOS and Windows.
• Compatible with npm, pnpm and Yarn.
• Simplify your workflow:
  1. npm install or pnpm install or yarn add.
  2. npm start or pnpm start or yarn start.

Example

{
  // Processes spawned by `by-node-env` inherit environment-specific
  // variables, if defined.
  "by-node-env": {
    "production": {
      "DOCKER_USER": "my",
      "DOCKER_REPO": "project"
    }
  },
  "scripts": {
    // If NODE_ENV is missing, defaults to "development".
    "build": "by-node-env",

    "build:development": "webpack -d --watch",
    "build:staging": "webpack -p",
    "build:production": "webpack -p",

    // Deployment won't work unless NODE_ENV=production is explicitly set.
    "deploy": "by-node-env",

    "predeploy:production": "docker build -t ${DOCKER_USER}/${DOCKER_PROJECT} .",
    "deploy:production": "docker push ${DOCKER_USER}/${DOCKER_PROJECT}",

    // "npm start" is _the_ command to start the server across all environments.
    "start": "by-node-env",

    "start:development": "npm run build:development",

    "prestart:production": "npm run build",
    "start:production": "start-cluster build/server/server.js",

    "prestart:staging": "npm run build",
    "start:staging": "start-cluster build/server/server.js",

    // Explicitly set NODE_ENV, which is helpful in CI.
    "test": "NODE_ENV=test by-node-env",

    "test:test": "mocha"
  }
}

Note

by-node-env is essentially a clone of per-env with some notable fixes:

• pnpm compatibility.
• Windows compatibility.
• Yarn compatibility.

Contributing

Do you encounter bugs or having new ideas?

Issues, comments and PRs are always welcomed!

Changelog

1.1.0 (2019-06-14)

• Changed support of Yarn from process.env.npm_execpath to which-pm-runs which detects process.env.npm_config_user_agent, with additional pnpm support.