npm脚本：读取。env文件

Question

我有一个简单的要求：在我的npm脚本包中。json文件我有一行：

json prettyprint-override">{
    "scripts": {
        "example": "some-lib --argument --domain \"https://tld.com\""
    }
}

现在我想把“域”分解出来。

首先尝试使用$npm_package_config，它有效：

{
    "config": {
        "domain": "https://tld.com"
    },
    "scripts": {
        "example": "some-lib --argument --domain \"$npm_package_config_domain\""
    }
}

但我想从本地加载域。env文件。

我没有找到任何解决方案来读取命令行上npm脚本中的env文件内容。

谁能给我一个可能解决这个问题的提示吗？

Answer 1

假设您有一个。env文件如下：

DOMAIN="https://tld.com"

然后，您可以在命令中使用源代码，如下所示：

{
    // ...
    "scripts": {
        "example": "source .env && some-lib --argument --domain $DOMAIN"
    }
}

默认情况下，这在Windows中不起作用，但如果安装了Git Bash，则可以配置npm使用它运行命令，例如（从这里）：

npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"

Answer 2

一个更简单的解决方案是，只需使用bash在线解析env文件并提取所需的变量：

假设您的<代码>。env文件如下所示：

DOMAIN=https://tld.com

"scripts": {
  "example": "some-lib --argument --domain $(grep DOMAIN .env | cut -d '=' -f2)"
} 

Answer 3

简短回答：没有简单的方法可以跨平台实现这一点，正如您的第二个示例所示，它引用了变量npm\u package\u config。

对于跨平台解决方案，即在*nix和Windows平台上都能成功工作的解决方案，npm脚本使用的默认shell分别是sh或cmd，您需要通过nodejs帮助脚本执行命令（即当前在npm脚本中定义的命令）。基本上，您的nodejs脚本需要：

• 利用dotenv包加载。env文件

然后可以通过您的npm-script调用nodejs助手脚本。

下面介绍如何实现跨平台运行的解决方案。

首先，假设我们有一个。env文件位于项目目录的根目录中。<代码>。env文件包含以下条目：

DOMAIN=https://tld.com

以下nodejs脚本利用dotenv包从加载环境变量。env文件。我们需要安装它。要对项目目录执行此操作，请运行以下命令：

npm i -D dotenv

接下来创建一个nodejs脚本，如下所示。让我们将文件命名为某个lib cmd。js并将其保存在项目目录的根目录中：

// Requirements...
require('dotenv').config();
const execSync = require('child_process').execSync;
const path = require("path");

/**
 * Creates a path to an executable in the node_modules/.bin directory. Each
 * path segment is joined with the appropriate platform-specific separator as
 * a delimiter.
 * @param {String} cmd The name of the executable.
 * @returns {String} The path to the executable.
 */
function getBinFile(cmd) {
  return path.join('node_modules', '.bin', cmd);
}

// Execute the command...
execSync(`${getBinFile('some-lib')} --argument --domain ${process.env.DOMAIN}`, { stdio: [0, 1, 2] });

备注：

>

如果您的. env文件没有与some-lib-cmd.js一起驻留在项目目录的根目录中，那么您可以使用dotenv的path选项来定义指向. env文件位置的自定义路径。例如：

require('dotenv').config({ path: 'path/to/another/folder/' })

要从nodejs脚本中引用域变量，我们使用过程。env，即过程。环境。域。

在package.json的脚本部分中定义以下脚本：

"scripts": {
  "example": "node some-lib-cmd"
}

注意：如果您选择保存一些lib cmd。js，即不在项目目录的根目录中，然后根据需要在示例脚本中重新定义路径。例如：

"scripts": {
  "example": "node path/to/some/folder/some-lib-cmd"
}