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

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

Вот что у меня сейчас есть в моем package.json:

{
  ...
  "scripts": {
    "help": "tagove help",
    "start": "tagove start"
  }
  ...
}

Я хочу установить переменные окружения (например NODE_ENV) в сценарии запуска, но при этом запускать приложение можно всего одной командой npm start.

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

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

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

Примечание: envгарантирует, что он работает на разных платформах. Вы можете опустить его, если заботитесь только о Mac / Linux.

Просто используйте кросс-env пакета NPM . Супер просто. Работает на 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Переменная будет установлена перекрестная окр

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

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

Затем добавьте export $(cat .env | xargs) &&перед вашей командой сценария.

Пример:

{
  ...
  "scripts": {
    ...
    "start": "export $(cat .env | xargs) && echo do your thing here",
    "env": "export $(cat .env | xargs) && env",
    "env-windows": "export $(cat .env | xargs) && set"
  }
  ...
}

Для теста вы можете просмотреть переменные env, запустив npm run env(linux) или npm run env-windows(windows).

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

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

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

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

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

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

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

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 или сценарии инициализации или что-то вроде того, где приложение загружается кем-то другим.

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

./.env файл:

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

./package.json:

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

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

В моем сценарии все, что я хотел, первоначально, чтобы установить переменную, чтобы контролировать, защищать ли сервер с помощью аутентификации 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
    }
}

Возможно, это может помочь кому-то еще

{
  ...
  "scripts": {
    "start": "ENV NODE_ENV=production someapp --options"
  }
  ...
}

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

"scripts": {
  "aaa": "set TMP=test && npm run bbb",
  "bbb": "echo %TMP%"
}

npm run aaa

вывод: test

Смотрите этот ответ для деталей.

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

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

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

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

Вы не должны устанавливать переменные 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
      }
    }
  }
}

npm (и пряжа) передает много данных из 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?).

Раздел "config", кажется, предназначен для этого использования:

  "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/"
  } 

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

$ npm run start

> myproject@0.0.0 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

> myproject@0.0.0 start /home/cben/mydir
> node server.js $npm_package_config_port

Serving on localhost:8020

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

Ответ @ Люка был почти тот, который мне был нужен! Спасибо.

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

::: .env file :::

# 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, если у вас есть ключи, пароли или важные / личные данные!