Как установить переменные среды из package.json?

Задайте переменную среды в команде сценария:

...
"scripts": {
  "start": "node app.js",
  "test": "NODE_ENV=test mocha --reporter spec"
},
...

Затем используйте process.env.NODE_ENV в своем приложении.

Примечание. Это только для Mac и Linux. Для Windows см. Комментарии.

Просто используйте пакет NPM cross-env. Очень просто. Работает в Windows, Linux и во всех средах. Обратите внимание, что вы не используете && для перехода к следующей задаче. Вы просто устанавливаете env и запускаете следующую задачу. Благодарим @mikekidder за предложение в один из комментариев здесь.

Из документации:

{
  "scripts": {
    "build": "cross-env NODE_ENV=production OTHERFLAG=myValue webpack --config build/webpack.config.js"
  }
}

Обратите внимание, что если вы хотите установить несколько глобальных переменных, вы просто указываете их последовательно, а затем выполняете свою команду.

В конечном итоге команда, которая выполняется (с использованием spawn):

webpack --config build/webpack.config.js

Переменная среды NODE_ENV будет установлена ​​cross-env

Я просто хотел добавить сюда свои два цента для будущих исследователей узлов. На моем Ubuntu 14.04 NODE_ENV=test не работал, мне пришлось использовать export NODE_ENV=test, после чего NODE_ENV=test тоже начал работать, как ни странно.

В Windows, как уже говорилось, вы должны использовать set NODE_ENV=test, но для кросс-платформенного решения библиотека cross-env, похоже, не помогала, и вам действительно нужна библиотека для этого:

export NODE_ENV=test || set NODE_ENV=test&& yadda yadda

Вертикальные полосы необходимы, иначе Windows вылетит из-за нераспознанной команды export NODE_ENV. Я не знаю про конечное пространство, но на всякий случай я их тоже удалил.

Поскольку я часто работаю с несколькими переменными среды, я считаю полезным хранить их в отдельном файле .env (обязательно игнорируйте это в системе управления версиями). Затем (в Linux) добавьте export $(cat .env | xargs) && в команду сценария перед запуском приложения.

Пример .env файла:

VAR_A=Hello World
VAR_B=format the .env file like this with new vars separated by a line break

Пример index.js:

console.log('Test', process.env.VAR_A, process.env.VAR_B);

Пример package.json:

{
  ...
  "scripts": {
    "start": "node index.js",

    "env-linux": "export $(cat .env | xargs) && env",
    "start-linux": "export $(cat .env | xargs) && npm start",

    "env-windows": "(for /F \"tokens=*\" %i in (.env) do set %i)",
    "start-windows": "(for /F \"tokens=*\" %i in (.env) do set %i) && npm start",

  }
  ...
}

К сожалению, я не могу установить переменные среды, вызывая сценарий из сценария, например "start-windows": "npm run env-windows && npm start", поэтому в сценариях есть некоторая избыточность.

В качестве теста вы можете увидеть переменные env, запустив npm run env-linux или npm run env-windows, и проверить, попадают ли они в ваше приложение, запустив npm run start-linux или npm run start-windows.

Попробуйте это в Windows, заменив YOURENV:

  {
    ...
     "scripts": {
       "help": "set NODE_ENV=YOURENV && tagove help",
       "start": "set NODE_ENV=YOURENV && tagove start"
     }
    ...
  }

внезапно я обнаружил, что actionhero использует следующий код, который решил мою проблему, просто передав --NODE_ENV=production в параметре команды start script.

if(argv['NODE_ENV'] != null){
  api.env = argv['NODE_ENV'];
} else if(process.env.NODE_ENV != null){
  api.env = process.env.NODE_ENV;
}

Я был бы очень признателен, если бы принял ответ кого-то еще, кто знает более лучший способ установить переменные среды в package.json или init script или что-то в этом роде, где приложение загружается кем-то другим.

Для большего набора переменных среды или когда вы хотите их повторно использовать, вы можете использовать env-cmd.

./.env файл:

# This is a comment
ENV1=THANKS
ENV2=FOR ALL
ENV3=THE FISH

./package.json:

{
  "scripts": {
    "test": "env-cmd mocha -R spec"
  }
}

Это будет работать в консоли Windows:

