如何实现安装自定义npm包后自动向项目package.json添加脚本？

要实现像jest那样，用户安装你的包后自动在项目package.json中添加运行脚本，可以通过npm生命周期脚本结合Node代码修改文件来完成，具体步骤如下：

一、利用postinstall生命周期脚本 #

postinstall是npm提供的安装后钩子，会在用户成功安装你的包后自动执行，适合用来修改项目的package.json。

1. 配置包的package.json #

在你的自定义npm包的package.json中，添加postinstall脚本，指向你编写的处理文件：

{
  "name": "your-package-name",
  "version": "1.0.0",
  "scripts": {
    "postinstall": "node ./scripts/add-script.js"
  }
}

2. 编写修改package.json的脚本 #

在你的包目录下创建scripts/add-script.js文件，编写以下代码：

const fs = require('fs');
const path = require('path');

// 定位到用户项目根目录的package.json
const projectPackagePath = path.resolve(__dirname, '../../package.json');
const projectPackage = require(projectPackagePath);

// 定义要添加的脚本信息
const targetScriptName = 'my-run-script';
// 如果你的包配置了bin字段，这里可以直接写包名，否则写具体执行路径
const targetScriptCommand = 'your-package-name'; 

// 初始化scripts字段（如果项目package.json里没有的话）
if (!projectPackage.scripts) {
  projectPackage.scripts = {};
}

// 避免重复添加相同脚本
if (!projectPackage.scripts[targetScriptName]) {
  projectPackage.scripts[targetScriptName] = targetScriptCommand;
}

// 写入修改后的package.json，保留格式化
fs.writeFileSync(projectPackagePath, JSON.stringify(projectPackage, null, 2));

二、关于prepare脚本的说明 #

你提到的prepare脚本确实可以用，但它的触发时机更多：既会在包发布前执行，也会在用户安装包后执行。如果用它来修改package.json，需要额外判断当前环境是本地开发还是用户安装，否则会在你自己开发包时修改本地的package.json。比如可以通过判断当前目录是否包含.git文件夹（开发环境一般有）来区分，或者检查process.env.npm_lifecycle_event的上下文。

如果你的需求只是用户安装时添加脚本，postinstall更直接，不需要额外判断。

三、更优雅的执行方式：配置bin字段 #

像jest那样直接用包名作为命令，是因为jest在package.json中配置了bin字段，npm会自动将指定的文件链接到项目的node_modules/.bin目录，用户可以直接调用。

1. 配置包的bin字段 #

在你的包的package.json中添加：

{
  "bin": {
    "your-package-name": "./main.js"
  }
}

2. 给执行文件添加shebang #

在你的包的入口文件（比如main.js）开头添加一行shebang，让系统知道用Node执行：

#!/usr/bin/env node

// 你的包核心代码
console.log('Hello from my custom package!');

这样配置后，用户安装包后，直接在终端输入your-package-name就能运行你的包，所以之前add-script.js里的targetScriptCommand直接写包名即可，和jest的用法一致。

四、注意事项 #

• 重复添加防护：一定要判断脚本是否已存在，避免用户多次安装包时重复写入相同脚本。
• 卸载清理（可选）：如果需要在用户卸载包时删除对应的脚本，可以添加preuninstall脚本，逻辑和添加脚本类似，只是删除对应的脚本字段。不过多数包不会这么做，用户可以手动清理。
• 权限问题：部分环境下修改项目根目录的package.json可能需要权限，本地开发环境一般不会有问题。

内容的提问来源于stack exchange，提问作者dewns47