如何自定义Node.js依赖库并将其正确引入到项目中

方案合理性判断 #

这是完全符合Node.js工程规范的合理实践，对比直接把原库源码迁入项目修改的方式，有几个明确优势：

• 不会让主项目仓库冗余体积过大的第三方库源码，仓库体积可控
• 自定义修改的逻辑可以独立做版本管控，后续原库升级、自定义逻辑迭代都不会互相冲突
• 自定义的包可以在多个项目间复用，不需要重复修改逻辑

具体配置引用方法 #

下面是三种不同场景下的常用实现方案：

方案1：本地私有包引用（仅当前项目使用，无需发布） #

适合只需要在当前项目用到修改逻辑的场景：

1. 单独创建自定义包目录，比如命名为custom-[原库名]，在目录下执行npm init -y完成npm初始化
2. 在自定义包目录下安装原库作为依赖：npm install [原库名]，之后在包内添加你修改的脚本逻辑，修改package.json的main字段为你的自定义入口文件，对外暴露修改后的能力
3. 回到主项目根目录，执行npm install [本地绝对/相对路径到custom-[原库名]目录]，npm会自动创建软链接关联你的自定义包
4. 主项目内直接像引入普通npm包一样使用即可：import xxx from 'custom-[原库名]'

小提示：如果需要自定义包修改后实时同步到主项目，可以在自定义包目录执行npm link，然后在主项目执行npm link custom-[原库名]，不需要每次修改后重新安装。

方案2：patch补丁方案（仅对原库做少量修改） #

如果你的修改量很小，不需要单独维护一个自定义包，可以用更轻量的补丁方案：

1. 主项目正常安装原库：npm install [原库名]
2. 直接修改node_modules里对应原库的代码，修改完成后执行npx patch-package [原库名]，工具会自动在主项目根目录生成patches目录，存放你修改的差异补丁文件
3. 在主项目package.json的scripts字段新增配置："postinstall": "patch-package"，之后每次执行npm install的时候都会自动应用你打的补丁，不需要重复修改node_modules里的代码

方案3：发布私有包（多项目复用修改逻辑） #

如果你的自定义修改逻辑需要在多个项目中复用，可以把自定义包发布到私有npm源：

1. 完成自定义包的开发后，推送到公司内部私有npm源或者个人私有npm仓库
2. 主项目配置好对应的私有源地址后，直接执行npm install [你的自定义包包名]即可正常引入使用

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