package.json 是否支持复合变量？

Question

一个尊重构建工件的 semver 目录结构的项目即将开始，而 package.json 或 .nmprc 似乎是定义此元数据的正确位置。这是一些初步代码，演示了如何实现目标：

{
  "name": "com.vendor.product"
, "version": "0.0.0"
, "directories": {
    "build": "./out"
  }
, "main": "./${npm_directories_build}/${npm_package_name}/${npm_package_version}/${npm_package_name}.js"
, "exports": "${npm_package_main}"
, "scripts": {
    "echo": "echo\"${npm_package_exports}\""
  }
}

我期待

npm run echo

将复合变量结果打印到标准输出，

./out/com.vendor.product/0.0.0/com.vendor.product.js

但是，它打印文字文本

${npm_package_export}

我尝试在 .npmrc 中使用数组变量

outpath[]=./out
outpath[]=/${npm_package_name}
outpath[]=/${npm_package_version}

但是

...
{
  "echo": "echo \"${npm_config_outpath}\""
}

只打印一个空的换行符

预计 package.json 支持复合变量，但这个假设现在受到质疑。我检查了文档，但要么我遗漏了某些东西，要么没有定义。应避免长时间重复相同的数据（例如，多次引用包变量以创建单个路径）。它旨在让包名称和版本始终以可靠和可预测的方式指示构建文件的位置。 如果不支持复合变量，您能否阐明 .npmrc 数组变量的实际工作方式？如果做不到这一点，你能推荐一种替代方法来达到同样的目的吗？非常感谢！

搜索的文档：

• https://docs.npmjs.com/misc/config
• https://docs.npmjs.com/files/npmrc
• https://docs.npmjs.com/configuring-npm/npmrc.html
• https://docs.npmjs.com/files/package.json#config
• http://doc.codingdict.com/npm-ref/misc/config.html#config-settings
• https://github.com/npm/ini

Answer 1

简答：

“package.json 是否支持复合变量？”

很遗憾，不，不是您想要使用它们的方式。它只有package json vars，只能在npm scripts 中使用。例如在 *Nix 上将 echo 脚本定义为：

"echo": "echo $npm_package_version"

或在 Windows 上将其定义为：

"echo": "echo %npm_package_version%"

将打印版本，例如0.0.0.

_{注意：cross-env 为跨平台工作的单一语法提供了解决方案。}

除了scripts 部分之外，您当然不能在 package.json 字段中的其他位置包含 parameter substitution ${...}。

---

附加信息：

关于您随后的评论：

.npmrc 中定义的数组值如何在 package.json 中使用

AFAIK 我不认为你可以。例如，假设我们；

1. 将这个人为的.npmrc保存在项目目录的根目录中。

   .npmrc

   quux[]="one"
   quux[]="two"
   quux[]="three"
   
   foo=foobar
   

2. 然后cd到项目目录，运行以下命令打印所有环境变量：

   npm run env
   

   如您所见，npm_config_foo=foobar 环境变量已被 npm 添加。但是对于quux 数组，没有添加npm_config_quux=[ ... ] 环境变量。

   因此，在使用 package.json vars 的 npm 脚本中，以下操作确实有效：

   "echo": "echo $npm_config_foo"
   

   但是以下（用于引用数组）不存在 - 仅仅是因为它不存在；

   "echo": "echo $npm_config_quux"
   

---

ini node.js 包：

也许考虑研究 npm 用于解析 .npmrc 文件的 ini node.js 包。例如：

1. 如果你运行以下命令在你的项目中安装包：

   npm i -D ini
   

2. 然后按此定义 npm echo 脚本：

   "scripts": {
     "echo": "node -e \"var fs = require('fs'), ini = require('ini'); var config = ini.parse(fs.readFileSync('./.npmrc', 'utf-8')); console.log(config.quux)\""
   }
   

   请注意，它使用 nodejs 命令行选项 -e 来评估 JavaScript 代码。它基本上执行以下操作：

   var fs = require('fs'),
       ini = require('ini');
   
   var config = ini.parse(fs.readFileSync('./.npmrc', 'utf-8'));
   console.log(config.quux);
   

3. 然后给出我之前在运行时提到的人为的.npmrc文件：

   npm run echo
   

   它会打印出来：

   [ 'one', 'two', 'three' ]