Como definir variáveis ​​de ambiente no package.json

Como definir algumas variáveis ​​de ambiente de dentro package.jsonpara serem usadas com npm startcomandos semelhantes?

Aqui está o que eu tenho atualmente no meu package.json:

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

Eu quero definir variáveis ​​de ambiente (como NODE_ENV) no script de inicialização enquanto ainda consigo iniciar o aplicativo com apenas um comando npm start,.

Defina a variável de ambiente no comando de script:

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

Em seguida, use process.env.NODE_ENVno seu aplicativo.

Nota: envgarante que ele funcione entre plataformas. Você pode omitir se você se importa apenas com Mac / Linux.

Basta usar o pacote NPM entre env . Super fácil. Funciona em Windows, Linux e todos os ambientes. Observe que você não usa && para passar para a próxima tarefa. Você acabou de definir o ambiente e depois iniciar a próxima tarefa. Os nossos agradecimentos a @mikekidder pela sugestão em um dos comentários aqui.

Da documentação:

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

Observe que se você deseja definir vários vars globais, basta indicá-los em sucessão, seguidos pelo seu comando a ser executado.

Por fim, o comando que é executado (usando spawn) é:

webpack --config build/webpack.config.js

A NODE_ENVvariável de ambiente será definida por ambiente

Como geralmente trabalho com várias variáveis ​​de ambiente, acho útil mantê-las em um .envarquivo separado (ignore isso no controle de origem).

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

Em seguida, inclua export $(cat .env | xargs) &&antes do seu comando de script.

Exemplo:

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

Para um teste, você pode visualizar as variáveis ​​env executando npm run env(linux) ou npm run env-windows(windows).

Eu só queria adicionar meus dois centavos aqui para futuros exploradores de nós. No meu Ubuntu 14.04 o NODE_ENV=testnão funcionou, eu tive que usar export NODE_ENV=testdepois do qual NODE_ENV=testcomecei a trabalhar também, estranho.

No Windows, como já foi dito, você deve usar, set NODE_ENV=testmas para uma solução de plataforma cruzada, a biblioteca entre ambientes não pareceu fazer o truque e você realmente precisa de uma biblioteca para fazer isso:

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

As barras verticais são necessárias, caso contrário, o Windows trava no export NODE_ENVcomando não reconhecido : D. Não sei quanto ao espaço de fuga, mas só para ter certeza de que também os removi.

Tente isso no Windows, substituindo YOURENV:

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

de repente, descobri que o actionhero está usando o seguinte código, que resolveu meu problema, apenas passando a --NODE_ENV=productionopção de comando 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;
}

Eu realmente gostaria de aceitar a resposta de outra pessoa que conhece uma maneira melhor de definir variáveis ​​de ambiente no package.json ou no script init ou algo parecido, onde o aplicativo é inicializado por outra pessoa.

Para um conjunto maior de variáveis ​​de ambiente ou quando você deseja reutilizá-las, pode usar env-cmd.

./.env Arquivo:

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

./package.json:

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

Embora não responda diretamente à pergunta, gostaria de compartilhar uma ideia sobre as outras respostas. Pelo que obtive, cada uma delas ofereceria algum nível de complexidade para obter independência entre plataformas.

No meu cenário, tudo que eu queria, originalmente, definir uma variável para controlar se protegia ou não o servidor com autenticação JWT (para fins de desenvolvimento)

Depois de ler as respostas, decidi simplesmente criar 2 arquivos diferentes, com a autenticação ativada e desativada, respectivamente.

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

Os arquivos são simplesmente invólucros que chamam o arquivo index.js original (ao qual renomei 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
    }
}

Talvez isso possa ajudar outra pessoa

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

Isso funcionará no console do Windows :

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

npm run aaa

resultado: test

Veja esta resposta para detalhes.

use git bash no windows. O Git Bash processa comandos de maneira diferente do cmd.

A maioria dos prompts de comando do Windows é bloqueada quando você define variáveis ​​de ambiente com NODE_ENV = produção como essa. (A exceção é o Bash no Windows, que usa o Bash nativo.) Da mesma forma, há uma diferença em como o Windows e os comandos POSIX utilizam variáveis ​​de ambiente. Com o POSIX, você usa: $ ENV_VAR e, no Windows,% ENV_VAR%. - documento entre env

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

use o pacote dotenv para declarar as variáveis ​​env

Você não deve definir variáveis ​​ENV em package.json. O actionhero usa NODE_ENVpara permitir que você altere as opções de configuração carregadas dos arquivos ./config. Confira o arquivo de configuração redis e veja como o NODE_ENV é usado para alterar as opções do banco de dados emNODE_ENV=test

Se você quiser usar outras variáveis ​​ENV para definir as coisas (talvez a porta HTTP), ainda não precisará alterar nada package.json. Por exemplo, se você definir PORT=1234em ENV e quiser usá-la como a porta HTTP NODE_ENV=production, apenas faça referência a isso no arquivo de configuração relevante, IE:

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

O npm (e yarn) passa muitos dados do package.json para scripts como variáveis ​​de ambiente. Use npm run envpara ver todos eles. Isso está documentado em https://docs.npmjs.com/misc/scripts#environment e não é apenas para scripts de "ciclo de vida", como prepublishtambém qualquer script executado por npm run.

Você pode acessar esses códigos internos (por exemplo, process.env.npm_package_config_portem JS), mas eles já estão disponíveis para o shell que está executando os scripts, para que você também possa acessá-los como $npm_...expansões nos "scripts" (sintaxe unix, pode não funcionar no Windows?).

A seção "config" parece destinada a esse uso:

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

Uma qualidade importante desses campos "config" é que os usuários podem substituí-los sem modificar o 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

Consulte os documentos de configuração do npm e de configuração do fio .
Parece que fio lê ~/.npmrctão npm config setafeta tanto, mas yarn config setescreve ~/.yarnrc, tão somente fio vai vê-lo :-(

A resposta de @ luke foi quase a que eu precisava! Obrigado.

Como a resposta selecionada é muito direta (e correta), mas antiga, gostaria de oferecer uma alternativa para importar variáveis ​​de um arquivo .env separado ao executar seus scripts e corrigir algumas limitações na resposta de Luke. Tente o seguinte:

::: arquivo .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"

Então, no seu pacote json, você criará um script que definirá as variáveis ​​e executará antes dos scripts necessários:

::: package.json :::

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

Algumas observações:

• A expressão regular no comando grep'ed cat limpará os comentários e as linhas vazias.

• O &&não precisa ser "colado" para npm run set-env, como seria necessário se você estava definindo as variáveis no mesmo comando.

• Se você estiver usando fio, poderá receber um aviso, pode alterá-lo yarn set-envou usá-lo npm run set-env --scripts-prepend-node-path &&.

Ambientes diferentes

Outra vantagem ao usá-lo é que você pode ter diferentes variáveis ​​de ambiente.

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

Por favor, lembre-se de não adicionar arquivos .env ao seu repositório git quando tiver chaves, senhas ou dados pessoais / sensíveis!