如何从包中设置一些环境变量。Json使用NPM启动像命令?

以下是我目前在package.json中的内容:

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

我想在启动脚本中设置环境变量(如NODE_ENV),同时仍然能够用一个命令启动应用程序,npm start。


当前回答

@luke的回答几乎就是我需要的!谢谢。

由于所选的答案非常简单(而且正确),但是很旧,我想提供一个替代方案,用于在运行脚本时从.env单独文件导入变量,并修复Luke的答案的一些限制。 试试这个:

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

然后,在你的package json中,你将创建一个设置变量的脚本,并在你需要它们的脚本之前运行它:

:::包。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,你可能会看到一个警告,你可以把它改成yarn set-env,或者用npm run set-env——scripts- prepending -node-path &&代替。

不同的环境

使用它的另一个优点是可以使用不同的环境变量。

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

请记住,当你有密钥、密码或敏感/个人数据时,不要将.env文件添加到git存储库中!

其他回答

突然我发现actionhero正在使用以下代码,这解决了我的问题,只是通过传递——NODE_ENV=生产在启动脚本命令选项。

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

我真的很感激接受其他人的答案谁知道更多更好的方法设置包中的环境变量。Json或init脚本,这些都是由别人引导的。

更新:由于npm RFC 21,这个解决方案可能会在npm v7中中断

警告:不知道这是否适用于纱线


NPM(和yarn)从包中传递大量数据。Json作为环境变量放入脚本中。使用npm run env查看它们。这在https://docs.npmjs.com/misc/scripts#environment中有文档,不仅适用于像prepublish这样的“生命周期”脚本,也适用于npm run执行的任何脚本。

你可以在代码中访问这些文件(例如process.env。npm_package_config_port在JS中),但它们已经可以用于运行脚本的shell,所以你也可以访问它们作为$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配置和yarn配置文档。 看起来yarn的读音是~/。NPMRC,所以NPM配置集影响两者,但yarn配置集写入~/。Yarnrc,所以只有纱线才能看到它:-(

注意:为了设置多个环境变量,脚本应该是这样的

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

当NODE_ENV环境变量被设置为“production”时,包中的所有devDependencies。当运行NPM install时,Json文件将被完全忽略。你也可以使用——production标志来强制执行:

npm install --production

要设置NODE_ENV,您可以使用这些方法中的任何一种

方法一:为所有节点应用设置NODE_ENV

窗口:

set NODE_ENV=production

Linux、macOS或其他基于unix的系统:

export NODE_ENV=production

这将为当前bash会话设置NODE_ENV,因此在此语句后启动的任何应用程序都将NODE_ENV设置为生产。

方法2:设置当前应用的NODE_ENV

NODE_ENV=production node app.js

这将仅为当前应用设置NODE_ENV。当我们想要在不同的环境中测试应用程序时,这很有帮助。

方法三:创建。env文件并使用

这使用了这里解释的想法。请参考这篇文章了解更详细的解释。

基本上,您创建一个.env文件,并运行一些bash脚本在环境上设置它们。

为了避免编写bash脚本,可以使用env-cmd包来加载.env文件中定义的环境变量。

env-cmd .env node app.js

方法四:使用跨环境包

这个包允许以一种方式为每个平台设置环境变量。

在用npm安装它之后,你可以把它添加到你的部署脚本中。Json格式如下:

"build:deploy": "cross-env NODE_ENV=production webpack"

你不应该在package.json中设置ENV变量。actionhero使用NODE_ENV允许您更改从./config文件中加载的配置选项。检查redis配置文件,并查看如何使用NODE_ENV来更改NODE_ENV=test中的数据库选项

如果你想使用其他ENV变量来设置东西(也许是HTTP端口),你仍然不需要改变package.json中的任何东西。例如,如果你在ENV中设置了PORT=1234,并且想在NODE_ENV=production中使用它作为HTTP端口,只需在相关的配置文件IE中引用它:

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