"scripts": {
  "setAndStart": "set TMP=test&& node index.js",
  "otherScriptCmd": "echo %TMP%"
}

npm run aaa

вывод: test

Дополнительные сведения см. В этом ответе.

Ответ @ luke был почти тем, что мне было нужно! Спасибо.

Поскольку выбранный ответ очень простой (и правильный), но старый, я хотел бы предложить альтернативу для импорта переменных из отдельного файла .env при запуске ваших скриптов и исправления некоторых ограничений для ответа Люка. Попробуй это:

::: .env файл :::

# This way, you CAN use comments in your .env files
NODE_PATH="src/"

# You can also have extra/empty lines in it
SASS_PATH="node_modules:src/styles"

Затем в своем пакете json вы создадите скрипт, который установит переменные и запустит его перед скриптами, которые вам понадобятся:

::: package.json :::

scripts: {
  "set-env": "export $(cat .env | grep \"^[^#;]\" |xargs)",
  "storybook": "npm run set-env && start-storybook -s public"
}

Некоторые наблюдения:

• Регулярное выражение в команде grep'ed cat очистит комментарии и пустые строки.

• && не нужно приклеивать к npm run set-env, поскольку это потребовалось бы, если бы вы устанавливали переменные в той же команде.

• Если вы используете пряжу, вы можете увидеть предупреждение, вы можете либо изменить его на yarn set-env, либо использовать вместо этого npm run set-env --scripts-prepend-node-path &&.

Различная среда

Еще одно преимущество при его использовании заключается в том, что у вас могут быть разные переменные среды.

scripts: {
  "set-env:production": "export $(cat .production.env | grep \"^[^#;]\" |xargs)",
  "set-env:development": "export $(cat .env | grep \"^[^#;]\" |xargs)",
}

Помните, что не добавляйте файлы .env в репозиторий git, если в них есть ключи, пароли или конфиденциальные / личные данные!

используйте git bash в окнах. Git Bash обрабатывает команды иначе, чем cmd.

Большинство командных строк Windows будут подавляться, если вы установите переменные среды с помощью NODE_ENV = production, как это. (Исключением является Bash в Windows, который использует собственный Bash.) Аналогичным образом, есть разница в том, как команды Windows и POSIX используют переменные среды. В POSIX вы используете: $ ENV_VAR, а в Windows вы используете% ENV_VAR%. - cross-env doc

{
  ...
  "scripts": {
    "help": "tagove help",
    "start": "env NODE_ENV=production tagove start"
  }
  ...
}

используйте пакет dotenv для объявления переменных env

UPDATE: This solution may break in npm v7 due to npm RFC 21

npm (и yarn) передает много данных из package.json в сценарии в качестве переменных среды. Используйте npm run env, чтобы увидеть их все. Это задокументировано в https://docs.npmjs.com/misc/scripts#environment и предназначен не только для сценариев жизненного цикла, таких как prepublish, но и для любых сценариев, выполняемых npm run.

Вы можете получить доступ к этому внутреннему коду (например, process.env.npm_package_config_port в JS), но они уже доступны для оболочки, запускающей сценарии, поэтому вы также можете получить к ним доступ как $npm_... расширения в сценариях (синтаксис unix, может не работать в Windows?).

Кажется, что конфигурационный раздел предназначен для этого использования:

  "name": "myproject",
  ...
  "config": {
    "port": "8010"
  },
  "scripts": {
    "start": "node server.js $npm_package_config_port",
    "test": "wait-on http://localhost:$npm_package_config_port/ && node test.js http://localhost:$npm_package_config_port/"
  } 

Важным качеством этих полей конфигурации является то, что пользователи могут переопределить их, не изменяя package.json!

$ npm run start

> [email protected] start /home/cben/mydir
> node server.js $npm_package_config_port

Serving on localhost:8010

$ npm config set myproject:port 8020
$ git diff package.json  # no change!
$ cat ~/.npmrc
myproject:port=8020

$ npm run start

> [email protected] start /home/cben/mydir
> node server.js $npm_package_config_port

Serving on localhost:8020

