Npm：仅在作为依赖项安装时运行 postinstall 脚本

Question

我开发了一个 npm 包（“node_commons”），它包含在我的其他项目中，如下所示：

package.json（其他项目）

"node-commons": "git+ssh://git@stash.custom.domain.net:7999/npm/libs/node_commons.git"

node_commons 包是用 ES6 编写的，但是这个版本以后不支持了，所以我用一个 postinstall 脚本用 babel 转译它。

package.json (node_commons)

"postinstall": "babel src -d src"

这很好用。当包作为依赖项包含在我的项目中时，文件将被转译。

我的问题：当我开发 node_commons 包时，我使用npm install 来安装内部依赖项。但后来我不想转换它。 我只想在包作为依赖项安装时进行转译（例如在我的其他项目中）。有没有办法做到这一点？

类似这样的：

package.json (node_commons)

"postinstall-as-dependency": "babel src -d src"

Answer 1

如果我理解正确，您希望您的包仅在用户将其安装为依赖项 (npm install node-common) 时运行 postinstall 脚本？

当您的安装后脚本运行时，它具有可用的 npm_config_save_dev，当用户使用 --save-dev 标志安装软件包时，这是“真”：

"postinstall": "! [ $npm_config_save_dev ] && echo \"Installed as a dependency\" || \"Installed as a dev dependency\""

Answer 2

• 在模块根目录中创建.no-postinstall 文件。
• Mac 和 Linux： 将以下内容添加到 package.json："postinstall": "if [ ! -e .no-postinstall ]; then babel src -d src; fi"
• Windows： 将以下内容添加到package.json："postinstall": if exist .no-postinstall () else (babel src -d src)"
• 跨平台（更多工作）： 您可以创建一个节点脚本（即./my-script.js）并使用fs 模块，检查.no-postinstall 的存在并使用child_process.exec() 执行babel src -d src，如official doc here 中所述。将您的脚本添加到package.json："postinstall": node my-script.js

请注意，我使用的是 Mac，因此无法验证 Windows 版本。

说明

if [ ! -e .no-postinstall ] 检查给定文件的不存在（使用否定运算符!）。如果文件不存在，它将执行您的脚本。由于您将 .no-postinstall 文件添加到模块根目录，因此在安装内部模块时不会执行脚本。另一方面，将您的模块安装为依赖项的模块在其根目录中没有 .no-postinstall 文件，您的脚本将被执行。

.no-postinstall 不是特殊名称，您可以使用任何您选择的名称。

Answer 3

就我而言，我有一个安装后脚本，我只想在包没有作为依赖项安装时运行它。

这是我使用的package.json 脚本：

{
    [...]
    "scripts": {
        "@comment_postinstall": "Behavior of the node-js subscript below: if '.git' doesn't exist under my-lib, it's installed as a dep, so do nothing -- else, return error-code 1, causing patch-package to run.",
        "postinstall": "node -e \"let myLibAsDep = !require('fs').existsSync('.git'); if (!myLibAsDep) process.exit(1);\" || patch-package"
    },
    [...]
}

如果您希望脚本仅在作为依赖项安装时运行，您当然可以反转 if (!myLibAsDep)。

Answer 4

我有同样的问题，我有一个安装后脚本，我只想在包作为依赖项安装时运行它。

我在安装后脚本的顶部添加了：

if (!process.cwd().includes('node_modules')) {
 return;
}

然后它只在模块存在于node_modules 目录下时运行。