См. конфигурацию npm и yarn config docs.
Похоже, yarn читает ~/.npmrc, поэтому npm config set влияет на оба, но yarn config set записывает в ~/.yarnrc, так что только yarn будет видеть это :-(

Не отвечая напрямую на вопрос, я хотел бы поделиться идеей поверх других ответов. Из того, что я получил, каждый из них предлагает определенный уровень сложности для достижения кроссплатформенной независимости.

В моем сценарии все, что я хотел изначально, установить переменную, чтобы контролировать, нужно ли защищать сервер с помощью аутентификации JWT (для целей разработки)

Прочитав ответы, я решил просто создать 2 разных файла с включенной и выключенной аутентификацией соответственно.

  "scripts": {
    "dev": "nodemon --debug  index_auth.js",
    "devna": "nodemon --debug  index_no_auth.js",
  }

Файлы представляют собой просто оболочки, вызывающие исходный файл index.js (который я переименовал в appbootstrapper.js):

//index_no_auth.js authentication turned off
const bootstrapper = require('./appbootstrapper');
bootstrapper(false);

//index_auth.js authentication turned on
const bootstrapper = require('./appbootstrapper');
bootstrapper(true);

class AppBootStrapper {

    init(useauth) {
        //real initialization
    }
}

Возможно, это поможет кому-то другому

Не следует устанавливать переменные ENV в package.json. actionhero использует NODE_ENV, чтобы вы могли изменять параметры конфигурации, которые загружаются из файлов в ./config. Просмотрите файл конфигурации redis и посмотрите, как используется NODE_ENV изменить параметры базы данных в NODE_ENV=test

Если вы хотите использовать другие переменные ENV для настройки (например, HTTP-порт), вам все равно не нужно ничего менять в package.json. Например, если вы устанавливаете PORT=1234 в ENV и хотите использовать его в качестве порта HTTP в NODE_ENV=production, просто укажите это в соответствующем файле конфигурации IE:

# in config/servers/web.js
exports.production = { 
  servers: {
    web: function(api){
      return {
       port: process.env.PORT
      }
    }
  }
}

Для одной переменной среды

 "scripts": {
    "start": "set NODE_ENV=production&& node server.js"
 }

Для нескольких переменных среды

 "scripts": {
    "start": "set NODE_ENV=production&& set PORT=8000&& node server.js"
 }

Примечание. Чтобы установить несколько переменных среды, сценарий должен выглядеть следующим образом

  "scripts": {
    "start": "set NODE_ENV=production&& set MONGO_USER=your_DB_USER_NAME&& set MONGO_PASSWORD=DB_PASSWORD&& set MONGO_DEFAULT_DATABASE=DB_NAME&& node app.js",
  },

Переменные среды не имеют отношения к вашему приложению узла! Единственная роль process.env - предоставить вашему приложению переменные системной среды. Если вам нужно добавить переменные среды, вы должны добавить их в свой файл конфигурации docker / vm / vagrant, а не в стартовый скрипт вашего приложения.

Если вы собираетесь передать аргумент экземпляру узла, лучший и единственный способ - использовать node process.argv вместо rocess.env.

Единственный случай, когда вам нужно использовать process.env, - это то, что ваш облачный провайдер применяет некоторые конфигурации, которым должно соответствовать ваше приложение, даже в этом случае они устанавливают переменные среды, а не вы.

Вот как передать аргументы вашему приложению. Вы, наверное, уже знали.

node app.js  port=5000 profile=admin

Потом,

/**
 * Get the passed node argument by key.
 * @param key of node argument
 * @returns {string}
 */
export function getArg(key: string): string {
    return process.argv
        .map(e => e.split('=')) // [ [a b] , [c d]]
        .filter(e => e.length == 2) //[[a b], [c d]]
        .map(e => ({ [e[0]]: e[1] })) // [{a:b}, {c:d}]
        .reduce((p, c) => ({ ...p, ...c }))[key]
}

Пример сценария:

• Приложение имеет несколько профилей администратора, общедоступного и подписчика.
• Приложение запускается только по запросу пользователя (например, администратор хочет запустить приложение, затем вы запускаете приложение в профиле администратора)

package.json

{
"start:admin":"node  app.js profile=admin port=5000", 
"start:public":"node app.js profile=public port=5001", 
"start:subscriber":"node app.js profile=subscriber port=5002", 
}

Просто попробовал объяснить нюанс между process.env и process.argv.

Не принимайте близко к сердцу!